class sap.m.SelectionDetailsItem

Visiblity: protected
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/SelectionDetailsItem
Application Component: CA-UI5-SC

This protected element provides an item for sap.m.SelectionDetails that is shown inside a list. The item includes SelectionDetailsItemLine as its lines that are displayed in one block above the optional actions. Note:It is protected and should only be used within the framework itself.


Constructor

Constructor for a new SelectionDetailsItem.

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.m.SelectionDetailsItem(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
enableNav boolean false

Determines whether or not the item is active and a navigation event is triggered on press.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_overflowToolbar 0..1 sap.m.OverflowToolbar

Shows custom action buttons below the main content of the item.

actions 0..n sap.ui.core.Item

Contains custom actions shown below the main content of the item.

lines 0..n sap.m.SelectionDetailsItemLine

Contains a record of information about, for example, measures and dimensions. These entries are usually obtained via selection in chart controls.


Methods Overview

Method Description
addAction

Adds some action to the aggregation actions.

addLine

Adds some line to the aggregation lines.

bindLines

Binds aggregation lines to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

destroyActions

Destroys all the actions in the aggregation actions.

destroyLines

Destroys all the lines in the aggregation lines.

sap.m.SelectionDetailsItem.extend

Creates a new subclass of class sap.m.SelectionDetailsItem 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.

getActions

Gets content of aggregation actions.

Contains custom actions shown below the main content of the item.

getEnableNav

Gets current value of property enableNav.

Determines whether or not the item is active and a navigation event is triggered on press.

Default value is false.

getFacade

Returns the public facade of the SelectionDetailsItem for non inner framework usages.

getLines

Gets content of aggregation lines.

Contains a record of information about, for example, measures and dimensions. These entries are usually obtained via selection in chart controls.

sap.m.SelectionDetailsItem.getMetadata

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

indexOfAction

Checks for the provided sap.ui.core.Item in the aggregation actions. and returns its index if found or -1 otherwise.

indexOfLine

Checks for the provided sap.m.SelectionDetailsItemLine in the aggregation lines. and returns its index if found or -1 otherwise.

insertAction

Inserts a action into the aggregation actions.

insertLine

Inserts a line into the aggregation lines.

removeAction

Removes a action from the aggregation actions.

removeAllActions

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

removeAllLines

Removes all the controls from the aggregation lines.

Additionally, it unregisters them from the hosting UIArea.

removeLine

Removes a line from the aggregation lines.

setEnableNav

Sets a new value for property enableNav.

Determines whether or not the item is active and a navigation event is triggered on press.

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

Default value is false.

unbindLines

Unbinds aggregation lines from model data.

addAction

Adds some action to the aggregation actions.

Param Type DefaultValue Description
oAction sap.ui.core.Item

The action to add; if empty, nothing is inserted

addLine

Adds some line to the aggregation lines.

Param Type DefaultValue Description
oLine sap.m.SelectionDetailsItemLine

The line to add; if empty, nothing is inserted

bindLines

Binds aggregation lines to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Param Type DefaultValue Description
oBindingInfo sap.ui.base.ManagedObject.AggregationBindingInfo

The binding information

destroyActions

Destroys all the actions in the aggregation actions.

destroyLines

Destroys all the lines in the aggregation lines.

sap.m.SelectionDetailsItem.extend

Creates a new subclass of class sap.m.SelectionDetailsItem 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

getActions

Gets content of aggregation actions.

Contains custom actions shown below the main content of the item.

getEnableNav

Gets current value of property enableNav.

Determines whether or not the item is active and a navigation event is triggered on press.

Default value is false.

getFacade

Returns the public facade of the SelectionDetailsItem for non inner framework usages.

getLines

Gets content of aggregation lines.

Contains a record of information about, for example, measures and dimensions. These entries are usually obtained via selection in chart controls.

sap.m.SelectionDetailsItem.getMetadata

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

indexOfAction

Checks for the provided sap.ui.core.Item in the aggregation actions. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oAction sap.ui.core.Item

The action whose index is looked for

indexOfLine

Checks for the provided sap.m.SelectionDetailsItemLine in the aggregation lines. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oLine sap.m.SelectionDetailsItemLine

The line whose index is looked for

insertAction

Inserts a action into the aggregation actions.

Param Type DefaultValue Description
oAction sap.ui.core.Item

The action to insert; if empty, nothing is inserted

iIndex int

The 0-based index the action should be inserted at; for a negative value of iIndex, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position

insertLine

Inserts a line into the aggregation lines.

Param Type DefaultValue Description
oLine sap.m.SelectionDetailsItemLine

The line to insert; if empty, nothing is inserted

iIndex int

The 0-based index the line should be inserted at; for a negative value of iIndex, the line is inserted at position 0; for a value greater than the current size of the aggregation, the line is inserted at the last position

removeAction

Removes a action from the aggregation actions.

Param Type DefaultValue Description
vAction int string sap.ui.core.Item

The action to remove or its index or id

removeAllActions

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

removeAllLines

Removes all the controls from the aggregation lines.

Additionally, it unregisters them from the hosting UIArea.

removeLine

Removes a line from the aggregation lines.

Param Type DefaultValue Description
vLine int string sap.m.SelectionDetailsItemLine

The line to remove or its index or id

setEnableNav

Sets a new value for property enableNav.

Determines whether or not the item is active and a navigation event is triggered on press.

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

New value for property enableNav

unbindLines

Unbinds aggregation lines from model data.