The CreateRectangleTool allows applications to create a rectangle/square svg element.
Constructor for a new CreateRectangleTool.
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.CreateRectangleTool(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 |
---|---|---|---|
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 |
Fired when a new element is created.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
node | any |
Created node. node.sid - node's sid node.nodeContentType - node content type node.materialId - assigned material sid node.name - node's name node.matrix - node transformation matrix node.parametric - index of created parametric object in parametrics array |
request | any |
Request payload for a storage server to create a parametric primitive. |
Method | Description |
---|---|
attachCompleted |
Attaches event handler When called, the context of the event handler (its Fired when a new element is created. |
detachCompleted |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.vk.tools.CreateRectangleTool.extend |
Creates a new subclass of class sap.ui.vk.tools.CreateRectangleTool with name
|
fireCompleted |
Fires event completed to attached listeners. |
sap.ui.vk.tools.CreateRectangleTool.getMetadata |
Returns a metadata object for class sap.ui.vk.tools.CreateRectangleTool. |
getParentNode |
Gets current value of property parentNode. Parent node for the rectangle that will be created. |
getUniformMode |
Gets current value of property uniformMode. Indicates that the tool creates a square instead of a rectangle. 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. |
setParentNode |
Sets a new value for property parentNode. Parent node for the rectangle that will be created. When called with a value of |
setUniformMode |
Sets a new value for property uniformMode. Indicates that the tool creates a square instead of a rectangle. When called with a value of Default value is |
Attaches event handler fnFunction
to the completed event of this sap.ui.vk.tools.CreateRectangleTool
.
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.CreateRectangleTool
itself.
Fired when a new element is created.
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 completed event of this sap.ui.vk.tools.CreateRectangleTool
.
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.CreateRectangleTool 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 completed to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
node | any |
Created node. node.sid - node's sid node.nodeContentType - node content type node.materialId - assigned material sid node.name - node's name node.matrix - node transformation matrix node.parametric - index of created parametric object in parametrics array |
|
request | any |
Request payload for a storage server to create a parametric primitive. |
Returns a metadata object for class sap.ui.vk.tools.CreateRectangleTool.
Gets current value of property parentNode.
Parent node for the rectangle that will be created.
Gets current value of property uniformMode.
Indicates that the tool creates a square instead of a rectangle.
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 parentNode.
Parent node for the rectangle that will be created.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oParentNode | any |
New value for property |
Sets a new value for property uniformMode.
Indicates that the tool creates a square instead of a rectangle.
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 |
---|---|---|---|
bUniformMode | boolean | false |
New value for property |