Class sap.uiext.inbox.InboxSplitAppModule: sap/uiext/inbox/InboxSplitApp

extends Control

Inbox Split App

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

Constructor Summary
new sap.uiext.inbox.InboxSplitApp(sId?, mSettings?)Constructor for a new InboxSplitApp.
Event Summary
navButtonPressed(oControlEvent)Navigation Button of the Master Page is pressed, if visible.
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.InboxSplitApp.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uiext.inbox.InboxSplitApp with name sClassName and enriches it with the information contained in oClassInfo.
sap.uiext.inbox.InboxSplitApp.getMetadata()Returns a metadata object for class sap.uiext.inbox.InboxSplitApp.
attachNavButtonPressed(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'navButtonPressed' event of this sap.uiext.inbox.InboxSplitApp.
bindTasks(aAFilters)Call this method to display data in the InboxSplitApp
destroySplitAppl()Destroys the splitAppl in the aggregation named splitAppl.
detachNavButtonPressed(fnFunction, oListener)Detach event handler fnFunction from the 'navButtonPressed' event of this sap.uiext.inbox.InboxSplitApp.
fireNavButtonPressed(mArguments?)Fire event navButtonPressed to attached listeners.
getFilters()Getter for property filters.
getShowMasterPageNavBtn()Getter for property showMasterPageNavBtn.
getSplitAppl()Getter for aggregation splitAppl.
getTcmConfiguration()Getter for property tcmConfiguration.
getTcmServiceURL()Getter for property tcmServiceURL.
resetSearchCriteria()Call this method to reset the search criteria.
setFilters(aFilters)Setter for property filters.
setShowMasterPageNavBtn(bShowMasterPageNavBtn)Setter for property showMasterPageNavBtn.
setSplitAppl(oSplitAppl)Setter for the aggregated splitAppl.
setTcmConfiguration(oTcmConfiguration)Setter for property tcmConfiguration.
setTcmServiceURL(sTcmServiceURL)Setter for property tcmServiceURL.
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.InboxSplitApp(sId?, mSettings?)
Constructor for a new InboxSplitApp.

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:

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
navButtonPressed(oControlEvent)
Navigation Button of the Master Page is pressed, if visible.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.uiext.inbox.InboxSplitApp.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.uiext.inbox.InboxSplitApp 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.InboxSplitApp.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uiext.inbox.InboxSplitApp.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachNavButtonPressed(oData?, fnFunction, oListener?): sap.uiext.inbox.InboxSplitApp
Attach event handler fnFunction to the 'navButtonPressed' event of this sap.uiext.inbox.InboxSplitApp.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.uiext.inbox.InboxSplitApp.
itself.

Navigation Button of the Master Page is pressed, if visible.

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.InboxSplitApp.
itself.
Returns:
{sap.uiext.inbox.InboxSplitApp}this to allow method chaining
bindTasks(aAFilters): sap.uiext.inbox.InboxSplitApp
Call this method to display data in the InboxSplitApp
Parameters:
{object[]}aAFilters
Returns:
{sap.uiext.inbox.InboxSplitApp}
destroySplitAppl(): sap.uiext.inbox.InboxSplitApp
Destroys the splitAppl in the aggregation named splitAppl.
Returns:
{sap.uiext.inbox.InboxSplitApp}this to allow method chaining
detachNavButtonPressed(fnFunction, oListener): sap.uiext.inbox.InboxSplitApp
Detach event handler fnFunction from the 'navButtonPressed' event of this sap.uiext.inbox.InboxSplitApp.

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.InboxSplitApp}this to allow method chaining
fireNavButtonPressed(mArguments?): sap.uiext.inbox.InboxSplitApp
Fire event navButtonPressed to attached listeners.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Returns:
{sap.uiext.inbox.InboxSplitApp}this to allow method chaining
getFilters(): object[]
Getter for property filters. Filters to be applied on the data shown in the MasterPage

Default value is empty/undefined

Returns:
{object[]} the value of property filters
getShowMasterPageNavBtn(): boolean
Getter for property showMasterPageNavBtn. Show/Hide the Navigation Button for the Master Page

Default value is empty/undefined

Returns:
{boolean} the value of property showMasterPageNavBtn
getSplitAppl(): sap.m.SplitApp
Getter for aggregation splitAppl.
This is the splitApp that is created inside the control
Returns:
{sap.m.SplitApp}
getTcmConfiguration(): object
Getter for property tcmConfiguration. TCM Configuration object for control initialization.

Default value is empty/undefined

Returns:
{object} the value of property tcmConfiguration
getTcmServiceURL(): string
Getter for property tcmServiceURL. TCM service URL

Default value is empty/undefined

Returns:
{string} the value of property tcmServiceURL
resetSearchCriteria(): sap.uiext.inbox.InboxSplitApp
Call this method to reset the search criteria.
Returns:
{sap.uiext.inbox.InboxSplitApp}
setFilters(aFilters): sap.uiext.inbox.InboxSplitApp
Setter for property filters.

Default value is empty/undefined

Parameters:
{object[]}aFilters new value for property filters
Returns:
{sap.uiext.inbox.InboxSplitApp}this to allow method chaining
setShowMasterPageNavBtn(bShowMasterPageNavBtn): sap.uiext.inbox.InboxSplitApp
Setter for property showMasterPageNavBtn.

Default value is empty/undefined

Parameters:
{boolean}bShowMasterPageNavBtn new value for property showMasterPageNavBtn
Returns:
{sap.uiext.inbox.InboxSplitApp}this to allow method chaining
setSplitAppl(oSplitAppl): sap.uiext.inbox.InboxSplitApp
Setter for the aggregated splitAppl.
Parameters:
{sap.m.SplitApp}oSplitAppl
Returns:
{sap.uiext.inbox.InboxSplitApp}this to allow method chaining
setTcmConfiguration(oTcmConfiguration): sap.uiext.inbox.InboxSplitApp
Setter for property tcmConfiguration.

Default value is empty/undefined

Parameters:
{object}oTcmConfiguration new value for property tcmConfiguration
Returns:
{sap.uiext.inbox.InboxSplitApp}this to allow method chaining
setTcmServiceURL(sTcmServiceURL): sap.uiext.inbox.InboxSplitApp
Setter for property tcmServiceURL.

Default value is empty/undefined

Parameters:
{string}sTcmServiceURL new value for property tcmServiceURL
Returns:
{sap.uiext.inbox.InboxSplitApp}this to allow method chaining