class sap.ui.vk.tools.DuplicateSvgHotspotTool

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vk/tools/DuplicateSvgHotspotTool
Application Component: CA-UI5-VTK

The DuplicateSvgHotspotTool allows applications to duplicate svg hotspots.


Constructor

Constructor for a new DuplicateSvgHotspotTool.

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.DuplicateSvgHotspotTool(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID of the new tool instance. sIdis generated automatically if no non-empty ID is given. Note: this can be omitted, regardless of whether mSettings will be provided or not.

mSettings? object

An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance.


Properties

Name Type Default Value Description
nodeList any[]

Defines a list of nodes to be duplicated.

Visibility: public
parentNode any

Parent node for new elements.

Visibility: public

Borrowed Properties

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

Borrowed Aggregations

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


Events Overview

Event Description
nodesCreated

Fired when the duplicated nodes are created.

nodesCreated

Fired when the duplicated nodes are created.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
x float

Offset in x direction

y float

Offset in y direction

nodes any[]

Created nodes.

request object

Request payload for a storage server to create a parametric primitive.


Methods Overview

Method Description
attachNodesCreated

Attaches event handler fnFunction to the nodesCreated event of this sap.ui.vk.tools.DuplicateSvgHotspotTool.

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.DuplicateSvgHotspotTool itself.

Fired when the duplicated nodes are created.

detachNodesCreated

Detaches event handler fnFunction from the nodesCreated event of this sap.ui.vk.tools.DuplicateSvgHotspotTool.

The passed function and listener object must match the ones used for event registration.

sap.ui.vk.tools.DuplicateSvgHotspotTool.extend

Creates a new subclass of class sap.ui.vk.tools.DuplicateSvgHotspotTool 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.

fireNodesCreated

Fires event nodesCreated to attached listeners.

sap.ui.vk.tools.DuplicateSvgHotspotTool.getMetadata

Returns a metadata object for class sap.ui.vk.tools.DuplicateSvgHotspotTool.

getNodeList

Gets current value of property nodeList.

Defines a list of nodes to be duplicated.

Default value is [].

getParentNode

Gets current value of property parentNode.

Parent node for new elements.

queueCommand

MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should be called using this method.

setNodeList

Sets a new value for property nodeList.

Defines a list of nodes to be duplicated.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is [].

setParentNode

Sets a new value for property parentNode.

Parent node for new elements.

When called with a value of null or undefined, the default value of the property will be restored.

attachNodesCreated

Attaches event handler fnFunction to the nodesCreated event of this sap.ui.vk.tools.DuplicateSvgHotspotTool.

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.DuplicateSvgHotspotTool itself.

Fired when the duplicated nodes are 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 sap.ui.vk.tools.DuplicateSvgHotspotTool itself

detachNodesCreated

Detaches event handler fnFunction from the nodesCreated event of this sap.ui.vk.tools.DuplicateSvgHotspotTool.

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

sap.ui.vk.tools.DuplicateSvgHotspotTool.extend

Creates a new subclass of class sap.ui.vk.tools.DuplicateSvgHotspotTool 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

fireNodesCreated

Fires event nodesCreated to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

x float

Offset in x direction

y float

Offset in y direction

nodes any[]

Created nodes.

request object

Request payload for a storage server to create a parametric primitive.

sap.ui.vk.tools.DuplicateSvgHotspotTool.getMetadata

Returns a metadata object for class sap.ui.vk.tools.DuplicateSvgHotspotTool.

getNodeList

Gets current value of property nodeList.

Defines a list of nodes to be duplicated.

Default value is [].

getParentNode

Gets current value of property parentNode.

Parent node for new elements.

queueCommand

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.

setNodeList

Sets a new value for property nodeList.

Defines a list of nodes to be duplicated.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is [].

Param Type DefaultValue Description
sNodeList any[] []

New value for property nodeList

setParentNode

Sets a new value for property parentNode.

Parent node for new elements.

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 parentNode