class sap.ui.table.RowActionItem

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/table/RowActionItem
Application Component: CA-UI5-TBL

An action items to be displayed in a RowAction control. This element must only be used in the context of the sap.ui.table.Table control to define row actions.


Constructor

Constructor for a new RowActionItem.

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.RowActionItem(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 sap.ui.core.URI

The icon of the item.

Visibility: public
text string empty string

The text of the item. It is used as tooltip and for accessibility purposes.

Visibility: public
type sap.ui.table.RowActionType Custom

The type of the item. Setting the type ensures default values for the properties icon and text. If an icon or text is set explicitly this setting is used.

Visibility: public
visible boolean true

Whether the item should be visible on the screen.

Visibility: public

Events Overview

Event Description
press

The press is fired when the user triggers the corresponding action.

press

The press is fired when the user triggers the corresponding action.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

Methods Overview

Method Description
attachPress

Attaches event handler fnFunction to the press event of this sap.ui.table.RowActionItem.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.table.RowActionItem itself.

The press is fired when the user triggers the corresponding action.

detachPress

Detaches event handler fnFunction from the press event of this sap.ui.table.RowActionItem.

The passed function and listener object must match the ones used for event registration.

sap.ui.table.RowActionItem.extend

Creates a new subclass of class sap.ui.table.RowActionItem 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.

firePress

Fires event press to attached listeners.

getIcon

Gets current value of property icon.

The icon of the item.

sap.ui.table.RowActionItem.getMetadata

Returns a metadata object for class sap.ui.table.RowActionItem.

getText

Gets current value of property text.

The text of the item. It is used as tooltip and for accessibility purposes.

Default value is empty string.

getType

Gets current value of property type.

The type of the item. Setting the type ensures default values for the properties icon and text. If an icon or text is set explicitly this setting is used.

Default value is Custom.

getVisible

Gets current value of property visible.

Whether the item should be visible on the screen.

Default value is true.

setIcon

Sets a new value for property icon.

The icon of the item.

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 text of the item. It is used as tooltip and for accessibility purposes.

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

Default value is empty string.

setType

Sets a new value for property type.

The type of the item. Setting the type ensures default values for the properties icon and text. If an icon or text is set explicitly this setting is used.

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

Default value is Custom.

setVisible

Sets a new value for property visible.

Whether the item should be visible on the screen.

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

Default value is true.

attachPress

Attaches event handler fnFunction to the press event of this sap.ui.table.RowActionItem.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.table.RowActionItem itself.

The press is fired when the user triggers the corresponding action.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.table.RowActionItem itself

detachPress

Detaches event handler fnFunction from the press event of this sap.ui.table.RowActionItem.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.table.RowActionItem.extend

Creates a new subclass of class sap.ui.table.RowActionItem 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

firePress

Fires event press to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getIcon

Gets current value of property icon.

The icon of the item.

sap.ui.table.RowActionItem.getMetadata

Returns a metadata object for class sap.ui.table.RowActionItem.

getText

Gets current value of property text.

The text of the item. It is used as tooltip and for accessibility purposes.

Default value is empty string.

getType

Gets current value of property type.

The type of the item. Setting the type ensures default values for the properties icon and text. If an icon or text is set explicitly this setting is used.

Default value is Custom.

getVisible

Gets current value of property visible.

Whether the item should be visible on the screen.

Default value is true.

setIcon

Sets a new value for property icon.

The icon of the item.

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

Param Type DefaultValue Description
sIcon sap.ui.core.URI

New value for property icon

setText

Sets a new value for property text.

The text of the item. It is used as tooltip and for accessibility purposes.

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
sText string ""

New value for property text

setType

Sets a new value for property type.

The type of the item. Setting the type ensures default values for the properties icon and text. If an icon or text is set explicitly this setting is used.

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

Default value is Custom.

Param Type DefaultValue Description
sType sap.ui.table.RowActionType Custom

New value for property type

setVisible

Sets a new value for property visible.

Whether the item should be visible on the screen.

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

Default value is true.

Param Type DefaultValue Description
bVisible boolean true

New value for property visible