Manages the visibility and selection states of nodes in the scene.
Constructor for a new ViewStateManagerBase.
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.ViewStateManagerBase(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new ViewStateManagerBase object. Generated automatically if no ID is given. |
|
mSettings? | object | Initial settings for the new ViewStateManagerBase object. |
Name | Cardinality | Type | Description |
---|---|---|---|
contentConnector | 0..1 | sap.ui.vk.ContentConnector | |
viewManager | 0..1 | sap.ui.vk.ViewManager |
Event | Description |
---|---|
highlightColorChanged |
This event is fired when highlighting color is changed. This event bubbles up the control hierarchy. |
nodeHierarchyReplaced |
This event is fired when the node hierarchy is replaced. |
opacityChanged |
This event is fired when opacity of the nodes is changed. This event bubbles up the control hierarchy. |
outlineColorChanged |
This event is fired when outlining color is changed. This event bubbles up the control hierarchy. |
outlineWidthChanged |
This event is fired when outline width is changed. This event bubbles up the control hierarchy. |
outliningChanged |
This event is fired when the nodes are outlined/unoutlined. This event bubbles up the control hierarchy. |
readyForAnimation |
This event is fired when viewport is ready for playing animation (e.g, camera is ready). |
selectionChanged |
This event is fired when the nodes are selected/unselected. This event bubbles up the control hierarchy. |
tintColorChanged |
This event is fired when tint color of the nodes is changed. This event bubbles up the control hierarchy. |
transformationChanged |
This event is fired when node's transformation changed. |
viewStateApplied |
This event is fired when View activated. |
viewStateApplying |
This event is fired when View is about to be activated. |
visibilityChanged |
This event is fired when the visibility of the node changes. This event bubbles up the control hierarchy. |
This event is fired when highlighting color is changed.
This event bubbles up the control hierarchy.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
highlightColor | sap.ui.core.CSSColor |
Highlighting color |
highlightColorABGR | int |
Highlighting color in the ABGR format. |
This event is fired when the node hierarchy is replaced.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
oldNodeHierarchy | sap.ui.vk.NodeHierarchy |
Old node hierarchy |
newNodeHierarchy | sap.ui.vk.NodeHierarchy |
New node hierarchy |
This event is fired when opacity of the nodes is changed.
This event bubbles up the control hierarchy.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
changed | any[] |
References of nodes whose opacity changed. |
opacity | any |
Opacity assigned to the nodes. Could be either |
This event is fired when outlining color is changed.
This event bubbles up the control hierarchy.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
outlineColor | sap.ui.core.CSSColor |
Outlining color |
outlineColorABGR | int |
Outlining color in the ABGR format. |
This event is fired when outline width is changed.
This event bubbles up the control hierarchy.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
width | float |
Outline width |
This event is fired when the nodes are outlined/unoutlined.
This event bubbles up the control hierarchy.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
outlined | any[] |
References of newly outlined nodes. |
unoutlined | any[] |
References of newly unoutlined nodes. |
This event is fired when viewport is ready for playing animation (e.g, camera is ready).
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
view | sap.ui.vk.View |
This event is fired when the nodes are selected/unselected.
This event bubbles up the control hierarchy.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
selected | any[] |
References of newly selected nodes. |
unselected | any[] |
References of newly unselected nodes. |
This event is fired when tint color of the nodes is changed.
This event bubbles up the control hierarchy.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
changed | any[] |
References of nodes whose tint color changed. |
tintColor | any |
Tint color assigned to the nodes. Could be either |
tintColorABGR | any |
Tint color in the ABGR format assigned to the nodes. Could be either |
This event is fired when node's transformation changed.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
changed | any |
Reference to a changed node or array of node references. |
transformation | any |
Node's transformation or array of nodes' transforms Transformation object will contain the following fields of type |
This event is fired when View activated.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
view | sap.ui.vk.View |
This event is fired when View is about to be activated.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
view | sap.ui.vk.View |
This event is fired when the visibility of the node changes.
This event bubbles up the control hierarchy.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
visible | any[] |
References of newly shown nodes. |
hidden | any[] |
IDs of newly hidden nodes. |
Method | Description |
---|---|
_setContent |
Sets a scene obtained as content from the associated content connector. This method should be overridden in derived classes. |
attachHighlightColorChanged |
Attaches event handler When called, the context of the event handler (its This event is fired when highlighting color is changed. |
attachNodeHierarchyReplaced |
Attaches event handler When called, the context of the event handler (its This event is fired when the node hierarchy is replaced. |
attachOpacityChanged |
Attaches event handler When called, the context of the event handler (its This event is fired when opacity of the nodes is changed. |
attachOutlineColorChanged |
Attaches event handler When called, the context of the event handler (its This event is fired when outlining color is changed. |
attachOutlineWidthChanged |
Attaches event handler When called, the context of the event handler (its This event is fired when outline width is changed. |
attachOutliningChanged |
Attaches event handler When called, the context of the event handler (its This event is fired when the nodes are outlined/unoutlined. |
attachReadyForAnimation |
Attaches event handler When called, the context of the event handler (its This event is fired when viewport is ready for playing animation (e.g, camera is ready). |
attachSelectionChanged |
Attaches event handler When called, the context of the event handler (its This event is fired when the nodes are selected/unselected. |
attachTintColorChanged |
Attaches event handler When called, the context of the event handler (its This event is fired when tint color of the nodes is changed. |
attachTransformationChanged |
Attaches event handler When called, the context of the event handler (its This event is fired when node's transformation changed. |
attachViewStateApplied |
Attaches event handler When called, the context of the event handler (its This event is fired when View activated. |
attachViewStateApplying |
Attaches event handler When called, the context of the event handler (its This event is fired when View is about to be activated. |
attachVisibilityChanged |
Attaches event handler When called, the context of the event handler (its This event is fired when the visibility of the node changes. |
detachHighlightColorChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachNodeHierarchyReplaced |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachOpacityChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachOutlineColorChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachOutlineWidthChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachOutliningChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachReadyForAnimation |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachSelectionChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachTintColorChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachTransformationChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachViewStateApplied |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachViewStateApplying |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachVisibilityChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
enumerateOutlinedNodes |
Enumerates IDs of the outlined nodes. |
enumerateSelection |
Enumerates IDs of the selected nodes. |
sap.ui.vk.ViewStateManagerBase.extend |
Creates a new subclass of class sap.ui.vk.ViewStateManagerBase with name
|
fireHighlightColorChanged |
Fires event highlightColorChanged to attached listeners. |
fireNodeHierarchyReplaced |
Fires event nodeHierarchyReplaced to attached listeners. |
fireOpacityChanged |
Fires event opacityChanged to attached listeners. |
fireOutlineColorChanged |
Fires event outlineColorChanged to attached listeners. |
fireOutlineWidthChanged |
Fires event outlineWidthChanged to attached listeners. |
fireOutliningChanged |
Fires event outliningChanged to attached listeners. |
fireReadyForAnimation |
Fires event readyForAnimation to attached listeners. |
fireSelectionChanged |
Fires event selectionChanged to attached listeners. |
fireTintColorChanged |
Fires event tintColorChanged to attached listeners. |
fireTransformationChanged |
Fires event transformationChanged to attached listeners. |
fireViewStateApplied |
Fires event viewStateApplied to attached listeners. |
fireViewStateApplying |
Fires event viewStateApplying to attached listeners. |
fireVisibilityChanged |
Fires event visibilityChanged to attached listeners. |
getContentConnector |
ID of the element which is the current target of the association contentConnector, or |
sap.ui.vk.ViewStateManagerBase.getMetadata |
Returns a metadata object for class sap.ui.vk.ViewStateManagerBase. |
getNodeHierarchy |
Gets the NodeHierarchy object associated with this ViewStateManagerBase object. |
getOpacity |
Gets the opacity of the node. If a single node reference is passed to the method then a single value is returned. |
getOutlineColor |
Gets the outline color |
getOutlineWidth |
Gets the outline width |
getOutliningState |
Gets the outlining state of the node. If a single node reference is passed to the method then a single outlining state is returned. |
getRecursiveOutlining |
Gets current value of property recursiveOutlining. Default value is |
getRecursiveSelection |
Gets current value of property recursiveSelection. Default value is |
getRotation |
Gets the node transformation rotation component in specified format. |
getScale |
Gets the node transformation scale component. |
getSelectionState |
Gets the selection state of the node. If a single node reference is passed to the method then a single selection state is returned. |
getShouldTrackVisibilityChanges |
Gets current value of property shouldTrackVisibilityChanges. Default value is |
getTintColor |
Gets the tint color of the node. If a single node reference is passed to the method then a single value is returned. |
getTransformation |
Gets the decomposed node local transformation matrix. |
getTranslation |
Gets the node transformation translation component. |
getViewManager |
ID of the element which is the current target of the association viewManager, or |
getVisibilityChanges |
Gets the visibility changes in the current ViewStateManagerBase object. |
getVisibilityState |
Gets the visibility state of nodes. If a single node reference is passed to the method then a single visibility state is returned. |
resetVisibility |
Resets the visibility states of all nodes to the initial states. |
restoreRestTransformation |
Replace node's current transformation with its rest transformation stored in active view.. |
setContentConnector |
Sets the associated contentConnector. |
setHighlightDisplayState |
Set highlight display state. |
setOpacity |
Sets the opacity of the nodes. |
setOutlineColor |
Sets the outline color |
setOutlineWidth |
Sets the outline width |
setOutliningStates |
Sets or resets the outlining state of the nodes. |
setRecursiveOutlining |
Sets a new value for property recursiveOutlining. When called with a value of Default value is |
setRecursiveSelection |
Sets a new value for property recursiveSelection. When called with a value of Default value is |
setSelectionState |
Sets the selection state of the nodes. |
setSelectionStates |
Sets or resets the selection state of the nodes. |
setShouldTrackVisibilityChanges |
Sets a new value for property shouldTrackVisibilityChanges. When called with a value of Default value is |
setTintColor |
Sets the tint color of the nodes. |
setTransformation |
Sets the node transformation components. |
setViewManager |
Sets the associated viewManager. |
setVisibilityState |
Sets the visibility state of the nodes. |
updateRestTransformation |
Copy node's current transformation into its rest transformation stored in active view. |
Sets a scene obtained as content from the associated content connector.
This method should be overridden in derived classes.
Param | Type | DefaultValue | Description |
---|---|---|---|
content | sap.ui.vk.Scene |
New content or |
Attaches event handler fnFunction
to the highlightColorChanged event of this sap.ui.vk.ViewStateManagerBase
.
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.ViewStateManagerBase
itself.
This event is fired when highlighting color is changed.
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 nodeHierarchyReplaced event of this sap.ui.vk.ViewStateManagerBase
.
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.ViewStateManagerBase
itself.
This event is fired when the node hierarchy is replaced.
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 opacityChanged event of this sap.ui.vk.ViewStateManagerBase
.
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.ViewStateManagerBase
itself.
This event is fired when opacity of the nodes is changed.
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 outlineColorChanged event of this sap.ui.vk.ViewStateManagerBase
.
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.ViewStateManagerBase
itself.
This event is fired when outlining color is changed.
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 outlineWidthChanged event of this sap.ui.vk.ViewStateManagerBase
.
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.ViewStateManagerBase
itself.
This event is fired when outline width is changed.
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 outliningChanged event of this sap.ui.vk.ViewStateManagerBase
.
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.ViewStateManagerBase
itself.
This event is fired when the nodes are outlined/unoutlined.
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 readyForAnimation event of this sap.ui.vk.ViewStateManagerBase
.
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.ViewStateManagerBase
itself.
This event is fired when viewport is ready for playing animation (e.g, camera is ready).
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 selectionChanged event of this sap.ui.vk.ViewStateManagerBase
.
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.ViewStateManagerBase
itself.
This event is fired when the nodes are selected/unselected.
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 tintColorChanged event of this sap.ui.vk.ViewStateManagerBase
.
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.ViewStateManagerBase
itself.
This event is fired when tint color of the nodes is changed.
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 transformationChanged event of this sap.ui.vk.ViewStateManagerBase
.
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.ViewStateManagerBase
itself.
This event is fired when node's transformation changed.
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 viewStateApplied event of this sap.ui.vk.ViewStateManagerBase
.
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.ViewStateManagerBase
itself.
This event is fired when View activated.
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 viewStateApplying event of this sap.ui.vk.ViewStateManagerBase
.
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.ViewStateManagerBase
itself.
This event is fired when View is about to be activated.
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 visibilityChanged event of this sap.ui.vk.ViewStateManagerBase
.
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.ViewStateManagerBase
itself.
This event is fired when the visibility of the node changes.
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 highlightColorChanged event of this sap.ui.vk.ViewStateManagerBase
.
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 nodeHierarchyReplaced event of this sap.ui.vk.ViewStateManagerBase
.
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 opacityChanged event of this sap.ui.vk.ViewStateManagerBase
.
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 outlineColorChanged event of this sap.ui.vk.ViewStateManagerBase
.
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 outlineWidthChanged event of this sap.ui.vk.ViewStateManagerBase
.
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 outliningChanged event of this sap.ui.vk.ViewStateManagerBase
.
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 readyForAnimation event of this sap.ui.vk.ViewStateManagerBase
.
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 selectionChanged event of this sap.ui.vk.ViewStateManagerBase
.
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 tintColorChanged event of this sap.ui.vk.ViewStateManagerBase
.
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 transformationChanged event of this sap.ui.vk.ViewStateManagerBase
.
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 viewStateApplied event of this sap.ui.vk.ViewStateManagerBase
.
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 viewStateApplying event of this sap.ui.vk.ViewStateManagerBase
.
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 visibilityChanged event of this sap.ui.vk.ViewStateManagerBase
.
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 |
Enumerates IDs of the outlined nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
callback | function |
A function to call when the outlined nodes are enumerated. The function takes one parameter of type |
Enumerates IDs of the selected nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
callback | function |
A function to call when the selected nodes are enumerated. The function takes one parameter of type |
Creates a new subclass of class sap.ui.vk.ViewStateManagerBase 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.core.Element.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 highlightColorChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
highlightColor | sap.ui.core.CSSColor |
Highlighting color |
|
highlightColorABGR | int |
Highlighting color in the ABGR format. |
Fires event nodeHierarchyReplaced to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
oldNodeHierarchy | sap.ui.vk.NodeHierarchy |
Old node hierarchy |
|
newNodeHierarchy | sap.ui.vk.NodeHierarchy |
New node hierarchy |
Fires event opacityChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
changed | any[] |
References of nodes whose opacity changed. |
|
opacity | any |
Opacity assigned to the nodes. Could be either |
Fires event outlineColorChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
outlineColor | sap.ui.core.CSSColor |
Outlining color |
|
outlineColorABGR | int |
Outlining color in the ABGR format. |
Fires event outlineWidthChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
width | float |
Outline width |
Fires event outliningChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
outlined | any[] |
References of newly outlined nodes. |
|
unoutlined | any[] |
References of newly unoutlined nodes. |
Fires event readyForAnimation to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
view | sap.ui.vk.View |
Fires event selectionChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
selected | any[] |
References of newly selected nodes. |
|
unselected | any[] |
References of newly unselected nodes. |
Fires event tintColorChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
changed | any[] |
References of nodes whose tint color changed. |
|
tintColor | any |
Tint color assigned to the nodes. Could be either |
|
tintColorABGR | any |
Tint color in the ABGR format assigned to the nodes. Could be either |
Fires event transformationChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
changed | any |
Reference to a changed node or array of node references. |
|
transformation | any |
Node's transformation or array of nodes' transforms Transformation object will contain the following fields of type |
Fires event viewStateApplied to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
view | sap.ui.vk.View |
Fires event viewStateApplying to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
view | sap.ui.vk.View |
Fires event visibilityChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
visible | any[] |
References of newly shown nodes. |
|
hidden | any[] |
IDs of newly hidden nodes. |
ID of the element which is the current target of the association contentConnector, or null
.
Returns a metadata object for class sap.ui.vk.ViewStateManagerBase.
Gets the opacity of the node.
If a single node reference is passed to the method then a single value is returned.
If an array of node references is passed to the method then an array of values is returned.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
Gets the outline color
Param | Type | DefaultValue | Description |
---|---|---|---|
inABGRFormat | boolean | false |
This flag indicates to return the outline color in the ABGR format, if it equals |
Gets the outlining state of the node.
If a single node reference is passed to the method then a single outlining state is returned.
If an array of node references is passed to the method then an array of outlining states is returned.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
Gets the node transformation rotation component in specified format.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRef | any any[] |
The node reference or the array of node references. |
|
rotationType | sap.ui.vk.RotationType |
Rotation representation type. |
Gets the node transformation scale component.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRef | any any[] |
The node reference. |
Gets the selection state of the node.
If a single node reference is passed to the method then a single selection state is returned.
If an array of node references is passed to the method then an array of selection states is returned.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
Gets current value of property shouldTrackVisibilityChanges.
Default value is false
.
Gets the tint color of the node.
If a single node reference is passed to the method then a single value is returned.
If an array of node references is passed to the method then an array of values is returned.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
|
inABGRFormat | boolean | false |
This flag indicates to return the tint color in the ABGR format, if it equals |
Gets the decomposed node local transformation matrix.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRef | any any[] |
The node reference. |
Gets the node transformation translation component.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRef | any |
The node reference. |
ID of the element which is the current target of the association viewManager, or null
.
Gets the visibility state of nodes.
If a single node reference is passed to the method then a single visibility state is returned.
If an array of node references is passed to the method then an array of visibility states is returned.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
Replace node's current transformation with its rest transformation stored in active view..
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRef | any |
The node reference. |
Sets the associated contentConnector.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContentConnector | sap.ui.core.ID sap.ui.vk.ContentConnector |
ID of an element which becomes the new target of this contentConnector association; alternatively, an element instance may be given |
Set highlight display state.
Param | Type | DefaultValue | Description |
---|---|---|---|
state | sap.ui.vk.HighlightDisplayState |
for playing highlight - playing, pausing, and stopped |
Sets the opacity of the nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
|
opacity | float null |
The new opacity of the nodes. If |
|
recursive | boolean | false |
The flags indicates if the change needs to propagate recursively to child nodes. |
Sets the outline color
Param | Type | DefaultValue | Description |
---|---|---|---|
color | sap.ui.vk.CSSColor string int |
The new outline color. The value can be defined as a string in the CSS color format or as an integer in the ABGR format. If |
Sets the outline width
Param | Type | DefaultValue | Description |
---|---|---|---|
width | float |
width of outline |
Sets or resets the outlining state of the nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
outlinedNodeRefs | any any[] |
The node reference or the array of node references of outlined nodes. |
|
unoutlinedNodeRefs | any any[] |
The node reference or the array of node references of unoutlined nodes. |
|
recursive | boolean |
The flags indicates if the change needs to propagate recursively to child nodes. |
|
blockNotification | boolean |
The flag to suppress outlineChanged event. |
Sets a new value for property recursiveOutlining.
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 |
---|---|---|---|
bRecursiveOutlining | boolean | false |
New value for property |
Sets a new value for property recursiveSelection.
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 |
---|---|---|---|
bRecursiveSelection | boolean | false |
New value for property |
Sets the selection state of the nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
|
selected | boolean |
The new selection state of the nodes. |
|
recursive | boolean |
The flags indicates if the change needs to propagate recursively to child nodes. |
|
blockNotification | boolean |
The flag to suppress selectionChanged event. |
Sets or resets the selection state of the nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
selectedNodeRefs | any any[] |
The node reference or the array of node references of selected nodes. |
|
unselectedNodeRefs | any any[] |
The node reference or the array of node references of unselected nodes. |
|
recursive | boolean |
The flags indicates if the change needs to propagate recursively to child nodes. |
|
blockNotification | boolean |
The flag to suppress selectionChanged event. |
Sets a new value for property shouldTrackVisibilityChanges.
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 |
---|---|---|---|
bShouldTrackVisibilityChanges | boolean | false |
New value for property |
Sets the tint color of the nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
|
tintColor | sap.ui.vk.CSSColor int null |
The new tint color of the nodes. The value can be defined as a string in the CSS color format or as an integer in the ABGR format. If |
|
recursive | boolean | false |
This flag indicates if the change needs to propagate recursively to child nodes. |
Sets the node transformation components.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRef | any any[] |
The node reference. |
|
transformations | any any[] |
Node's transformation matrix or it components or array of such. Each object should contain one transform matrix or exactly one of angleAxis, euler or quaternion components. |
Sets the associated viewManager.
Param | Type | DefaultValue | Description |
---|---|---|---|
oViewManager | sap.ui.core.ID sap.ui.vk.ViewManager |
ID of an element which becomes the new target of this viewManager association; alternatively, an element instance may be given |
Sets the visibility state of the nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
|
visible | boolean |
The new visibility state of the nodes. |
|
recursive | boolean |
The flags indicates if the change needs to propagate recursively to child nodes. |
|
force | boolean |
If a node is made visible but its parent is hidden then it will still be hidden in Viewport. This flag will force node to be visible regardless of parent's state. |