class sap.m.FeedListItemAction

Control sample: sap.m.FeedListItemAction
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/FeedListItemAction
Application Component: CA-UI5-CTR

An action item of FeedListItem


Constructor

Constructor for a new FeedListItemAction.

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.m.FeedListItemAction(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 element


Properties

Name Type Default Value Description
enabled boolean true

Enables or disables a button on the UI. All buttons are enabled by default. Disabled buttons are colored differently as per the theme of the UI.

Visibility: public
icon sap.ui.core.URI

The icon of the action.

Visibility: public
key string empty string

The key of the item.

Visibility: public
text string empty string

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

Visibility: public
visible boolean true

Hides or shows a button on the UI.

Visibility: public

Events Overview

Event Description
press

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

press

The press event 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.m.FeedListItemAction.

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.m.FeedListItemAction itself.

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

detachPress

Detaches event handler fnFunction from the press event of this sap.m.FeedListItemAction.

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

sap.m.FeedListItemAction.extend

Creates a new subclass of class sap.m.FeedListItemAction 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.

getEnabled

Gets current value of property enabled.

Enables or disables a button on the UI. All buttons are enabled by default. Disabled buttons are colored differently as per the theme of the UI.

Default value is true.

getIcon

Gets current value of property icon.

The icon of the action.

getKey

Gets current value of property key.

The key of the item.

Default value is empty string.

sap.m.FeedListItemAction.getMetadata

Returns a metadata object for class sap.m.FeedListItemAction.

getText

Gets current value of property text.

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

Default value is empty string.

getVisible

Gets current value of property visible.

Hides or shows a button on the UI.

Default value is true.

setEnabled

Sets a new value for property enabled.

Enables or disables a button on the UI. All buttons are enabled by default. Disabled buttons are colored differently as per the theme of the UI.

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

Default value is true.

setIcon

Sets a new value for property icon.

The icon of the action.

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

setKey

Sets a new value for property key.

The key of the item.

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

Default value is empty string.

setText

Sets a new value for property text.

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

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

Default value is empty string.

setVisible

Sets a new value for property visible.

Hides or shows a button on the UI.

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.m.FeedListItemAction.

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.m.FeedListItemAction itself.

The press event 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.m.FeedListItemAction itself

detachPress

Detaches event handler fnFunction from the press event of this sap.m.FeedListItemAction.

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.m.FeedListItemAction.extend

Creates a new subclass of class sap.m.FeedListItemAction 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

getEnabled

Gets current value of property enabled.

Enables or disables a button on the UI. All buttons are enabled by default. Disabled buttons are colored differently as per the theme of the UI.

Default value is true.

getIcon

Gets current value of property icon.

The icon of the action.

getKey

Gets current value of property key.

The key of the item.

Default value is empty string.

sap.m.FeedListItemAction.getMetadata

Returns a metadata object for class sap.m.FeedListItemAction.

getText

Gets current value of property text.

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

Default value is empty string.

getVisible

Gets current value of property visible.

Hides or shows a button on the UI.

Default value is true.

setEnabled

Sets a new value for property enabled.

Enables or disables a button on the UI. All buttons are enabled by default. Disabled buttons are colored differently as per the theme of the UI.

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
bEnabled boolean true

New value for property enabled

setIcon

Sets a new value for property icon.

The icon of the action.

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

setKey

Sets a new value for property key.

The key of the item.

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

New value for property key

setText

Sets a new value for property text.

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

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

setVisible

Sets a new value for property visible.

Hides or shows a button on the UI.

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