Class sap.ui.commons.RowRepeaterSorterModule: sap/ui/commons/RowRepeaterSorter

extends Element

This element is used by the RowRepeater and allows to define a sorter in this context along with the related data such as a text and an icon.

Deprecated API:Since version 1.38. Instead, use the sap.ui.table.Table control.

Constructor Summary
new sap.ui.commons.RowRepeaterSorter(sId?, mSettings?)Constructor for a new RowRepeaterSorter.
Method Summary
sap.ui.commons.RowRepeaterSorter.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.RowRepeaterSorter with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.RowRepeaterSorter.getMetadata()Returns a metadata object for class sap.ui.commons.RowRepeaterSorter.
getIcon()Gets current value of property icon.
getSorter()Gets current value of property sorter.
getText()Gets current value of property text.
setIcon(sIcon)Sets a new value for property icon.
setSorter(oSorter)Sets a new value for property sorter.
setText(sText)Sets a new value for property text.
Constructor Detail
new sap.ui.commons.RowRepeaterSorter(sId?, mSettings?)
Constructor for a new RowRepeaterSorter.

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.Element 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
Deprecated:
Since version 1.38. Instead, use the sap.ui.table.Table control.
Method Detail
sap.ui.commons.RowRepeaterSorter.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.commons.RowRepeaterSorter 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.

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.ui.commons.RowRepeaterSorter.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.RowRepeaterSorter.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getIcon(): string
Gets current value of property icon.

The sorter icon if needed for display.

Returns:
{string} Value of property icon
getSorter(): object
Gets current value of property sorter.

The sorter object.

Returns:
{object} Value of property sorter
getText(): string
Gets current value of property text.

The sorter title if needed for display.

Returns:
{string} Value of property text
Sets a new value for property icon.

The sorter icon if needed for display.

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

Parameters:
{string}sIcon New value for property icon
Returns:
{sap.ui.commons.RowRepeaterSorter} Reference to this in order to allow method chaining
Sets a new value for property sorter.

The sorter object.

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

Parameters:
{object}oSorter New value for property sorter
Returns:
{sap.ui.commons.RowRepeaterSorter} Reference to this in order to allow method chaining
Sets a new value for property text.

The sorter title if needed for display.

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

Parameters:
{string}sText New value for property text
Returns:
{sap.ui.commons.RowRepeaterSorter} Reference to this in order to allow method chaining