Class sap.landvisz.internal.ActionBarModule: sap/landvisz/internal/ActionBar

extends Control

A control that render actions of a system

Constructor Summary
new sap.landvisz.internal.ActionBar(sId?, mSettings?)Constructor for a new internal/ActionBar.
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.ActionBar.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.landvisz.internal.ActionBar with name sClassName and enriches it with the information contained in oClassInfo.
sap.landvisz.internal.ActionBar.getMetadata()Returns a metadata object for class sap.landvisz.internal.ActionBar.
addMenu(oMenu)Adds some menu oMenu to the aggregation named menu.
attachSelect(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'select' event of this sap.landvisz.internal.ActionBar.
destroyMenu()Destroys all the menu in the aggregation named menu.
detachSelect(fnFunction, oListener)Detach event handler fnFunction from the 'select' event of this sap.landvisz.internal.ActionBar.
fireSelect(mArguments?)Fire event select to attached listeners.
getActionLabel()Getter for property actionLabel.
getActionTooltip()Getter for property actionTooltip.
getActionType()Getter for property actionType.
getChangeView()Getter for property changeView.
getEnable()Getter for property enable.
getIconSrc()Getter for property iconSrc.
getMenu()Getter for aggregation menu.
getMenuData()Getter for property menuData.
getRenderingSize()Getter for property renderingSize.
getSelectedItem()returns selected menu item object
getSystemId()returns the system ID.
indexOfMenu(oMenu)Checks for the provided sap.ui.commons.Menu in the aggregation named menu and returns its index if found or -1 otherwise.
insertMenu(oMenu, iIndex)Inserts a menu into the aggregation named menu.
removeAllMenu()Removes all the controls in the aggregation named menu.
removeMenu(vMenu)Removes an menu from the aggregation named menu.
setActionLabel(sActionLabel)Setter for property actionLabel.
setActionTooltip(sActionTooltip)Setter for property actionTooltip.
setActionType(oActionType)Setter for property actionType.
setChangeView(bChangeView)Setter for property changeView.
setEnable(bEnable)Setter for property enable.
setIconSrc(sIconSrc)Setter for property iconSrc.
setMenuData(oMenuData)Setter for property menuData.
setRenderingSize(oRenderingSize)Setter for property renderingSize.
setSelectedItemSubAction(oSubAction)sub actions to be added in the recently selected
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.ActionBar(sId?, mSettings?)
Constructor for a new internal/ActionBar.

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
    • menu : sap.ui.commons.Menu[]
  • 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.ActionBar.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.landvisz.internal.ActionBar 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.ActionBar.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.landvisz.internal.ActionBar.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    addMenu(oMenu): sap.landvisz.internal.ActionBar
    Adds some menu oMenu to the aggregation named menu.
    Parameters:
    {sap.ui.commons.Menu}oMenu the menu to add; if empty, nothing is inserted
    Returns:
    {sap.landvisz.internal.ActionBar}this to allow method chaining
    attachSelect(oData?, fnFunction, oListener?): sap.landvisz.internal.ActionBar
    Attach event handler fnFunction to the 'select' event of this sap.landvisz.internal.ActionBar.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.landvisz.internal.ActionBar.
    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.ActionBar.
    itself.
    Returns:
    {sap.landvisz.internal.ActionBar}this to allow method chaining
    destroyMenu(): sap.landvisz.internal.ActionBar
    Destroys all the menu in the aggregation named menu.
    Returns:
    {sap.landvisz.internal.ActionBar}this to allow method chaining
    detachSelect(fnFunction, oListener): sap.landvisz.internal.ActionBar
    Detach event handler fnFunction from the 'select' event of this sap.landvisz.internal.ActionBar.

    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.ActionBar}this to allow method chaining
    fireSelect(mArguments?): sap.landvisz.internal.ActionBar
    Fire event select to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.landvisz.internal.ActionBar}this to allow method chaining
    getActionLabel(): string
    Getter for property actionLabel. label for action

    Default value is empty/undefined

    Returns:
    {string} the value of property actionLabel
    getActionTooltip(): string
    Getter for property actionTooltip. Tooltip for the action

    Default value is empty/undefined

    Returns:
    {string} the value of property actionTooltip
    getActionType(): sap.landvisz.ActionType
    Getter for property actionType. type of the action

    Default value is sap.landvisz.ActionType.NORMAL

    Returns:
    {sap.landvisz.ActionType} the value of property actionType
    getChangeView(): boolean
    Getter for property changeView. new type of view is loaded while performing the action.

    Default value is false

    Returns:
    {boolean} the value of property changeView
    getEnable(): boolean
    Getter for property enable. property to enable/disable actions

    Default value is true

    Returns:
    {boolean} the value of property enable
    getIconSrc(): sap.ui.core.URI
    Getter for property iconSrc. source for the icon rendered

    Default value is empty/undefined

    Returns:
    {sap.ui.core.URI} the value of property iconSrc
    getMenu(): sap.ui.commons.Menu[]
    Getter for aggregation menu.
    aggregation for menu items
    Returns:
    {sap.ui.commons.Menu[]}
    getMenuData(): object
    Getter for property menuData. data of menu items and sub items

    Default value is empty/undefined

    Returns:
    {object} the value of property menuData
    getRenderingSize(): sap.landvisz.EntityCSSSize
    Getter for property renderingSize. Property that determines the size of the entity rendered

    Default value is sap.landvisz.EntityCSSSize.Regular

    Returns:
    {sap.landvisz.EntityCSSSize} the value of property renderingSize
    getSelectedItem(): object
    returns selected menu item object
    Returns:
    {object}
    getSystemId(): string
    returns the system ID.
    Returns:
    {string}
    indexOfMenu(oMenu): int
    Checks for the provided sap.ui.commons.Menu in the aggregation named menu and returns its index if found or -1 otherwise.
    Parameters:
    {sap.ui.commons.Menu}oMenu the menu whose index is looked for.
    Returns:
    {int} the index of the provided control in the aggregation if found, or -1 otherwise
    insertMenu(oMenu, iIndex): sap.landvisz.internal.ActionBar
    Inserts a menu into the aggregation named menu.
    Parameters:
    {sap.ui.commons.Menu}oMenu the menu to insert; if empty, nothing is inserted
    {int}iIndex the 0-based index the menu should be inserted at; for a negative value of iIndex, the menu is inserted at position 0; for a value greater than the current size of the aggregation, the menu is inserted at the last position
    Returns:
    {sap.landvisz.internal.ActionBar}this to allow method chaining
    removeAllMenu(): sap.ui.commons.Menu[]
    Removes all the controls in the aggregation named menu.
    Additionally unregisters them from the hosting UIArea.
    Returns:
    {sap.ui.commons.Menu[]} an array of the removed elements (might be empty)
    removeMenu(vMenu): sap.ui.commons.Menu
    Removes an menu from the aggregation named menu.
    Parameters:
    {int|string|sap.ui.commons.Menu}vMenu the menu to remove or its index or id
    Returns:
    {sap.ui.commons.Menu} the removed menu or null
    setActionLabel(sActionLabel): sap.landvisz.internal.ActionBar
    Setter for property actionLabel.

    Default value is empty/undefined

    Parameters:
    {string}sActionLabel new value for property actionLabel
    Returns:
    {sap.landvisz.internal.ActionBar}this to allow method chaining
    setActionTooltip(sActionTooltip): sap.landvisz.internal.ActionBar
    Setter for property actionTooltip.

    Default value is empty/undefined

    Parameters:
    {string}sActionTooltip new value for property actionTooltip
    Returns:
    {sap.landvisz.internal.ActionBar}this to allow method chaining
    setActionType(oActionType): sap.landvisz.internal.ActionBar
    Setter for property actionType.

    Default value is sap.landvisz.ActionType.NORMAL

    Parameters:
    {sap.landvisz.ActionType}oActionType new value for property actionType
    Returns:
    {sap.landvisz.internal.ActionBar}this to allow method chaining
    setChangeView(bChangeView): sap.landvisz.internal.ActionBar
    Setter for property changeView.

    Default value is false

    Parameters:
    {boolean}bChangeView new value for property changeView
    Returns:
    {sap.landvisz.internal.ActionBar}this to allow method chaining
    setEnable(bEnable): sap.landvisz.internal.ActionBar
    Setter for property enable.

    Default value is true

    Parameters:
    {boolean}bEnable new value for property enable
    Returns:
    {sap.landvisz.internal.ActionBar}this to allow method chaining
    setIconSrc(sIconSrc): sap.landvisz.internal.ActionBar
    Setter for property iconSrc.

    Default value is empty/undefined

    Parameters:
    {sap.ui.core.URI}sIconSrc new value for property iconSrc
    Returns:
    {sap.landvisz.internal.ActionBar}this to allow method chaining
    setMenuData(oMenuData): sap.landvisz.internal.ActionBar
    Setter for property menuData.

    Default value is empty/undefined

    Parameters:
    {object}oMenuData new value for property menuData
    Returns:
    {sap.landvisz.internal.ActionBar}this to allow method chaining
    setRenderingSize(oRenderingSize): sap.landvisz.internal.ActionBar
    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.ActionBar}this to allow method chaining
    setSelectedItemSubAction(oSubAction): void
    sub actions to be added in the recently selected
    Parameters:
    {object}oSubAction sub action of selcted menu item