NodeProxy

Provides a proxy object to the node in the node hierarchy.

Objects of this type should only be created with the sap.ui.vk.NodeHierarchy.createNodeProxy method. and destroyed with the sap.ui.vk.NodeHierarchy.destroyNodeProxy method.

Experimental API:Since 1.32.0 This class is experimental and might be modified or removed in future versions.

Constructor Summary

new sap.ui.vk.NodeProxy(nodeHierarchy, nodeId)Constructor for a new NodeProxy.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.ui.vk.NodeProxy.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vk.NodeProxy with name sClassName and enriches it with the information contained in oClassInfo.

sap.ui.vk.NodeProxy.getMetadata()Returns a metadata object for class sap.ui.vk.NodeProxy.

bindLocalMatrix(oBindingInfo)Binds property localMatrix to model data.

bindOpacity(oBindingInfo)Binds property opacity to model data.

bindTintColorABGR(oBindingInfo)Binds property tintColorABGR to model data.

bindWorldMatrix(oBindingInfo)Binds property worldMatrix to model data.

getClosed()Gets current value of property closed.

getHasChildren()Gets current value of property hasChildren.

getLocalMatrix()Gets current value of property localMatrix.

getName()Gets current value of property name.

getNodeId()Gets current value of property nodeId.

getNodeMetadata()Gets current value of property nodeMetadata.

getOpacity()Gets current value of property opacity.

getTintColorABGR()Gets current value of property tintColorABGR.

getVeIds()Gets current value of property veIds.

getWorldMatrix()Gets current value of property worldMatrix.

setClosed(bClosed)Sets a new value for property closed.

setHasChildren(bHasChildren)Sets a new value for property hasChildren.

setLocalMatrix(sLocalMatrix)Sets a new value for property localMatrix.

setName(sName)Sets a new value for property name.

setNodeId(sNodeId)Sets a new value for property nodeId.

setNodeMetadata(oNodeMetadata)Sets a new value for property nodeMetadata.

setOpacity(fOpacity)Sets a new value for property opacity.

setTintColorABGR(iTintColorABGR)Sets a new value for property tintColorABGR.

setVeIds(sVeIds)Sets a new value for property veIds.

setWorldMatrix(sWorldMatrix)Sets a new value for property worldMatrix.

unbindLocalMatrix()Unbinds property localMatrix from model data.

unbindOpacity()Unbinds property opacity from model data.

unbindTintColorABGR()Unbinds property tintColorABGR from model data.

unbindWorldMatrix()Unbinds property worldMatrix from model data.

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, clone, destroy, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getMetadata, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, toString, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, fireEvent, hasListeners

Methods borrowed from class sap.ui.base.Object

getInterface

Constructor Detail

new sap.ui.vk.NodeProxy(nodeHierarchy, nodeId)

Constructor for a new NodeProxy.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

Properties
- nodeId : string
- veIds : object[]
- name : string
- localMatrix : sap.ui.vk.TransformationMatrix
- worldMatrix : sap.ui.vk.TransformationMatrix
- opacity : float
- tintColorABGR : int
- nodeMetadata : object
- hasChildren : boolean
- closed : boolean

In addition, all settings applicable to the base type sap.ui.base.ManagedObject can be used as well.

Parameters:

{sap.ui.vk.NodeHierarchy}	nodeHierarchy	The node hierarchy the node belongs to.
{string}	nodeId	The node ID.

Method Detail

sap.ui.vk.NodeProxy.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.vk.NodeProxy 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.base.ManagedObject.extend.

Parameters:

{string}	sClassName	Name of the class being created
{object}	oClassInfo?	Object literal with information about the class
{function}	FNMetaImpl?	Constructor function for the metadata object; if not given, it defaults to `sap.ui.core.ElementMetadata`

Returns:

{function}

Created class / constructor function

sap.ui.vk.NodeProxy.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.ui.vk.NodeProxy.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

bindLocalMatrix(oBindingInfo): sap.ui.vk.NodeProxy

Binds property localMatrix to model data.

See ManagedObject.bindProperty for a detailed description of the possible properties of oBindingInfo

Parameters:

{object}

oBindingInfo

The binding information

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

bindOpacity(oBindingInfo): sap.ui.vk.NodeProxy

Binds property opacity to model data.

See ManagedObject.bindProperty for a detailed description of the possible properties of oBindingInfo

Parameters:

{object}

oBindingInfo

The binding information

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

bindTintColorABGR(oBindingInfo): sap.ui.vk.NodeProxy

Binds property tintColorABGR to model data.

See ManagedObject.bindProperty for a detailed description of the possible properties of oBindingInfo

Parameters:

{object}

oBindingInfo

The binding information

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

bindWorldMatrix(oBindingInfo): sap.ui.vk.NodeProxy

