Class sap.landvisz.internal.EntityCustomActionModule: sap/landvisz/internal/EntityCustomAction
A control to render custom actions of visualization control
sClassName
and enriches it with the information contained in oClassInfo
.fnFunction
to the 'select' event of this sap.landvisz.internal.EntityCustomAction
.fnFunction
from the 'select' event of this sap.landvisz.internal.EntityCustomAction
. Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers.
If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).
The supported settings are:
- Properties
- customAction : string
- renderingSize : sap.landvisz.EntityCSSSize (default: sap.landvisz.EntityCSSSize.Regular)
- Aggregations
- Associations
- Events
- select : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
{string} | sId? | id for the new control, generated automatically if no id is given |
{object} | mSettings? | initial settings for the new control |
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters |
sClassName
and enriches it with the information contained in oClassInfo
. oClassInfo
might contain the same kind of informations as described in Element.extend.
{string} | sClassName | name of the class to be created |
{object} | oClassInfo? | object literal with informations about the class |
{function} | FNMetaImpl? | constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata. |
{function} | the created class / constructor function |
{sap.ui.base.Metadata} | Metadata object describing this class |
fnFunction
to the 'select' event of this sap.landvisz.internal.EntityCustomAction
.. When called, the context of the event handler (its
this
) will be bound to oListener if specified otherwise to this sap.landvisz.internal.EntityCustomAction
.
itself. click on the action bar
Parameters:
{object} | oData? | An application specific payload object, that will be passed to the event handler along with the event object when firing the event. |
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.landvisz.internal.EntityCustomAction .itself. |
Returns:
{sap.landvisz.internal.EntityCustomAction} | this to allow method chaining |
detachSelect(fnFunction, oListener): sap.landvisz.internal.EntityCustomAction Detach event handler fnFunction
from the 'select' event of this sap.landvisz.internal.EntityCustomAction
.
The passed function and listener object must match the ones used for event registration.
Parameters:{function} fnFunction The function to call, when the event occurs. {object} oListener Context object on which the given function had to be called.
Returns:{sap.landvisz.internal.EntityCustomAction} this
to allow method chaining
fireSelect(mArguments?): sap.landvisz.internal.EntityCustomAction Fire event select to attached listeners. Parameters:{Map} mArguments? the arguments to pass along with the event.
Returns:{sap.landvisz.internal.EntityCustomAction} this
to allow method chaining
getCustomAction(): string Getter for property customAction
. name of the custom action Default value is empty/undefined
Returns:{string} the value of property customAction
getRenderingSize(): sap.landvisz.EntityCSSSize Getter for property renderingSize
. rendering size of the control Default value is sap.landvisz.EntityCSSSize.Regular
Returns:{sap.landvisz.EntityCSSSize} the value of property renderingSize
setCustomAction(sCustomAction): sap.landvisz.internal.EntityCustomAction Setter for property customAction
. Default value is empty/undefined
Parameters:{string} sCustomAction new value for property customAction
Returns:{sap.landvisz.internal.EntityCustomAction} this
to allow method chaining
setRenderingSize(oRenderingSize): sap.landvisz.internal.EntityCustomAction Setter for property renderingSize
. Default value is sap.landvisz.EntityCSSSize.Regular
Parameters:{sap.landvisz.EntityCSSSize} oRenderingSize new value for property renderingSize
Returns:{sap.landvisz.internal.EntityCustomAction} this
to allow method chaining