class sap.m.TreeItemBase

Control sample: sap.m.TreeItemBase
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/TreeItemBase
Application Component: CA-UI5-CTR

The sap.m.TreeItemBase contains the basic features of all specific tree items.


Constructor

Constructor for a new TreeItemBase.

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.

This class does not have its own settings, but all settings applicable to the base type sap.m.ListItemBase can be used.

new sap.m.TreeItemBase(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

Borrowed Properties

Name Type Default Value Description
counter int

Defines the counter value of the list items.

Visibility: public
highlight string None

Defines the highlight state of the list items.

Valid values for the highlight property are values of the enumerations sap.ui.core.MessageType or sap.ui.core.IndicationColor.

Accessibility support is provided through the associated highlightText property. If the highlight property is set to a value of sap.ui.core.MessageType, the highlightText property does not need to be set because a default text is used. However, the default text can be overridden by setting the highlightText property. In all other cases the highlightText property must be set.

Since: 1.44.0.

Visibility: public
highlightText string empty string

Defines the semantics of the highlight property for accessibility purposes.

Since: 1.62.

Visibility: public
navigated boolean false

The navigated state of the list item.

If set to true, a navigation indicator is displayed at the end of the list item. Note: This property must be set for one list item only.

Since: 1.72.

Visibility: public
selected boolean false

Defines the selected state of the list items. Note: Binding the selected property in single selection modes may cause unwanted results if you have more than one selected items in your binding.

Visibility: public
type sap.m.ListType Inactive

Defines the visual indication and behavior of the list items, e.g. Active, Navigation, Detail.

Visibility: public
unread boolean false

Activates the unread indicator for the list item, if set to true. Note: This flag is ignored when the showUnread property of the parent is set to false.

Visibility: public
visible boolean true

Whether the control should be visible on the screen. If set to false, a placeholder is rendered instead of the real control.

Visibility: public

Methods Overview

Method Description
sap.m.TreeItemBase.extend

Creates a new subclass of class sap.m.TreeItemBase with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.ListItemBase.extend.

getExpanded

Gets the expanding information of the node.

getItemNodeContext

Gets the context of the node.

getLevel

Gets the node level in the hierarchy.

sap.m.TreeItemBase.getMetadata

Returns a metadata object for class sap.m.TreeItemBase.

getParentNode

Gets the parent node control.

getParentNodeContext

Gets the context of the parent node control.

isLeaf

Determines if the node is a leaf.

isTopLevel

Checks if the node is the top level node.

sap.m.TreeItemBase.extend

Creates a new subclass of class sap.m.TreeItemBase with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.ListItemBase.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

getExpanded

Gets the expanding information of the node.

getItemNodeContext

Gets the context of the node.

getLevel

Gets the node level in the hierarchy.

sap.m.TreeItemBase.getMetadata

Returns a metadata object for class sap.m.TreeItemBase.

getParentNode

Gets the parent node control.

getParentNodeContext

Gets the context of the parent node control.

isLeaf

Determines if the node is a leaf.

isTopLevel

Checks if the node is the top level node.