class sap.ui.vtm.extensions.SelectionLinkingExtension

Visiblity: public
UX Guidelines:
Implements: sap.ui.vtm.interfaces.ISelectionLinkingExtension
Available since: N/A
Module: sap/ui/vtm/extensions/SelectionLinkingExtension
Application Component:

Adds a behavior that links items the visibility of tree items in a sap.ui.vtm.Tree with the visibility of their associated scene nodes in the sap.ui.vtm.Viewport in the same sap.ui.vtm.Panel.


Constructor

Constructor for a new SelectionLinkingExtension.

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

id for the new sap.ui.vtm.extensions.SelectionLinkingExtension instance.

mSettings object

Object with initial property values, aggregated objects etc. for the new sap.ui.vtm.extensions.SelectionLinkingExtension instance.


Properties

Name Type Default Value Description
findMatchingTreeItems any

The value is a callback function that finds tree items in a particular tree that match a given tree item.

The first parameter is the tree item to match against.
The second parameter is the sap.ui.vtm.Tree containing the specified tree item being matched against.
The third parameter is the sap.ui.vtm.Tree to search for matches in.
The function returns an array of tree items that match the specified tree item.

Visibility: public

Borrowed Properties

Name Type Default Value Description
enabled boolean true

Controls whether the extension is enabled.

Visibility: public

Methods Overview

Method Description
sap.ui.vtm.extensions.SelectionLinkingExtension.extend

Creates a new subclass of class sap.ui.vtm.extensions.SelectionLinkingExtension 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.vtm.Extension.extend.

getFindMatchingTreeItems

Gets current value of property findMatchingTreeItems.

The value is a callback function that finds tree items in a particular tree that match a given tree item.

The first parameter is the tree item to match against.
The second parameter is the sap.ui.vtm.Tree containing the specified tree item being matched against.
The third parameter is the sap.ui.vtm.Tree to search for matches in.
The function returns an array of tree items that match the specified tree item.

sap.ui.vtm.extensions.SelectionLinkingExtension.getMetadata

Returns a metadata object for class sap.ui.vtm.extensions.SelectionLinkingExtension.

setFindMatchingTreeItems

Sets a new value for property findMatchingTreeItems.

The value is a callback function that finds tree items in a particular tree that match a given tree item.

The first parameter is the tree item to match against.
The second parameter is the sap.ui.vtm.Tree containing the specified tree item being matched against.
The third parameter is the sap.ui.vtm.Tree to search for matches in.
The function returns an array of tree items that match the specified tree item.

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

sap.ui.vtm.extensions.SelectionLinkingExtension.extend

Creates a new subclass of class sap.ui.vtm.extensions.SelectionLinkingExtension 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.vtm.Extension.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

getFindMatchingTreeItems

Gets current value of property findMatchingTreeItems.

The value is a callback function that finds tree items in a particular tree that match a given tree item.

The first parameter is the tree item to match against.
The second parameter is the sap.ui.vtm.Tree containing the specified tree item being matched against.
The third parameter is the sap.ui.vtm.Tree to search for matches in.
The function returns an array of tree items that match the specified tree item.

sap.ui.vtm.extensions.SelectionLinkingExtension.getMetadata

Returns a metadata object for class sap.ui.vtm.extensions.SelectionLinkingExtension.

setFindMatchingTreeItems

Sets a new value for property findMatchingTreeItems.

The value is a callback function that finds tree items in a particular tree that match a given tree item.

The first parameter is the tree item to match against.
The second parameter is the sap.ui.vtm.Tree containing the specified tree item being matched against.
The third parameter is the sap.ui.vtm.Tree to search for matches in.
The function returns an array of tree items that match the specified tree item.

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

Param Type DefaultValue Description
oFindMatchingTreeItems any

New value for property findMatchingTreeItems