Class sap.m.P13nItemModule: sap/m/P13nItem

extends Item

Base type for items aggregation in P13nPanel control.


Since: 1.26.0.
Constructor Summary
new sap.m.P13nItem(sId?, mSettings?)Constructor for a new P13nItem.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.P13nItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.P13nItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.P13nItem.getMetadata()Returns a metadata object for class sap.m.P13nItem.
getAggregationRole()Gets current value of property aggregationRole.
getColumnKey()Gets current value of property columnKey.
getIsDefault()Gets current value of property isDefault.
getMaxLength()Gets current value of property maxLength.
getPrecision()Gets current value of property precision.
getRole()Gets current value of property role.
getScale()Gets current value of property scale.
getText()Gets current value of property text.
getType()Gets current value of property type.
getValues()Gets current value of property values.
getVisible()Gets current value of property visible.
getWidth()Gets current value of property width.
setAggregationRole(sAggregationRole)Sets a new value for property aggregationRole.
setColumnKey(sColumnKey)Sets a new value for property columnKey.
setIsDefault(bIsDefault)Sets a new value for property isDefault.
setMaxLength(sMaxLength)Sets a new value for property maxLength.
setPrecision(sPrecision)Sets a new value for property precision.
setRole(sRole)Sets a new value for property role.
setScale(sScale)Sets a new value for property scale.
setText(sText)Sets a new value for property text.
setType(sType)Sets a new value for property type.
setValues(sValues)Sets a new value for property values.
setVisible(bVisible)Sets a new value for property visible.
setWidth(sWidth)Sets a new value for property width.
Methods borrowed from class sap.ui.core.Item
getEnabled, getKey, getTextDirection, setEnabled, setKey, setTextDirection
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.m.P13nItem(sId?, mSettings?)
Constructor for a new P13nItem.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Item can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Method Detail
sap.m.P13nItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.P13nItem 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.Item.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.m.P13nItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.P13nItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getAggregationRole(): string
Gets current value of property aggregationRole.

Defines aggregation role

Since:
1.34.0
Returns:
{string} Value of property aggregationRole
getColumnKey(): string
Gets current value of property columnKey.

Can be used as input for subsequent actions.

Since:
1.26.0
Returns:
{string} Value of property columnKey
getIsDefault(): boolean
Gets current value of property isDefault.

the column with isDefault==true will be used as the selected column item on the conditionPanel

Default value is false.

Since:
1.26.0
Returns:
{boolean} Value of property isDefault
getMaxLength(): string
Gets current value of property maxLength.

specifies the number of characters which can be entered in the value fields of the condition panel

Since:
1.26.0
Returns:
{string} Value of property maxLength
getPrecision(): string
Gets current value of property precision.

if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used Formatter)

Since:
1.26.0
Returns:
{string} Value of property precision
getRole(): string
Gets current value of property role.

Defines role. The role is reflected in the manner how the dimension will influence the chart layout.

Since:
1.34.0
Returns:
{string} Value of property role
getScale(): string
Gets current value of property scale.

if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter)

Since:
1.26.0
Returns:
{string} Value of property scale
getText(): string
Gets current value of property text.

The text to be displayed for the item.

Default value is .

Since:
1.26.0
Returns:
{string} Value of property text
getType(): string
Gets current value of property type.

data type of the column (text, numeric or date is supported)

Default value is text.

Since:
1.26.0
Returns:
{string} Value of property type
getValues(): string[]
Gets current value of property values.

the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank the value field). Next value represent the false value, last entry the true value.

Since:
1.34.0
Returns:
{string[]} Value of property values
getVisible(): boolean
Gets current value of property visible.

Defines visibility of column

Since:
1.26.0
Returns:
{boolean} Value of property visible
getWidth(): string
Gets current value of property width.

Defines column width

Since:
1.26.0
Returns:
{string} Value of property width
setAggregationRole(sAggregationRole): sap.m.P13nItem
Sets a new value for property aggregationRole.

Defines aggregation role

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

Parameters:
{string}sAggregationRole New value for property aggregationRole
Since:
1.34.0
Returns:
{sap.m.P13nItem} Reference to this in order to allow method chaining
setColumnKey(sColumnKey): sap.m.P13nItem
Sets a new value for property columnKey.

Can be used as input for subsequent actions.

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

Parameters:
{string}sColumnKey New value for property columnKey
Since:
1.26.0
Returns:
{sap.m.P13nItem} Reference to this in order to allow method chaining
setIsDefault(bIsDefault): sap.m.P13nItem
Sets a new value for property isDefault.

the column with isDefault==true will be used as the selected column item on the conditionPanel

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

Default value is false.

Parameters:
{boolean}bIsDefault New value for property isDefault
Since:
1.26.0
Returns:
{sap.m.P13nItem} Reference to this in order to allow method chaining
setMaxLength(sMaxLength): sap.m.P13nItem
Sets a new value for property maxLength.

specifies the number of characters which can be entered in the value fields of the condition panel

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

Parameters:
{string}sMaxLength New value for property maxLength
Since:
1.26.0
Returns:
{sap.m.P13nItem} Reference to this in order to allow method chaining
setPrecision(sPrecision): sap.m.P13nItem
Sets a new value for property precision.

if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used Formatter)

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

Parameters:
{string}sPrecision New value for property precision
Since:
1.26.0
Returns:
{sap.m.P13nItem} Reference to this in order to allow method chaining
setRole(sRole): sap.m.P13nItem
Sets a new value for property role.

Defines role. The role is reflected in the manner how the dimension will influence the chart layout.

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

Parameters:
{string}sRole New value for property role
Since:
1.34.0
Returns:
{sap.m.P13nItem} Reference to this in order to allow method chaining
setScale(sScale): sap.m.P13nItem
Sets a new value for property scale.

if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter)

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

Parameters:
{string}sScale New value for property scale
Since:
1.26.0
Returns:
{sap.m.P13nItem} Reference to this in order to allow method chaining
setText(sText): sap.m.P13nItem
Sets a new value for property text.

The text to be displayed for the item.

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

Default value is .

Parameters:
{string}sText New value for property text
Since:
1.26.0
Returns:
{sap.m.P13nItem} Reference to this in order to allow method chaining
setType(sType): sap.m.P13nItem
Sets a new value for property type.

data type of the column (text, numeric or date is supported)

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

Default value is text.

Parameters:
{string}sType New value for property type
Since:
1.26.0
Returns:
{sap.m.P13nItem} Reference to this in order to allow method chaining
setValues(sValues): sap.m.P13nItem
Sets a new value for property values.

the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank the value field). Next value represent the false value, last entry the true value.

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

Parameters:
{string[]}sValues New value for property values
Since:
1.34.0
Returns:
{sap.m.P13nItem} Reference to this in order to allow method chaining
setVisible(bVisible): sap.m.P13nItem
Sets a new value for property visible.

Defines visibility of column

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

Parameters:
{boolean}bVisible New value for property visible
Since:
1.26.0
Returns:
{sap.m.P13nItem} Reference to this in order to allow method chaining
setWidth(sWidth): sap.m.P13nItem
Sets a new value for property width.

Defines column width

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

Parameters:
{string}sWidth New value for property width
Since:
1.26.0
Returns:
{sap.m.P13nItem} Reference to this in order to allow method chaining