class sap.m.SelectionDetailsItemLine

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

This Element provides a means to fill an sap.m.SelectionDetailsItem with content. It is used for a form-like display of a label followed by a value with an optional unit. If the unit is used, the value is displayed bold. Note:It is protected and should ony be used within the framework itself.


Constructor

Constructor for a new SelectionDetailsItemLine.

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

ID for the new element, generated automatically if no ID is given

mSettings? object

Initial settings for the new element


Properties

Name Type Default Value Description
displayValue string

The display value of the line. If this property is set, it overrides the value property and is displayed as is.

Visibility: public
label string

The label that is shown as the first part of the line. It may contain the name of the currently selected dimension or measure.

Visibility: public
lineMarker string

A string to be rendered by the control as a line marker. This string must be a valid SVG definition. The only valid tags are: svg, path, line.

Visibility: public
unit string

The unit of the given value. If this unit is given, the line is displayed bold.

Visibility: public
value any

The value of the line, for example the value of the currently selected measure. Expected type is a string, number or a plain object, including date and time properties of type string.

Visibility: public

Methods Overview

Method Description
sap.m.SelectionDetailsItemLine.extend

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

getDisplayValue

Gets current value of property displayValue.

The display value of the line. If this property is set, it overrides the value property and is displayed as is.

getLabel

Gets current value of property label.

The label that is shown as the first part of the line. It may contain the name of the currently selected dimension or measure.

getLineMarker

Gets current value of property lineMarker.

A string to be rendered by the control as a line marker. This string must be a valid SVG definition. The only valid tags are: svg, path, line.

sap.m.SelectionDetailsItemLine.getMetadata

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

getUnit

Gets current value of property unit.

The unit of the given value. If this unit is given, the line is displayed bold.

getValue

Gets current value of property value.

The value of the line, for example the value of the currently selected measure. Expected type is a string, number or a plain object, including date and time properties of type string.

setDisplayValue

Sets a new value for property displayValue.

The display value of the line. If this property is set, it overrides the value property and is displayed as is.

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

setLabel

Sets a new value for property label.

The label that is shown as the first part of the line. It may contain the name of the currently selected dimension or measure.

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

setLineMarker

Sets a new value for property lineMarker.

A string to be rendered by the control as a line marker. This string must be a valid SVG definition. The only valid tags are: svg, path, line.

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

setUnit

Sets a new value for property unit.

The unit of the given value. If this unit is given, the line is displayed bold.

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

setValue

Sets a new value for property value.

The value of the line, for example the value of the currently selected measure. Expected type is a string, number or a plain object, including date and time properties of type string.

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

sap.m.SelectionDetailsItemLine.extend

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

getDisplayValue

Gets current value of property displayValue.

The display value of the line. If this property is set, it overrides the value property and is displayed as is.

getLabel

Gets current value of property label.

The label that is shown as the first part of the line. It may contain the name of the currently selected dimension or measure.

getLineMarker

Gets current value of property lineMarker.

A string to be rendered by the control as a line marker. This string must be a valid SVG definition. The only valid tags are: svg, path, line.

sap.m.SelectionDetailsItemLine.getMetadata

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

getUnit

Gets current value of property unit.

The unit of the given value. If this unit is given, the line is displayed bold.

getValue

Gets current value of property value.

The value of the line, for example the value of the currently selected measure. Expected type is a string, number or a plain object, including date and time properties of type string.

setDisplayValue

Sets a new value for property displayValue.

The display value of the line. If this property is set, it overrides the value property and is displayed as is.

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

Param Type DefaultValue Description
sDisplayValue string

New value for property displayValue

setLabel

Sets a new value for property label.

The label that is shown as the first part of the line. It may contain the name of the currently selected dimension or measure.

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

Param Type DefaultValue Description
sLabel string

New value for property label

setLineMarker

Sets a new value for property lineMarker.

A string to be rendered by the control as a line marker. This string must be a valid SVG definition. The only valid tags are: svg, path, line.

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

Param Type DefaultValue Description
sLineMarker string

New value for property lineMarker

setUnit

Sets a new value for property unit.

The unit of the given value. If this unit is given, the line is displayed bold.

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

Param Type DefaultValue Description
sUnit string

New value for property unit

setValue

Sets a new value for property value.

The value of the line, for example the value of the currently selected measure. Expected type is a string, number or a plain object, including date and time properties of type string.

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

Param Type DefaultValue Description
oValue any

New value for property value