Class sap.uiext.inbox.InboxLaunchPadModule: sap/uiext/inbox/InboxLaunchPad

extends Control

InboxLaunchPad Documentation to be updated later

Experimental API:Since version 1.7.0. API is not yet finished and might change completely

Constructor Summary
new sap.uiext.inbox.InboxLaunchPad(sId?, mSettings?)Constructor for a new InboxLaunchPad.
Event Summary
logout(oControlEvent)Fired when the user clicks the "Log-off" button.
tileSelected(oControlEvent)Fires an event when a tile is selected in Inbox LaunchPad.
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.uiext.inbox.InboxLaunchPad.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uiext.inbox.InboxLaunchPad with name sClassName and enriches it with the information contained in oClassInfo.
sap.uiext.inbox.InboxLaunchPad.getMetadata()Returns a metadata object for class sap.uiext.inbox.InboxLaunchPad.
attachLogout(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'logout' event of this sap.uiext.inbox.InboxLaunchPad.
attachTileSelected(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'tileSelected' event of this sap.uiext.inbox.InboxLaunchPad.
detachLogout(fnFunction, oListener)Detach event handler fnFunction from the 'logout' event of this sap.uiext.inbox.InboxLaunchPad.
detachTileSelected(fnFunction, oListener)Detach event handler fnFunction from the 'tileSelected' event of this sap.uiext.inbox.InboxLaunchPad.
fireLogout(mArguments?)Fire event logout to attached listeners.
fireTileSelected(mArguments?)Fire event tileSelected to attached listeners.
getLogoSrc()Getter for property logoSrc.
getShowLogoutButton()Getter for property showLogoutButton.
getShowUserName()Getter for property showUserName.
getTitle()Getter for property title.
getUserName()Getter for property userName.
setLogoSrc(sLogoSrc)Setter for property logoSrc.
setShowLogoutButton(bShowLogoutButton)Setter for property showLogoutButton.
setShowUserName(bShowUserName)Setter for property showUserName.
setTitle(sTitle)Setter for property title.
setUserName(sUserName)Setter for property userName.
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.uiext.inbox.InboxLaunchPad(sId?, mSettings?)
Constructor for a new InboxLaunchPad.

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
        • tileSelected : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
        • logout : 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
      logout(oControlEvent)
      Fired when the user clicks the "Log-off" button.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      tileSelected(oControlEvent)
      Fires an event when a tile is selected in Inbox LaunchPad.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      Method Detail
      sap.uiext.inbox.InboxLaunchPad.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.uiext.inbox.InboxLaunchPad 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.uiext.inbox.InboxLaunchPad.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.uiext.inbox.InboxLaunchPad.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      attachLogout(oData?, fnFunction, oListener?): sap.uiext.inbox.InboxLaunchPad
      Attach event handler fnFunction to the 'logout' event of this sap.uiext.inbox.InboxLaunchPad.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.uiext.inbox.InboxLaunchPad.
      itself.

      Fired when the user clicks the "Log-off" button.

      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.uiext.inbox.InboxLaunchPad.
      itself.
      Returns:
      {sap.uiext.inbox.InboxLaunchPad}this to allow method chaining
      attachTileSelected(oData?, fnFunction, oListener?): sap.uiext.inbox.InboxLaunchPad
      Attach event handler fnFunction to the 'tileSelected' event of this sap.uiext.inbox.InboxLaunchPad.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.uiext.inbox.InboxLaunchPad.
      itself.

      Fires an event when a tile is selected in Inbox LaunchPad.

      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.uiext.inbox.InboxLaunchPad.
      itself.
      Returns:
      {sap.uiext.inbox.InboxLaunchPad}this to allow method chaining
      detachLogout(fnFunction, oListener): sap.uiext.inbox.InboxLaunchPad
      Detach event handler fnFunction from the 'logout' event of this sap.uiext.inbox.InboxLaunchPad.

      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.uiext.inbox.InboxLaunchPad}this to allow method chaining
      detachTileSelected(fnFunction, oListener): sap.uiext.inbox.InboxLaunchPad
      Detach event handler fnFunction from the 'tileSelected' event of this sap.uiext.inbox.InboxLaunchPad.

      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.uiext.inbox.InboxLaunchPad}this to allow method chaining
      fireLogout(mArguments?): sap.uiext.inbox.InboxLaunchPad
      Fire event logout to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.uiext.inbox.InboxLaunchPad}this to allow method chaining
      fireTileSelected(mArguments?): sap.uiext.inbox.InboxLaunchPad
      Fire event tileSelected to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.uiext.inbox.InboxLaunchPad}this to allow method chaining
      getLogoSrc(): string
      Getter for property logoSrc. Path (src) to the logo icon to be displayed in the Inbox LaunchPad header.

      Default value is empty/undefined

      Returns:
      {string} the value of property logoSrc
      getShowLogoutButton(): boolean
      Getter for property showLogoutButton. Property to indicate whether the Logoff button in the header should be displayed or not. Default value is true.

      Default value is true

      Returns:
      {boolean} the value of property showLogoutButton
      getShowUserName(): boolean
      Getter for property showUserName. Property to indicate whether loggod on User's Name in the header should be displayed or not. Default value is true.

      Default value is true

      Returns:
      {boolean} the value of property showUserName
      getTitle(): string
      Getter for property title. The title text appearing in Inbox LaunchPad header bar.

      Default value is Inbox Launch Pad Title

      Returns:
      {string} the value of property title
      getUserName(): string
      Getter for property userName. User name to be shown in the header.

      Default value is empty/undefined

      Returns:
      {string} the value of property userName
      setLogoSrc(sLogoSrc): sap.uiext.inbox.InboxLaunchPad
      Setter for property logoSrc.

      Default value is empty/undefined

      Parameters:
      {string}sLogoSrc new value for property logoSrc
      Returns:
      {sap.uiext.inbox.InboxLaunchPad}this to allow method chaining
      setShowLogoutButton(bShowLogoutButton): sap.uiext.inbox.InboxLaunchPad
      Setter for property showLogoutButton.

      Default value is true

      Parameters:
      {boolean}bShowLogoutButton new value for property showLogoutButton
      Returns:
      {sap.uiext.inbox.InboxLaunchPad}this to allow method chaining
      setShowUserName(bShowUserName): sap.uiext.inbox.InboxLaunchPad
      Setter for property showUserName.

      Default value is true

      Parameters:
      {boolean}bShowUserName new value for property showUserName
      Returns:
      {sap.uiext.inbox.InboxLaunchPad}this to allow method chaining
      setTitle(sTitle): sap.uiext.inbox.InboxLaunchPad
      Setter for property title.

      Default value is Inbox Launch Pad Title

      Parameters:
      {string}sTitle new value for property title
      Returns:
      {sap.uiext.inbox.InboxLaunchPad}this to allow method chaining
      setUserName(sUserName): sap.uiext.inbox.InboxLaunchPad
      Setter for property userName.

      Default value is empty/undefined

      Parameters:
      {string}sUserName new value for property userName
      Returns:
      {sap.uiext.inbox.InboxLaunchPad}this to allow method chaining