The RowSettings
control allows you to configure a row. You can only use this control in the context of the sap.ui.table.Table
control to define row settings.
Constructor for new RowSettings.
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.table.RowSettings(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 control |
Name | Type | Default Value | Description |
---|---|---|---|
highlight | string | None | The highlight state of the rows. If the highlight is set to sap.ui.core.MessageType.None (default), no highlights are visible. Valid values for the Accessibility support is provided through the associated highlightText property. If the |
highlightText | string | empty string | Defines the semantics of the highlight property for accessibility purposes. It is only used as an invisible text for screen reader support and does not add a tooltip to the highlight. |
navigated | boolean | false | The navigated state of a row. If set to |
Method | Description |
---|---|
sap.ui.table.RowSettings.extend |
Creates a new subclass of class sap.ui.table.RowSettings with name
|
getHighlight |
Gets current value of property highlight. The highlight state of the rows. If the highlight is set to sap.ui.core.MessageType.None (default), no highlights are visible. Valid values for the Accessibility support is provided through the associated highlightText property. If the Default value is |
getHighlightText |
Gets current value of property highlightText. Defines the semantics of the highlight property for accessibility purposes. It is only used as an invisible text for screen reader support and does not add a tooltip to the highlight. Default value is |
sap.ui.table.RowSettings.getMetadata |
Returns a metadata object for class sap.ui.table.RowSettings. |
getNavigated |
Gets current value of property navigated. The navigated state of a row. If set to Default value is |
setHighlight |
Sets a new value for property highlight. The highlight state of the rows. If the highlight is set to sap.ui.core.MessageType.None (default), no highlights are visible. Valid values for the Accessibility support is provided through the associated highlightText property. If the When called with a value of Default value is |
setHighlightText |
Sets a new value for property highlightText. Defines the semantics of the highlight property for accessibility purposes. It is only used as an invisible text for screen reader support and does not add a tooltip to the highlight. When called with a value of Default value is |
setNavigated |
Sets a new value for property navigated. The navigated state of a row. If set to When called with a value of Default value is |
Creates a new subclass of class sap.ui.table.RowSettings 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 |
Gets current value of property highlight.
The highlight state of the rows.
If the highlight is set to sap.ui.core.MessageType.None (default), no highlights are visible. 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.
Default value is "None"
.
Gets current value of property highlightText.
Defines the semantics of the highlight property for accessibility purposes. It is only used as an invisible text for screen reader support and does not add a tooltip to the highlight.
Default value is empty string
.
Sets a new value for property highlight.
The highlight state of the rows.
If the highlight is set to sap.ui.core.MessageType.None (default), no highlights are visible. 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.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is "None"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sHighlight | string | "None" |
New value for property |
Sets a new value for property highlightText.
Defines the semantics of the highlight property for accessibility purposes. It is only used as an invisible text for screen reader support and does not add a tooltip to the highlight.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is empty string
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sHighlightText | string | "" |
New value for property |