The TransformSvgElementTool allows applications to transform an svg element.
Constructor for a new TransformSvgElementTool.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.ui.vk.tools.TransformSvgElementTool(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID of the new tool instance. |
|
mSettings? | object | An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. |
Name | Type | Default Value | Description |
---|---|---|---|
nodeSet | sap.ui.vk.tools.ToolNodeSet | Highlight | Determine what set of nodes will be transformed with this tool Visibility: public |
uniformScaleEnabled | boolean | false | If set to |
Name | Type | Default Value | Description |
---|---|---|---|
active | boolean | false | Used to control the tool rendering and interaction pipeline. Visibility: public |
footprint | string[] | Used to decide whether this tool should be enabled for the target viewport. Visibility: public |
|
targetViewportType | any | Visibility: public | |
toolid | string | GUID identifier for the tool to prevent naming conflicts. Visibility: public |
Name | Cardinality | Type | Description |
---|---|---|---|
gizmo | 0..1 | sap.ui.vk.tools.Gizmo |
sap.ui.vk.tools.Gizmo owned by this control and used for rendering floating UI |
Event | Description |
---|---|
moved |
This event will be fired when movement finished. |
moving |
This event will be fired when movement occurs. |
rotated |
This event will be fired when rotation finished. |
rotating |
This event will be fired when rotation occurs. |
scaled |
This event will be fired when scaling finished. |
scaling |
This event will be fired when scaling occurs. |
This event will be fired when movement finished.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
x | float | |
y | float | |
nodesProperties | any[] |
Array of affected nodes properties. Each object contains following properties: {any} node - node reference {float} x - offset in x direction {float} y - offset in y direction |
This event will be fired when movement occurs.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
x | float | |
y | float | |
nodesProperties | any[] |
Array of affected nodes properties. Each object contains following properties: {any} node - node reference {float} x - offset in x direction {float} y - offset in y direction |
This event will be fired when rotation finished.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
angle | float | |
nodesProperties | any[] |
Array of affected nodes properties. Each object contains following properties: {any} node - node reference {float} angle - angle of rotation |
This event will be fired when rotation occurs.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
angle | float | |
nodesProperties | any[] |
Array of affected nodes properties. Each object contains following properties: {any} node - node reference {float} angle - angle of rotation |
This event will be fired when scaling finished.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
x | float | |
y | float | |
nodesProperties | any[] |
Array of affected nodes properties. Each object contains following properties: {any} node - node reference {float} x - scale in x direction {float} y - scale in y direction |
This event will be fired when scaling occurs.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
x | float | |
y | float | |
nodesProperties | any[] |
Array of affected nodes properties. Each object contains following properties: {any} node - node reference {float} x - scale in x direction {float} y - scale in y direction |
Method | Description |
---|---|
attachMoved |
Attaches event handler When called, the context of the event handler (its This event will be fired when movement finished. |
attachMoving |
Attaches event handler When called, the context of the event handler (its This event will be fired when movement occurs. |
attachRotated |
Attaches event handler When called, the context of the event handler (its This event will be fired when rotation finished. |
attachRotating |
Attaches event handler When called, the context of the event handler (its This event will be fired when rotation occurs. |
attachScaled |
Attaches event handler When called, the context of the event handler (its This event will be fired when scaling finished. |
attachScaling |
Attaches event handler When called, the context of the event handler (its This event will be fired when scaling occurs. |
detachMoved |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachMoving |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachRotated |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachRotating |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachScaled |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachScaling |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.vk.tools.TransformSvgElementTool.extend |
Creates a new subclass of class sap.ui.vk.tools.TransformSvgElementTool with name
|
fireMoved |
Fires event moved to attached listeners. |
fireMoving |
Fires event moving to attached listeners. |
fireRotated |
Fires event rotated to attached listeners. |
fireRotating |
Fires event rotating to attached listeners. |
fireScaled |
Fires event scaled to attached listeners. |
fireScaling |
Fires event scaling to attached listeners. |
sap.ui.vk.tools.TransformSvgElementTool.getMetadata |
Returns a metadata object for class sap.ui.vk.tools.TransformSvgElementTool. |
getNodeSet |
Gets current value of property nodeSet. Determine what set of nodes will be transformed with this tool Default value is |
getUniformScaleEnabled |
Gets current value of property uniformScaleEnabled. If set to Default value is |
queueCommand |
MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should be called using this method. |
setNodeSet |
Sets a new value for property nodeSet. Determine what set of nodes will be transformed with this tool When called with a value of Default value is |
setUniformScaleEnabled |
Sets a new value for property uniformScaleEnabled. If set to When called with a value of Default value is |
Attaches event handler fnFunction
to the moved event of this sap.ui.vk.tools.TransformSvgElementTool
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vk.tools.TransformSvgElementTool
itself.
This event will be fired when movement finished.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the moving event of this sap.ui.vk.tools.TransformSvgElementTool
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vk.tools.TransformSvgElementTool
itself.
This event will be fired when movement occurs.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the rotated event of this sap.ui.vk.tools.TransformSvgElementTool
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vk.tools.TransformSvgElementTool
itself.
This event will be fired when rotation finished.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the rotating event of this sap.ui.vk.tools.TransformSvgElementTool
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vk.tools.TransformSvgElementTool
itself.
This event will be fired when rotation occurs.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the scaled event of this sap.ui.vk.tools.TransformSvgElementTool
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vk.tools.TransformSvgElementTool
itself.
This event will be fired when scaling finished.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the scaling event of this sap.ui.vk.tools.TransformSvgElementTool
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vk.tools.TransformSvgElementTool
itself.
This event will be fired when scaling occurs.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Detaches event handler fnFunction
from the moved event of this sap.ui.vk.tools.TransformSvgElementTool
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the moving event of this sap.ui.vk.tools.TransformSvgElementTool
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the rotated event of this sap.ui.vk.tools.TransformSvgElementTool
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the rotating event of this sap.ui.vk.tools.TransformSvgElementTool
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the scaled event of this sap.ui.vk.tools.TransformSvgElementTool
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the scaling event of this sap.ui.vk.tools.TransformSvgElementTool
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Creates a new subclass of class sap.ui.vk.tools.TransformSvgElementTool with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.ui.vk.tools.Tool.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Fires event moved to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
x | float | ||
y | float | ||
nodesProperties | any[] |
Array of affected nodes properties. Each object contains following properties: {any} node - node reference {float} x - offset in x direction {float} y - offset in y direction |
Fires event moving to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
x | float | ||
y | float | ||
nodesProperties | any[] |
Array of affected nodes properties. Each object contains following properties: {any} node - node reference {float} x - offset in x direction {float} y - offset in y direction |
Fires event rotated to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
angle | float | ||
nodesProperties | any[] |
Array of affected nodes properties. Each object contains following properties: {any} node - node reference {float} angle - angle of rotation |
Fires event rotating to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
angle | float | ||
nodesProperties | any[] |
Array of affected nodes properties. Each object contains following properties: {any} node - node reference {float} angle - angle of rotation |
Fires event scaled to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
x | float | ||
y | float | ||
nodesProperties | any[] |
Array of affected nodes properties. Each object contains following properties: {any} node - node reference {float} x - scale in x direction {float} y - scale in y direction |
Fires event scaling to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
x | float | ||
y | float | ||
nodesProperties | any[] |
Array of affected nodes properties. Each object contains following properties: {any} node - node reference {float} x - scale in x direction {float} y - scale in y direction |
Returns a metadata object for class sap.ui.vk.tools.TransformSvgElementTool.
Gets current value of property nodeSet.
Determine what set of nodes will be transformed with this tool
Default value is Highlight
.
Gets current value of property uniformScaleEnabled.
If set to true
then this tool will enable uniform scaling.
Default value is false
.
MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should be called using this method.
Param | Type | DefaultValue | Description |
---|---|---|---|
command | function |
The command to be executed. |
Sets a new value for property nodeSet.
Determine what set of nodes will be transformed with this tool
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Highlight
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sNodeSet | sap.ui.vk.tools.ToolNodeSet | Highlight |
New value for property |
Sets a new value for property uniformScaleEnabled.
If set to true
then this tool will enable uniform scaling.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bUniformScaleEnabled | boolean | false |
New value for property |