class sap.ui.commons.RowRepeaterSorter

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/commons/RowRepeaterSorter
Application Component: CA-UI5-CTR

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.


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.ui.commons.RowRepeaterSorter(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
icon string

The sorter icon if needed for display.

Visibility: public
sorter object

The sorter object.

Visibility: public
text string

The sorter title if needed for display.

Visibility: public

Methods Overview

Method Description
sap.ui.commons.RowRepeaterSorter.extend

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.

getIcon

Gets current value of property icon.

The sorter icon if needed for display.

sap.ui.commons.RowRepeaterSorter.getMetadata

Returns a metadata object for class sap.ui.commons.RowRepeaterSorter.

getSorter

Gets current value of property sorter.

The sorter object.

getText

Gets current value of property text.

The sorter title if needed for display.

setIcon

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.

setSorter

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.

setText

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.

sap.ui.commons.RowRepeaterSorter.extend

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.

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

getIcon

Gets current value of property icon.

The sorter icon if needed for display.

sap.ui.commons.RowRepeaterSorter.getMetadata

Returns a metadata object for class sap.ui.commons.RowRepeaterSorter.

getSorter

Gets current value of property sorter.

The sorter object.

getText

Gets current value of property text.

The sorter title if needed for display.

setIcon

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.

Param Type DefaultValue Description
sIcon string

New value for property icon

setSorter

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.

Param Type DefaultValue Description
oSorter object

New value for property sorter

setText

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.

Param Type DefaultValue Description
sText string

New value for property text