Binds property worldMatrix to model data.

See ManagedObject.bindProperty for a detailed description of the possible properties of oBindingInfo

Parameters:

{object}

oBindingInfo

The binding information

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

getClosed(): boolean

Gets current value of property closed.

The indicator showing if the node is closed. This property is read-only.

Returns:

{boolean} Value of property closed

getHasChildren(): boolean

Gets current value of property hasChildren.

The indicator showing if the node has child nodes. This property is read-only.

Returns:

{boolean} Value of property hasChildren

getLocalMatrix(): sap.ui.vk.TransformationMatrix

Gets current value of property localMatrix.

The local transformation matrix of the node.

Returns:

{sap.ui.vk.TransformationMatrix} Value of property localMatrix

getName(): string

Gets current value of property name.

The name of the node. This property is read-only.

Returns:

{string} Value of property name

getNodeId(): string

Gets current value of property nodeId.

The node ID. This property is read-only.

Returns:

{string} Value of property nodeId

getNodeMetadata(): object

Gets current value of property nodeMetadata.

The node metadata. This property is read-only.

Returns:

{object} Value of property nodeMetadata

getOpacity(): float

Gets current value of property opacity.

The node opacity.

Returns:

{float} Value of property opacity

getTintColorABGR(): int

Gets current value of property tintColorABGR.

The tint color.

The tint color is a 32-bit integer in the ABGR notation, where A is amount of blending between material color and tint color.

Returns:

{int} Value of property tintColorABGR

getVeIds(): object[]

Gets current value of property veIds.

The node VE IDs. This property is read-only.

Returns:

{object[]} Value of property veIds

getWorldMatrix(): sap.ui.vk.TransformationMatrix

Gets current value of property worldMatrix.

The world transformation matrix of the node.

Returns:

{sap.ui.vk.TransformationMatrix} Value of property worldMatrix

setClosed(bClosed): sap.ui.vk.NodeProxy

Sets a new value for property closed.

The indicator showing if the node is closed. This property is read-only.

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

Parameters:

{boolean} bClosed New value for property closed

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

setHasChildren(bHasChildren): sap.ui.vk.NodeProxy

Sets a new value for property hasChildren.

The indicator showing if the node has child nodes. This property is read-only.

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

Parameters:

{boolean} bHasChildren New value for property hasChildren

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

setLocalMatrix(sLocalMatrix): sap.ui.vk.NodeProxy

Sets a new value for property localMatrix.

The local transformation matrix of the node.

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

Parameters:

{sap.ui.vk.TransformationMatrix} sLocalMatrix New value for property localMatrix

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

setName(sName): sap.ui.vk.NodeProxy

Sets a new value for property name.

The name of the node. This property is read-only.

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

Parameters:

{string} sName New value for property name

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

setNodeId(sNodeId): sap.ui.vk.NodeProxy

Sets a new value for property nodeId.

The node ID. This property is read-only.

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

Parameters:

{string} sNodeId New value for property nodeId

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

setNodeMetadata(oNodeMetadata): sap.ui.vk.NodeProxy

Sets a new value for property nodeMetadata.

The node metadata. This property is read-only.

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

Parameters:

{object} oNodeMetadata New value for property nodeMetadata

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

setOpacity(fOpacity): sap.ui.vk.NodeProxy

Sets a new value for property opacity.

The node opacity.

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

Parameters:

{float} fOpacity New value for property opacity

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

setTintColorABGR(iTintColorABGR): sap.ui.vk.NodeProxy

Sets a new value for property tintColorABGR.

The tint color.

The tint color is a 32-bit integer in the ABGR notation, where A is amount of blending between material color and tint color.

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

Parameters:

{int} iTintColorABGR New value for property tintColorABGR

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

setVeIds(sVeIds): sap.ui.vk.NodeProxy

Sets a new value for property veIds.

The node VE IDs. This property is read-only.

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

Parameters:

{object[]} sVeIds New value for property veIds

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

setWorldMatrix(sWorldMatrix): sap.ui.vk.NodeProxy

Sets a new value for property worldMatrix.

The world transformation matrix of the node.

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

Parameters:

{sap.ui.vk.TransformationMatrix} sWorldMatrix New value for property worldMatrix

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

unbindLocalMatrix(): sap.ui.vk.NodeProxy

Unbinds property localMatrix from model data.

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

unbindOpacity(): sap.ui.vk.NodeProxy

Unbinds property opacity from model data.

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

unbindTintColorABGR(): sap.ui.vk.NodeProxy

Unbinds property tintColorABGR from model data.

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining

unbindWorldMatrix(): sap.ui.vk.NodeProxy

Unbinds property worldMatrix from model data.

Returns:

{sap.ui.vk.NodeProxy} Reference to this in order to allow method chaining