Class sap.ui.vk.LayerProxyModule: sap/ui/vk/LayerProxy

extends ManagedObject

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

Layer is a list of nodes. One node hierarchy can have multiple layers. One node can be included in multiple layers.

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

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

Constructor Summary
new sap.ui.vk.LayerProxy(nodeHierarchy, layerId)Constructor for a new LayerProxy.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.vk.LayerProxy.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vk.LayerProxy with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vk.LayerProxy.getMetadata()Returns a metadata object for class sap.ui.vk.LayerProxy.
getDescription()Gets current value of property description.
getLayerId()Gets current value of property layerId.
getLayerMetadata()Gets current value of property layerMetadata.
getName()Gets current value of property name.
getVeIds()Gets current value of property veIds.
setDescription(sDescription)Sets a new value for property description.
setLayerId(sLayerId)Sets a new value for property layerId.
setLayerMetadata(oLayerMetadata)Sets a new value for property layerMetadata.
setName(sName)Sets a new value for property name.
setVeIds(sVeIds)Sets a new value for property veIds.
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.LayerProxy(nodeHierarchy, layerId)
Constructor for a new LayerProxy.

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:

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 layer belongs to.
{string}layerId The layer ID.
Method Detail
sap.ui.vk.LayerProxy.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vk.LayerProxy 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.LayerProxy.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vk.LayerProxy.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getDescription(): string
Gets current value of property description.

The description of the layer. This property is read-only.

Returns:
{string} Value of property description
getLayerId(): string
Gets current value of property layerId.

The layer ID. This property is read-only.

Returns:
{string} Value of property layerId
getLayerMetadata(): object
Gets current value of property layerMetadata.

The node metadata. This property is read-only.

Returns:
{object} Value of property layerMetadata
getName(): string
Gets current value of property name.

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

Returns:
{string} Value of property name
getVeIds(): object[]
Gets current value of property veIds.

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

Returns:
{object[]} Value of property veIds
setDescription(sDescription): sap.ui.vk.LayerProxy
Sets a new value for property description.

The description of the layer. 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}sDescription New value for property description
Returns:
{sap.ui.vk.LayerProxy} Reference to this in order to allow method chaining
setLayerId(sLayerId): sap.ui.vk.LayerProxy
Sets a new value for property layerId.

The layer 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}sLayerId New value for property layerId
Returns:
{sap.ui.vk.LayerProxy} Reference to this in order to allow method chaining
setLayerMetadata(oLayerMetadata): sap.ui.vk.LayerProxy
Sets a new value for property layerMetadata.

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}oLayerMetadata New value for property layerMetadata
Returns:
{sap.ui.vk.LayerProxy} Reference to this in order to allow method chaining
setName(sName): sap.ui.vk.LayerProxy
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.LayerProxy} Reference to this in order to allow method chaining
setVeIds(sVeIds): sap.ui.vk.LayerProxy
Sets a new value for property veIds.

The layer 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.LayerProxy} Reference to this in order to allow method chaining