class sap.ui.vk.SceneTree

Control sample: sap.ui.vk.SceneTree
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vk/SceneTree
Application Component: CA-UI5-VTK

Provides a hierarchical view of all the nodes in a given scene in table format.


Constructor

Constructor for a new SceneTree.

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

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
legacyVisibilityMode boolean false

In legacy visibility mode all changes in node visibility also apply to all descendent nodes

Visibility: public
showSearchField boolean true

Show or hide search field

Visibility: public
showTitle boolean true

If set to False then title text will not bbe displayed

Visibility: public
title string ...see text or source

Text to be displayed in title bar of scene tree

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
treeTable 0..1 sap.ui.table.TreeTable

Associations

Name Cardinality Type Description
contentConnector 0..1 sap.ui.vk.ContentConnector

An association to the ContentConnector instance that manages content resources.

viewStateManager 0..1 sap.ui.vk.ViewStateManagerBase

An association to the ViewStateManager instance.


Events Overview

Event Description
contentChanged

This event will be fired when a scene tree content is replaced.

This event bubbles up the control hierarchy.

contentChanged

This event will be fired when a scene tree content is replaced.

This event bubbles up the control hierarchy.

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

Methods Overview

Method Description
attachContentChanged

Attaches event handler fnFunction to the contentChanged event of this sap.ui.vk.SceneTree.

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

This event will be fired when a scene tree content is replaced.

destroyTreeTable

Destroys the treeTable in the aggregation treeTable.

detachContentChanged

Detaches event handler fnFunction from the contentChanged event of this sap.ui.vk.SceneTree.

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

sap.ui.vk.SceneTree.extend

Creates a new subclass of class sap.ui.vk.SceneTree 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.Control.extend.

fireContentChanged

Fires event contentChanged to attached listeners.

getContentConnector

ID of the element which is the current target of the association contentConnector, or null.

getLegacyVisibilityMode

Gets current value of property legacyVisibilityMode.

In legacy visibility mode all changes in node visibility also apply to all descendent nodes

Default value is false.

sap.ui.vk.SceneTree.getMetadata

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

getShowSearchField

Gets current value of property showSearchField.

Show or hide search field

Default value is true.

getShowTitle

Gets current value of property showTitle.

If set to False then title text will not bbe displayed

Default value is true.

getTitle

Gets current value of property title.

Text to be displayed in title bar of scene tree

Default value is ...see text or source.

getTreeTable

Gets content of aggregation treeTable.

getViewStateManager

ID of the element which is the current target of the association viewStateManager, or null.

setContentConnector

Sets the associated contentConnector.

setLegacyVisibilityMode

Sets a new value for property legacyVisibilityMode.

In legacy visibility mode all changes in node visibility also apply to all descendent nodes

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

Default value is false.

setShowSearchField

Sets a new value for property showSearchField.

Show or hide search field

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

Default value is true.

setShowTitle

Sets a new value for property showTitle.

If set to False then title text will not bbe displayed

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

Default value is true.

setTitle

Sets a new value for property title.

Text to be displayed in title bar of scene tree

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

Default value is ...see text or source.

setTreeTable

Sets the aggregated treeTable.

setViewStateManager

Sets the associated viewStateManager.

attachContentChanged

Attaches event handler fnFunction to the contentChanged event of this sap.ui.vk.SceneTree.

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

This event will be fired when a scene tree content 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 sap.ui.vk.SceneTree itself

destroyTreeTable

Destroys the treeTable in the aggregation treeTable.

detachContentChanged

Detaches event handler fnFunction from the contentChanged event of this sap.ui.vk.SceneTree.

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.SceneTree.extend

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

fireContentChanged

Fires event contentChanged to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getContentConnector

ID of the element which is the current target of the association contentConnector, or null.

getLegacyVisibilityMode

Gets current value of property legacyVisibilityMode.

In legacy visibility mode all changes in node visibility also apply to all descendent nodes

Default value is false.

sap.ui.vk.SceneTree.getMetadata

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

getShowSearchField

Gets current value of property showSearchField.

Show or hide search field

Default value is true.

getShowTitle

Gets current value of property showTitle.

If set to False then title text will not bbe displayed

Default value is true.

getTitle

Gets current value of property title.

Text to be displayed in title bar of scene tree

Default value is ...see text or source.

getTreeTable

Gets content of aggregation treeTable.

getViewStateManager

ID of the element which is the current target of the association viewStateManager, or null.

setContentConnector

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

setLegacyVisibilityMode

Sets a new value for property legacyVisibilityMode.

In legacy visibility mode all changes in node visibility also apply to all descendent nodes

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
bLegacyVisibilityMode boolean false

New value for property legacyVisibilityMode

setShowSearchField

Sets a new value for property showSearchField.

Show or hide search field

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

Default value is true.

Param Type DefaultValue Description
bShowSearchField boolean true

New value for property showSearchField

setShowTitle

Sets a new value for property showTitle.

If set to False then title text will not bbe displayed

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

Default value is true.

Param Type DefaultValue Description
bShowTitle boolean true

New value for property showTitle

setTitle

Sets a new value for property title.

Text to be displayed in title bar of scene tree

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

Default value is ...see text or source.

Param Type DefaultValue Description
sTitle string ...see text or source

New value for property title

setTreeTable

Sets the aggregated treeTable.

Param Type DefaultValue Description
oTreeTable sap.ui.table.TreeTable

The treeTable to set

setViewStateManager

Sets the associated viewStateManager.

Param Type DefaultValue Description
oViewStateManager sap.ui.core.ID sap.ui.vk.ViewStateManagerBase

ID of an element which becomes the new target of this viewStateManager association; alternatively, an element instance may be given