class sap.ui.ux3.ThingAction

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

Thing Action for Swatch, QuickView, Thinginspector


Constructor

Constructor for a new ThingAction.

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.ux3.ThingAction(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
enabled boolean true

action enabled (true/false)

Visibility: public
text string

text of action

Visibility: public

Events Overview

Event Description
select

Event will be fired when the action was triggered.

select

Event will be fired when the action was triggered.

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

Id of selected action

action sap.ui.ux3.ThingAction

Selected Thing Action


Methods Overview

Method Description
attachSelect

Attaches event handler fnFunction to the select event of this sap.ui.ux3.ThingAction.

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.ux3.ThingAction itself.

Event will be fired when the action was triggered.

detachSelect

Detaches event handler fnFunction from the select event of this sap.ui.ux3.ThingAction.

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

sap.ui.ux3.ThingAction.extend

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

fireSelect

Fires event select to attached listeners.

getEnabled

Gets current value of property enabled.

action enabled (true/false)

Default value is true.

sap.ui.ux3.ThingAction.getMetadata

Returns a metadata object for class sap.ui.ux3.ThingAction.

getText

Gets current value of property text.

text of action

setEnabled

Sets a new value for property enabled.

action enabled (true/false)

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

Default value is true.

setText

Sets a new value for property text.

text of action

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

attachSelect

Attaches event handler fnFunction to the select event of this sap.ui.ux3.ThingAction.

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.ux3.ThingAction itself.

Event will be fired when the action was triggered.

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.ux3.ThingAction itself

detachSelect

Detaches event handler fnFunction from the select event of this sap.ui.ux3.ThingAction.

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.ux3.ThingAction.extend

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

fireSelect

Fires event select to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

id string

Id of selected action

action sap.ui.ux3.ThingAction

Selected Thing Action

getEnabled

Gets current value of property enabled.

action enabled (true/false)

Default value is true.

sap.ui.ux3.ThingAction.getMetadata

Returns a metadata object for class sap.ui.ux3.ThingAction.

getText

Gets current value of property text.

text of action

setEnabled

Sets a new value for property enabled.

action enabled (true/false)

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

setText

Sets a new value for property text.

text of action

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