Class sap.uiext.inbox.InboxModule: sap/uiext/inbox/Inbox

extends Control

A comprehensive UI design approach with graphical and functional elements for search tasks, filter tasks, and take actions on the tasks ("Inbox Pattern").

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

Constructor Summary
new sap.uiext.inbox.Inbox(sId?, mSettings?)Constructor for a new Inbox.
Event Summary
oDataRequestCompleted(oControlEvent)If handleBindings property is set to true , the control assumes an oData model is set and handles the complete logic within.
refresh(oControlEvent)this event is fires to handle refresh Action, when the handleBindings property is set to false.
taskAction(oControlEvent)this event is fires to handle task Actions - Claim, Release, when the handleBindings property is set to false.
taskSelectionChange(oControlEvent)This event is fired when table row selection is changed in the list view of Inbox control
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.Inbox.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uiext.inbox.Inbox with name sClassName and enriches it with the information contained in oClassInfo.
sap.uiext.inbox.Inbox.getMetadata()Returns a metadata object for class sap.uiext.inbox.Inbox.
addAction(sSActionID, sSActionLabel, sSToolTip, oFnActionHandler, bBMassEnabled)Adds an additional action to inbox
attachODataRequestCompleted(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'oDataRequestCompleted' event of this sap.uiext.inbox.Inbox.
attachRefresh(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'refresh' event of this sap.uiext.inbox.Inbox.
attachTaskAction(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'taskAction' event of this sap.uiext.inbox.Inbox.
attachTaskSelectionChange(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'taskSelectionChange' event of this sap.uiext.inbox.Inbox.
bindSearch()Registers a callback function to be invoked to search on the Task Table.
bindTaskExecutionURL(oId, oStatus)Registers a callback function to be invoked to populate the Task Execution PopUp.
bindTasks(sPath, oOFilter, oOSorter)Bind the Inbox Task Collection
bindTaskTable(sPath, oTaskFilters)Binds the Task Table Rows to the given path.
bindTaskTypeDynamicFilter()Registers a callback function to be invoked to populate the TaskType Drill Down.
clearDrillDownFilter()Clears all the filters applied in Drill Down.
clearRowSettings()Row Settings applied using the Settings button shall be cleared.
detachODataRequestCompleted(fnFunction, oListener)Detach event handler fnFunction from the 'oDataRequestCompleted' event of this sap.uiext.inbox.Inbox.
detachRefresh(fnFunction, oListener)Detach event handler fnFunction from the 'refresh' event of this sap.uiext.inbox.Inbox.
detachTaskAction(fnFunction, oListener)Detach event handler fnFunction from the 'taskAction' event of this sap.uiext.inbox.Inbox.
detachTaskSelectionChange(fnFunction, oListener)Detach event handler fnFunction from the 'taskSelectionChange' event of this sap.uiext.inbox.Inbox.
fireODataRequestCompleted(mArguments?)Fire event oDataRequestCompleted to attached listeners.
fireRefresh(mArguments?)Fire event refresh to attached listeners.
fireTaskAction(mArguments?)Fire event taskAction to attached listeners.
fireTaskSelectionChange(mArguments?)Fire event taskSelectionChange to attached listeners.
getHandleBindings()Getter for property handleBindings.
getOpenCompletedTasks()Getter for property openCompletedTasks.
getSubstitutionEnabled()Getter for property isSubstitutionEnabled.
getTaskExecutionURLThemeValue()Getter for property taskExecutionURLThemeValue.
getTaskTableBinding()returns the binding for the Task Table
refresh(aATaskUniqueIdentifiers)Inbox is refreshed if task is completed
setConfiguration(oOConfiguration)Set configuration on Inbox.
setHandleBindings(bHandleBindings)Setter for property handleBindings.
setOpenCompletedTasks(bOpenCompletedTasks)Setter for property openCompletedTasks.
setOpenTaskUIInNewTab()Setter for property bOpenTaskUIInNewTab.
setSubstitutionEnabled(bIsSubstitutionEnabled, sPath)Setter for property isSubstitutionEnabled.
setTaskExecutionURLThemeValue(sTaskExecutionURLThemeValue)Setter for property taskExecutionURLThemeValue.
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.Inbox(sId?, mSettings?)
Constructor for a new Inbox.

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
        • oDataRequestCompleted : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
        • refresh : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
        • taskAction : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
        • taskSelectionChange : 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
      oDataRequestCompleted(oControlEvent)
      If handleBindings property is set to true , the control assumes an oData model is set and handles the complete logic within. In this case once the oData request is complete, this event is fired with additional parameters.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      refresh(oControlEvent)
      this event is fires to handle refresh Action, when the handleBindings property is set to false.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      taskAction(oControlEvent)
      this event is fires to handle task Actions - Claim, Release, when the handleBindings property is set to false.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      taskSelectionChange(oControlEvent)
      This event is fired when table row selection is changed in the list view of Inbox control
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      Method Detail
      sap.uiext.inbox.Inbox.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.uiext.inbox.Inbox 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.Inbox.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.uiext.inbox.Inbox.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      addAction(sSActionID, sSActionLabel, sSToolTip, oFnActionHandler, bBMassEnabled): sap.uiext.inbox.Inbox
      Adds an additional action to inbox
      Parameters:
      {string}sSActionID ID of the new action.
      {string}sSActionLabel The Label Text for the new action.
      {string}sSToolTip Tooltip for the added action.
      {object}oFnActionHandler Function to be called when the action is executed
      {boolean}bBMassEnabled Flag indicating if the action is mass enabled.Default value is true.
      Returns:
      {sap.uiext.inbox.Inbox}
      attachODataRequestCompleted(oData?, fnFunction, oListener?): sap.uiext.inbox.Inbox
      Attach event handler fnFunction to the 'oDataRequestCompleted' event of this sap.uiext.inbox.Inbox.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.uiext.inbox.Inbox.
      itself.

      If handleBindings property is set to true , the control assumes an oData model is set and handles the complete logic within. In this case once the oData request is complete, this event is fired with additional parameters.

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

      this event is fires to handle refresh Action, when the handleBindings property is set to false.

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

      this event is fires to handle task Actions - Claim, Release, when the handleBindings property is set to false.

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

      This event is fired when table row selection is changed in the list view of Inbox control

      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.Inbox.
      itself.
      Returns:
      {sap.uiext.inbox.Inbox}this to allow method chaining
      bindSearch(): sap.uiext.inbox.Inbox
      Registers a callback function to be invoked to search on the Task Table.
      Returns:
      {sap.uiext.inbox.Inbox}
      bindTaskExecutionURL(oId, oStatus): sap.uiext.inbox.Inbox
      Registers a callback function to be invoked to populate the Task Execution PopUp.
      Parameters:
      {object}oId callback function for getting the execution URL, will be supplied with the task ID and should return the URL to be displayed with the Task Execution PopUp.
      {object}oStatus callback function for getting the status of the task, will be supplied with the task ID and should return the Task Status.
      Returns:
      {sap.uiext.inbox.Inbox}
      bindTasks(sPath, oOFilter, oOSorter): sap.uiext.inbox.Inbox
      Bind the Inbox Task Collection
      Parameters:
      {string}sPath Binding path for the element displaying the tasks within the Inbox. This path is the Task Collection according to the TCM (Task Consumption Model)
      {object}oOFilter Predefined filter that is applied to the Task Collection before displaying the tasks in the Inbox. (sap.uiext.inbox.InboxFilters)
      {object}oOSorter {sap.ui.model.Sorter}Predefined sorter that is applied to the Task Collection before displaying the tasks in the Inbox. By default the tasks are sorted on 'CreatedOn' , descending, according to TCM.

      The sorter is not validated for the path being a valid TCM Entity Property. The sorter passed will be applied to the oData service as is. In case the entity Property in the path is a sortable property on the UI, the sorter indicator for that property will be visible.

      Returns:
      {sap.uiext.inbox.Inbox}
      bindTaskTable(sPath, oTaskFilters): sap.uiext.inbox.Inbox
      Binds the Task Table Rows to the given path.
      Parameters:
      {string}sPath Binding path for the rows of the Task Table
      {object}oTaskFilters Predefined filter for the Task Table (sap.uiext.inbox.TaskInitialFilters)
      Returns:
      {sap.uiext.inbox.Inbox}
      bindTaskTypeDynamicFilter(): sap.uiext.inbox.Inbox
      Registers a callback function to be invoked to populate the TaskType Drill Down. This should return the array of Values to be populated in the Task Type Drill Down.
      Returns:
      {sap.uiext.inbox.Inbox}
      clearDrillDownFilter(): void
      Clears all the filters applied in Drill Down. (Status, Priority, Date/Time and TaskType).
      clearRowSettings(): void
      Row Settings applied using the Settings button shall be cleared.
      detachODataRequestCompleted(fnFunction, oListener): sap.uiext.inbox.Inbox
      Detach event handler fnFunction from the 'oDataRequestCompleted' event of this sap.uiext.inbox.Inbox.

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

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

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

      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.Inbox}this to allow method chaining
      fireODataRequestCompleted(mArguments?): sap.uiext.inbox.Inbox
      Fire event oDataRequestCompleted to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.uiext.inbox.Inbox}this to allow method chaining
      fireRefresh(mArguments?): sap.uiext.inbox.Inbox
      Fire event refresh to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.uiext.inbox.Inbox}this to allow method chaining
      fireTaskAction(mArguments?): sap.uiext.inbox.Inbox
      Fire event taskAction to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.uiext.inbox.Inbox}this to allow method chaining
      fireTaskSelectionChange(mArguments?): sap.uiext.inbox.Inbox
      Fire event taskSelectionChange to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.uiext.inbox.Inbox}this to allow method chaining
      getHandleBindings(): boolean
      Getter for property handleBindings. set this as true for oData Model. If set as false, the user will need to handle task Actions, search and Task Execution URL population. See function call back methods.

      Default value is true

      Returns:
      {boolean} the value of property handleBindings
      getOpenCompletedTasks(): boolean
      Getter for property openCompletedTasks. set this to true to enable opening of completed tasks.

      Default value is false

      Returns:
      {boolean} the value of property openCompletedTasks
      getSubstitutionEnabled(): boolean
      Getter for property isSubstitutionEnabled.

      Boolean property to enable the sap.uiext.inbox.SubstitutionRulesManager control (default is false). If is true, 'Manage Substitution Rules' is visible in settings button, else if it is false the option will not be visible under settings.

      Default value is false

      Returns:
      {boolean}
      getTaskExecutionURLThemeValue(): string
      Getter for property taskExecutionURLThemeValue. set the theme URL parameter string to be appended to the task Execution URL. In case of a function callback set for Task Execution PopUp, this string will not be appended.

      Default value is empty/undefined

      Returns:
      {string} the value of property taskExecutionURLThemeValue
      getTaskTableBinding(): object
      returns the binding for the Task Table
      Returns:
      {object}
      refresh(aATaskUniqueIdentifiers): void
      Inbox is refreshed if task is completed
      Parameters:
      {object[]}aATaskUniqueIdentifiers Array of Json objects containing TaskInstanceID and SAP__Origin
      setConfiguration(oOConfiguration): sap.uiext.inbox.Inbox
      Set configuration on Inbox. See APIs in InboxConfiguration
      Parameters:
      {object}oOConfiguration Configuration object to set the configuration on Inbox. See APIs in InboxConfiguration
      Returns:
      {sap.uiext.inbox.Inbox}
      setHandleBindings(bHandleBindings): sap.uiext.inbox.Inbox
      Setter for property handleBindings.

      Default value is true

      Parameters:
      {boolean}bHandleBindings new value for property handleBindings
      Returns:
      {sap.uiext.inbox.Inbox}this to allow method chaining
      setOpenCompletedTasks(bOpenCompletedTasks): sap.uiext.inbox.Inbox
      Setter for property openCompletedTasks.

      Default value is false

      Parameters:
      {boolean}bOpenCompletedTasks new value for property openCompletedTasks
      Returns:
      {sap.uiext.inbox.Inbox}this to allow method chaining
      setOpenTaskUIInNewTab(): void
      Setter for property bOpenTaskUIInNewTab. If set to true, Task UI will opene in a new tab. Default value is false.
      setSubstitutionEnabled(bIsSubstitutionEnabled, sPath): void
      Setter for property isSubstitutionEnabled.

      Boolean property to enable the sap.uiext.inbox.SubstitutionRulesManager control (default is false). If set to true, 'Manage Substitution Rules' is visible in settings button, else if set to false the option will not be visible under settings.

      Default value is false

      Parameters:
      {boolean}bIsSubstitutionEnabled isSubstitutionEnabled
      {string}sPath the path
      setTaskExecutionURLThemeValue(sTaskExecutionURLThemeValue): sap.uiext.inbox.Inbox
      Setter for property taskExecutionURLThemeValue.

      Default value is empty/undefined

      Parameters:
      {string}sTaskExecutionURLThemeValue new value for property taskExecutionURLThemeValue
      Returns:
      {sap.uiext.inbox.Inbox}this to allow method chaining