Class sap.landvisz.internal.EntityCustomActionModule: sap/landvisz/internal/EntityCustomAction

extends Control

A control to render custom actions of visualization control

Constructor Summary
new sap.landvisz.internal.EntityCustomAction(sId?, mSettings?)Constructor for a new internal/EntityCustomAction.
Event Summary
select(oControlEvent)click on the action bar
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.landvisz.internal.EntityCustomAction.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.landvisz.internal.EntityCustomAction with name sClassName and enriches it with the information contained in oClassInfo.
sap.landvisz.internal.EntityCustomAction.getMetadata()Returns a metadata object for class sap.landvisz.internal.EntityCustomAction.
attachSelect(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'select' event of this sap.landvisz.internal.EntityCustomAction.
detachSelect(fnFunction, oListener)Detach event handler fnFunction from the 'select' event of this sap.landvisz.internal.EntityCustomAction.
fireSelect(mArguments?)Fire event select to attached listeners.
getCustomAction()Getter for property customAction.
getRenderingSize()Getter for property renderingSize.
setCustomAction(sCustomAction)Setter for property customAction.
setRenderingSize(oRenderingSize)Setter for property renderingSize.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.landvisz.internal.EntityCustomAction(sId?, mSettings?)
Constructor for a new 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
  • Aggregations
    • Associations
      • Events
        • select : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
      Parameters:
      {string}sId? id for the new control, generated automatically if no id is given
      {object}mSettings? initial settings for the new control
      Event Detail
      select(oControlEvent)
      click on the action bar
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      Method Detail
      sap.landvisz.internal.EntityCustomAction.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.landvisz.internal.EntityCustomAction with name sClassName and enriches it with the information contained in oClassInfo.

      oClassInfo might contain the same kind of informations as described in Element.extend.

      Parameters:
      {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.
      Returns:
      {function} the created class / constructor function
      sap.landvisz.internal.EntityCustomAction.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.landvisz.internal.EntityCustomAction.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      attachSelect(oData?, fnFunction, oListener?): sap.landvisz.internal.EntityCustomAction
      Attach event handler 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