Class sap.m.SplitContainerModule: sap/m/SplitContainer

extends Control
known direct subclasses: SplitApp

SplitContainer maintains two NavContainers if running on tablet or desktop and one NavContainer - on phone. The display of the master NavContainer depends on the portrait/landscape mode of the device and the mode of SplitContainer.

NOTE: This control must be rendered as a full screen control in order to make the show/hide master area work properly.

Constructor Summary
new sap.m.SplitContainer(sId?, mSettings?)Constructor for a new SplitContainer.
Event Summary
afterDetailNavigate(oControlEvent)Fires when navigation between two pages in detail area has completed.
afterMasterClose(oControlEvent)Fires when the master area is fully closed after the animation (if any).
afterMasterNavigate(oControlEvent)Fires when navigation between two pages in master area has completed.
afterMasterOpen(oControlEvent)Fires when the master area is fully opened after animation if any.
beforeMasterClose(oControlEvent)Fires before the master area is closed.
beforeMasterOpen(oControlEvent)Fires before the master area is opened.
detailNavigate(oControlEvent)Fires when navigation between two pages in detail area has been triggered.
masterButton(oControlEvent)Fires when a Master Button needs to be shown or hidden.
masterNavigate(oControlEvent)Fires when navigation between two pages in master area has been triggered.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.SplitContainer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.SplitContainer with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.SplitContainer.getMetadata()Returns a metadata object for class sap.m.SplitContainer.
addDetailPage(oDetailPage)Adds some detailPage to the aggregation detailPages.
addMasterPage(oMasterPage)Adds some masterPage to the aggregation masterPages.
addPage(oPage, bMaster)Adds a content entity either to master area or detail area depending on the master parameter.
attachAfterDetailNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterDetailNavigate event of this sap.m.SplitContainer.
attachAfterMasterClose(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterMasterClose event of this sap.m.SplitContainer.
attachAfterMasterNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterMasterNavigate event of this sap.m.SplitContainer.
attachAfterMasterOpen(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterMasterOpen event of this sap.m.SplitContainer.
attachBeforeMasterClose(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the beforeMasterClose event of this sap.m.SplitContainer.
attachBeforeMasterOpen(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the beforeMasterOpen event of this sap.m.SplitContainer.
attachDetailNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the detailNavigate event of this sap.m.SplitContainer.
attachMasterButton(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the masterButton event of this sap.m.SplitContainer.
attachMasterNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the masterNavigate event of this sap.m.SplitContainer.
backDetail(oBackData, oTransitionParameter)Navigates back to the previous detail page found in the history.
backMaster(oBackData, oTransitionParameter)Navigates back to the previous master page which is found in the history.
backToPage(sPageId, oBackData, oTransitionParameters)Navigates back to the nearest previous page in the SplitContainer history with the given ID (if there is no such page among the previous pages, nothing happens).
backToTopDetail(oBackData, oTransitionParameter)Navigates back to the initial/top level of Detail (this is the element aggregated as initialPage, or the first added element).
backToTopMaster(oBackData, oTransitionParameter)Navigates back to the initial/top level of Master (this is the element aggregated as "initialPage", or the first added element).
destroyDetailPages()Destroys all the detailPages in the aggregation detailPages.
destroyMasterPages()Destroys all the masterPages in the aggregation masterPages.
detachAfterDetailNavigate(fnFunction, oListener)Detaches event handler fnFunction from the afterDetailNavigate event of this sap.m.SplitContainer.
detachAfterMasterClose(fnFunction, oListener)Detaches event handler fnFunction from the afterMasterClose event of this sap.m.SplitContainer.
detachAfterMasterNavigate(fnFunction, oListener)Detaches event handler fnFunction from the afterMasterNavigate event of this sap.m.SplitContainer.
detachAfterMasterOpen(fnFunction, oListener)Detaches event handler fnFunction from the afterMasterOpen event of this sap.m.SplitContainer.
detachBeforeMasterClose(fnFunction, oListener)Detaches event handler fnFunction from the beforeMasterClose event of this sap.m.SplitContainer.
detachBeforeMasterOpen(fnFunction, oListener)Detaches event handler fnFunction from the beforeMasterOpen event of this sap.m.SplitContainer.
detachDetailNavigate(fnFunction, oListener)Detaches event handler fnFunction from the detailNavigate event of this sap.m.SplitContainer.
detachMasterButton(fnFunction, oListener)Detaches event handler fnFunction from the masterButton event of this sap.m.SplitContainer.
detachMasterNavigate(fnFunction, oListener)Detaches event handler fnFunction from the masterNavigate event of this sap.m.SplitContainer.
fireAfterDetailNavigate(mParameters?)Fires event afterDetailNavigate to attached listeners.
fireAfterMasterClose(mParameters?)Fires event afterMasterClose to attached listeners.
fireAfterMasterNavigate(mParameters?)Fires event afterMasterNavigate to attached listeners.
fireAfterMasterOpen(mParameters?)Fires event afterMasterOpen to attached listeners.
fireBeforeMasterClose(mParameters?)Fires event beforeMasterClose to attached listeners.
fireBeforeMasterOpen(mParameters?)Fires event beforeMasterOpen to attached listeners.
fireDetailNavigate(mParameters?)Fires event detailNavigate to attached listeners.
fireMasterButton(mParameters?)Fires event masterButton to attached listeners.
fireMasterNavigate(mParameters?)Fires event masterNavigate to attached listeners.
getBackgroundColor()Gets current value of property backgroundColor.
getBackgroundImage()Gets current value of property backgroundImage.
getBackgroundOpacity()Gets current value of property backgroundOpacity.
getBackgroundRepeat()Gets current value of property backgroundRepeat.
getCurrentDetailPage()Returns the current displayed detail page.
getCurrentMasterPage()Returns the current displayed master page.
getCurrentPage(bMaster)Returns the currently displayed page either in master area or in detail area.
getDetailPage(sId)Returns the page with the given ID in detail area.
getDetailPages()Gets content of aggregation detailPages.
getInitialDetail()ID of the element which is the current target of the association initialDetail, or null.
getInitialMaster()ID of the element which is the current target of the association initialMaster, or null.
getMasterButtonText()Gets current value of property masterButtonText.
getMasterButtonTooltip()Gets current value of property masterButtonTooltip.
getMasterPage(sId)Returns the page with the given ID in master area (if there's no page that has the given ID, null is returned).
getMasterPages()Gets content of aggregation masterPages.
getMode()Gets current value of property mode.
getPage(sId, bMaster)Returns the page with the given ID from either master area, or detail area depending on the master parameter (if there's no page that has the given ID, null is returned).
getPreviousPage(bMaster)Returns the previous page (the page, from which the user drilled down to the current page with to()).
hideMaster()Used to hide the master page when in ShowHideMode and the device is in portrait mode.
indexOfDetailPage(oDetailPage)Checks for the provided sap.ui.core.Control in the aggregation detailPages.
indexOfMasterPage(oMasterPage)Checks for the provided sap.ui.core.Control in the aggregation masterPages.
insertDetailPage(oDetailPage, iIndex)Inserts a detailPage into the aggregation detailPages.
insertMasterPage(oMasterPage, iIndex)Inserts a masterPage into the aggregation masterPages.
insertPreviousPage(sPageId, sTransitionName, oData)Inserts the page/control with the specified ID into the navigation history stack of the NavContainer.
isMasterShown()Returns whether master area is currently displayed on the screen.
removeAllDetailPages()Removes all the controls from the aggregation detailPages.
removeAllMasterPages()Removes all the controls from the aggregation masterPages.
removeDetailPage(vDetailPage)Removes a detailPage from the aggregation detailPages.
removeMasterPage(vMasterPage)Removes a masterPage from the aggregation masterPages.
setBackgroundColor(sBackgroundColor)Sets a new value for property backgroundColor.
setBackgroundImage(sBackgroundImage)Sets a new value for property backgroundImage.
setBackgroundOpacity(fBackgroundOpacity)Sets a new value for property backgroundOpacity.
setBackgroundRepeat(bBackgroundRepeat)Sets a new value for property backgroundRepeat.
setDefaultTransitionNameDetail(sDefaultTransitionNameDetail)Sets a new value for property defaultTransitionNameDetail.
setDefaultTransitionNameMaster(sDefaultTransitionNameMaster)Sets a new value for property defaultTransitionNameMaster.
setInitialDetail(oInitialDetail)Sets the associated initialDetail.
setInitialMaster(oInitialMaster)Sets the associated initialMaster.
setMasterButtonText(sMasterButtonText)Sets a new value for property masterButtonText.
setMasterButtonTooltip(sMasterButtonTooltip)Sets a new value for property masterButtonTooltip.
setMode(sMode)Sets a new value for property mode.
showMaster()Used to make the master page visible when in ShowHideMode and the device is in portrait mode.
to(sPageId, sTransitionName, oData, oTransitionParameters)Navigates to the given page inside the SplitContainer.
toDetail(sPageId, sTransitionName, oData, oTransitionParameter)Navigates to a given detail page.
toMaster(sPageId, sTransitionName, oData, oTransitionParameters)Navigates to a given master page.
Constructor Detail
new sap.m.SplitContainer(sId?, mSettings?)

Constructor for a new SplitContainer.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?ID for the new control, generated automatically if no ID is given
objectmSettings?Initial settings for the new control
Event Detail
afterDetailNavigate(oControlEvent)
Fires when navigation between two pages in detail area has completed. NOTE: In case of animated transitions this event is fired with some delay after the "navigate" event.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.core.ControloControlEvent.getParameters.fromThe page, which had been displayed before navigation.
stringoControlEvent.getParameters.fromIdThe ID of the page, which had been displayed before navigation.
sap.ui.core.ControloControlEvent.getParameters.toThe page, which is now displayed after navigation.
stringoControlEvent.getParameters.toIdThe ID of the page, which is now displayed after navigation.
booleanoControlEvent.getParameters.firstTimeDetermines whether the "to" page (more precisely: a control with the ID of the page, which has been navigated to) has not been displayed/navigated to before.
booleanoControlEvent.getParameters.isToDetermines whether was a forward navigation, triggered by to().
booleanoControlEvent.getParameters.isBackDetermines whether this was a back navigation, triggered by back().
booleanoControlEvent.getParameters.isBackToTopDetermines whether this was a navigation to the root page, triggered by backToTop().
booleanoControlEvent.getParameters.isBackToPageDetermines whether this was a navigation to a specific page, triggered by backToPage().
stringoControlEvent.getParameters.directionDetermines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".
afterMasterClose(oControlEvent)
Fires when the master area is fully closed after the animation (if any).
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
afterMasterNavigate(oControlEvent)
Fires when navigation between two pages in master area has completed. NOTE: In case of animated transitions this event is fired with some delay after the navigate event.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.core.ControloControlEvent.getParameters.fromThe page, which had been displayed before navigation.
stringoControlEvent.getParameters.fromIdThe ID of the page, which had been displayed before navigation.
sap.ui.core.ControloControlEvent.getParameters.toThe page, which is now displayed after navigation.
stringoControlEvent.getParameters.toIdThe ID of the page, which is now displayed after navigation.
booleanoControlEvent.getParameters.firstTimeWhether the "to" page (more precisely: a control with the ID of the page, which has been navigated to) has not been displayed/navigated to before.
booleanoControlEvent.getParameters.isToDetermines whether was a forward navigation, triggered by to().
booleanoControlEvent.getParameters.isBackDetermines whether this was a back navigation, triggered by back().
booleanoControlEvent.getParameters.isBackToTopDetermines whether this was a navigation to the root page, triggered by backToTop().
booleanoControlEvent.getParameters.isBackToPageDetermines whether this was a navigation to a specific page, triggered by backToPage().
stringoControlEvent.getParameters.directionDetermines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".
afterMasterOpen(oControlEvent)
Fires when the master area is fully opened after animation if any.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
beforeMasterClose(oControlEvent)
Fires before the master area is closed.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
beforeMasterOpen(oControlEvent)
Fires before the master area is opened.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
detailNavigate(oControlEvent)
Fires when navigation between two pages in detail area has been triggered. The transition (if any) to the new page has not started yet. NOTE: This event can be aborted by the application with preventDefault(), which means that there will be no navigation.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.core.ControloControlEvent.getParameters.fromThe page, which was displayed before the current navigation.
stringoControlEvent.getParameters.fromIdThe ID of the page, which was displayed before the current navigation.
sap.ui.core.ControloControlEvent.getParameters.toThe page, which will be displayed after the current navigation.
stringoControlEvent.getParameters.toIdThe ID of the page, which will be displayed after the current navigation.
booleanoControlEvent.getParameters.firstTimeDetermines whether the "to" page (more precisely: a control with the ID of the page, which is currently navigated to) has not been displayed/navigated to before.
booleanoControlEvent.getParameters.isToDetermines whether this is a forward navigation, triggered by to().
booleanoControlEvent.getParameters.isBackDetermines whether this is a back navigation, triggered by back().
booleanoControlEvent.getParameters.isBackToTopDetermines whether this is a navigation to the root page, triggered by backToTop().
booleanoControlEvent.getParameters.isBackToPageDetermines whether this was a navigation to a specific page, triggered by backToPage().
stringoControlEvent.getParameters.directionDetermines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".
masterButton(oControlEvent)
Fires when a Master Button needs to be shown or hidden. This is necessary for custom headers when the SplitContainer control does not handle the placement of the master button automatically.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
masterNavigate(oControlEvent)
Fires when navigation between two pages in master area has been triggered. The transition (if any) to the new page has not started yet. This event can be aborted by the application with preventDefault(), which means that there will be no navigation.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.core.ControloControlEvent.getParameters.fromThe page, which was displayed before the current navigation.
stringoControlEvent.getParameters.fromIdThe ID of the page, which was displayed before the current navigation.
sap.ui.core.ControloControlEvent.getParameters.toThe page, which will be displayed after the current navigation.
stringoControlEvent.getParameters.toIdThe ID of the page, which will be displayed after the current navigation.
booleanoControlEvent.getParameters.firstTimeDetermines whether the "to" page (more precisely: a control with the ID of the page, which is currently being navigated to) has not been displayed/navigated to before.
booleanoControlEvent.getParameters.isToDetermines whether this is a forward navigation, triggered by to().
booleanoControlEvent.getParameters.isBackDetermines whether this is a back navigation, triggered by back().
booleanoControlEvent.getParameters.isBackToTopDetermines whether this is a navigation to the root page, triggered by backToTop().
booleanoControlEvent.getParameters.isBackToPageDetermines whether this was a navigation to a specific page, triggered by backToPage().
stringoControlEvent.getParameters.directionDetermines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".
Method Detail
sap.m.SplitContainer.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.m.SplitContainer with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.m.SplitContainer.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.SplitContainer.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addDetailPage(oDetailPage): sap.m.SplitContainer
Adds some detailPage to the aggregation detailPages.
Parameters:
sap.ui.core.ControloDetailPagethe detailPage to add; if empty, nothing is inserted
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
addMasterPage(oMasterPage): sap.m.SplitContainer
Adds some masterPage to the aggregation masterPages.
Parameters:
sap.ui.core.ControloMasterPagethe masterPage to add; if empty, nothing is inserted
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
addPage(oPage, bMaster): sap.m.SplitContainer

Adds a content entity either to master area or detail area depending on the master parameter.

The method is provided mainly for providing API consistency between sap.m.SplitContainer and sap.m.App. So that the same code line can be reused.

Parameters:
sap.ui.core.ControloPageThe content entities between which this SplitContainer navigates in either master area or detail area depending on the master parameter. These can be of type sap.m.Page, sap.ui.core.View, sap.m.Carousel or any other control with fullscreen/page semantics.
booleanbMasterStates if the page should be added to the master area. If it's set to false, the page is added to detail area.
Returns:
sap.m.SplitContainer
Since:
1.11.1
attachAfterDetailNavigate(oData?, fnFunction, oListener?): sap.m.SplitContainer

Attaches event handler fnFunction to the afterDetailNavigate event of this sap.m.SplitContainer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.SplitContainer itself.

Fires when navigation between two pages in detail area has completed. NOTE: In case of animated transitions this event is fired with some delay after the "navigate" event.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.SplitContainer itself
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
attachAfterMasterClose(oData?, fnFunction, oListener?): sap.m.SplitContainer

Attaches event handler fnFunction to the afterMasterClose event of this sap.m.SplitContainer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.SplitContainer itself.

Fires when the master area is fully closed after the animation (if any).

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.SplitContainer itself
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
attachAfterMasterNavigate(oData?, fnFunction, oListener?): sap.m.SplitContainer

Attaches event handler fnFunction to the afterMasterNavigate event of this sap.m.SplitContainer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.SplitContainer itself.

Fires when navigation between two pages in master area has completed. NOTE: In case of animated transitions this event is fired with some delay after the navigate event.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.SplitContainer itself
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
attachAfterMasterOpen(oData?, fnFunction, oListener?): sap.m.SplitContainer

Attaches event handler fnFunction to the afterMasterOpen event of this sap.m.SplitContainer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.SplitContainer itself.

Fires when the master area is fully opened after animation if any.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.SplitContainer itself
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
attachBeforeMasterClose(oData?, fnFunction, oListener?): sap.m.SplitContainer

Attaches event handler fnFunction to the beforeMasterClose event of this sap.m.SplitContainer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.SplitContainer itself.

Fires before the master area is closed.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.SplitContainer itself
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
attachBeforeMasterOpen(oData?, fnFunction, oListener?): sap.m.SplitContainer

Attaches event handler fnFunction to the beforeMasterOpen event of this sap.m.SplitContainer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.SplitContainer itself.

Fires before the master area is opened.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.SplitContainer itself
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
attachDetailNavigate(oData?, fnFunction, oListener?): sap.m.SplitContainer

Attaches event handler fnFunction to the detailNavigate event of this sap.m.SplitContainer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.SplitContainer itself.

Fires when navigation between two pages in detail area has been triggered. The transition (if any) to the new page has not started yet. NOTE: This event can be aborted by the application with preventDefault(), which means that there will be no navigation.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.SplitContainer itself
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
attachMasterButton(oData?, fnFunction, oListener?): sap.m.SplitContainer

Attaches event handler fnFunction to the masterButton event of this sap.m.SplitContainer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.SplitContainer itself.

Fires when a Master Button needs to be shown or hidden. This is necessary for custom headers when the SplitContainer control does not handle the placement of the master button automatically.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.SplitContainer itself
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
attachMasterNavigate(oData?, fnFunction, oListener?): sap.m.SplitContainer

Attaches event handler fnFunction to the masterNavigate event of this sap.m.SplitContainer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.SplitContainer itself.

Fires when navigation between two pages in master area has been triggered. The transition (if any) to the new page has not started yet. This event can be aborted by the application with preventDefault(), which means that there will be no navigation.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.SplitContainer itself
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
backDetail(oBackData, oTransitionParameter): sap.m.SplitContainer
Navigates back to the previous detail page found in the history.
Parameters:
objectoBackData

This optional object can carry any payload data which should be made available to the target page of the back navigation. The event on the target page will contain this data object as backData property. (The original data from the to() navigation will still be available as data property.)

In scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. For back navigation this can be used, for example, when returning from a detail page to transfer any settings done there.

When the transitionParameters object is used, this data object must also be given (either as object or as null) in order to have a proper parameter order.

objectoTransitionParameter

This optional object can give additional information to the transition function, like the DOM element, which triggered the transition or the desired transition duration. The animation type can NOT be selected here - it is always the inverse of the "to" navigation.

In order to use the transitionParameters property, the data property must be used (at least "null" must be given) for a proper parameter order.

NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition.

Returns:
sap.m.SplitContainer
backMaster(oBackData, oTransitionParameter): sap.m.SplitContainer
Navigates back to the previous master page which is found in the history.
Parameters:
objectoBackData

This optional object can carry any payload data which should be made available to the target page of the back navigation. The event on the target page will contain this data object as backData property (the original data from the to() navigation will still be available as data property).

In scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. For back navigation this can be used, for example, when returning from a detail page to transfer any settings done there.

When the transitionParameters object is used, this data object must also be given (either as object or as null) in order to have a proper parameter order.

objectoTransitionParameter

This optional object can give additional information to the transition function, like the DOM element, which triggered the transition or the desired transition duration. The animation type can NOT be selected here - it is always the inverse of the "to" navigation.

In order to use the transitionParameters property, the data property must be used (at least "null" must be given) for a proper parameter order.

NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition.

Returns:
sap.m.SplitContainer
backToPage(sPageId, oBackData, oTransitionParameters): sap.m.SplitContainer

Navigates back to the nearest previous page in the SplitContainer history with the given ID (if there is no such page among the previous pages, nothing happens). The transition effect, which had been used to get to the current page is inverted and used for this navigation.

Calling this navigation method, first triggers the (cancelable) navigate event on the SplitContainer, then the beforeHide pseudo event on the source page, beforeFirstShow (if applicable), and beforeShow on the target page. Later, after the transition has completed, the afterShow pseudo event is triggered on the target page and afterHide - on the page, which has been left. The given backData object is available in the beforeFirstShow, beforeShow, and afterShow event objects as data property. The original "data" object from the "to" navigation is also available in these event objects.

Parameters:
stringsPageIdThe screen to which is being navigated to. The ID or the control itself can be given.
objectoBackData

This optional object can carry any payload data which should be made available to the target page of the back navigation. The event on the target page will contain this data object as backData property. (the original data from the to() navigation will still be available as data property).

In scenarios, where the entity triggering the navigation can't or shouldn't directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. For back navigation this can be used, for example, when returning from a detail page to transfer any settings done there.

When the transitionParameters object is used, this data object must also be given (either as object or as null) in order to have a proper parameter order.

objectoTransitionParameters

This optional object can give additional information to the transition function, like the DOM element, which triggered the transition or the desired transition duration. The animation type can NOT be selected here - it is always the inverse of the "to" navigation.

In order to use the transitionParameters property, the data property must be used (at least "null" must be given) for a proper parameter order.

NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition.

Returns:
sap.m.SplitContainer
Since:
1.10.0
backToTopDetail(oBackData, oTransitionParameter): sap.ui.core.Control
Navigates back to the initial/top level of Detail (this is the element aggregated as initialPage, or the first added element). NOTE: If already on the initial page, nothing happens. The transition effect which had been used to get to the current page is inverted and used for this navigation.
Parameters:
objectoBackData

This optional object can carry any payload data which should be made available to the target page of the back navigation. The event on the target page will contain this data object as backData property (the original data from the to() navigation will still be available as data property).

In scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. For back navigation this can be used, for example, when returning from a detail page to transfer any settings done there.

When the transitionParameters object is used, this data object must also be given (either as object or as null) in order to have a proper parameter order.

objectoTransitionParameter

This optional object can give additional information to the transition function, like the DOM element, which triggered the transition or the desired transition duration. The animation type can NOT be selected here - it is always the inverse of the "to" navigation.

In order to use the transitionParameters property, the data property must be used (at least "null" must be given) for a proper parameter order.

NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition.

Returns:
sap.ui.core.Control
backToTopMaster(oBackData, oTransitionParameter): sap.ui.core.Control
Navigates back to the initial/top level of Master (this is the element aggregated as "initialPage", or the first added element). NOTE: If already on the initial page, nothing happens. The transition effect which had been used to get to the current page is inverted and used for this navigation.
Parameters:
objectoBackData

This optional object can carry any payload data which should be made available to the target page of the back navigation. The event on the target page will contain this data object as "backData" property. (The original data from the "to()" navigation will still be available as "data" property.)

In scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data. For back navigation this can be used e.g. when returning from a detail page to transfer any settings done there.

When the "transitionParameters" object is used, this "data" object must also be given (either as object or as null) in order to have a proper parameter order.

objectoTransitionParameter

This optional object can give additional information to the transition function, like the DOM element which triggered the transition or the desired transition duration. The animation type can NOT be selected here - it is always the inverse of the "to" navigation.

In order to use the transitionParameters property, the data property must be used (at least "null" must be given) for a proper parameter order.

NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition.

Returns:
sap.ui.core.Control
destroyDetailPages(): sap.m.SplitContainer
Destroys all the detailPages in the aggregation detailPages.
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
destroyMasterPages(): sap.m.SplitContainer
Destroys all the masterPages in the aggregation masterPages.
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
detachAfterDetailNavigate(fnFunction, oListener): sap.m.SplitContainer

Detaches event handler fnFunction from the afterDetailNavigate event of this sap.m.SplitContainer.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
detachAfterMasterClose(fnFunction, oListener): sap.m.SplitContainer

Detaches event handler fnFunction from the afterMasterClose event of this sap.m.SplitContainer.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
detachAfterMasterNavigate(fnFunction, oListener): sap.m.SplitContainer

Detaches event handler fnFunction from the afterMasterNavigate event of this sap.m.SplitContainer.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
detachAfterMasterOpen(fnFunction, oListener): sap.m.SplitContainer

Detaches event handler fnFunction from the afterMasterOpen event of this sap.m.SplitContainer.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
detachBeforeMasterClose(fnFunction, oListener): sap.m.SplitContainer

Detaches event handler fnFunction from the beforeMasterClose event of this sap.m.SplitContainer.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
detachBeforeMasterOpen(fnFunction, oListener): sap.m.SplitContainer

Detaches event handler fnFunction from the beforeMasterOpen event of this sap.m.SplitContainer.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
detachDetailNavigate(fnFunction, oListener): sap.m.SplitContainer

Detaches event handler fnFunction from the detailNavigate event of this sap.m.SplitContainer.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
detachMasterButton(fnFunction, oListener): sap.m.SplitContainer

Detaches event handler fnFunction from the masterButton event of this sap.m.SplitContainer.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
detachMasterNavigate(fnFunction, oListener): sap.m.SplitContainer

Detaches event handler fnFunction from the masterNavigate event of this sap.m.SplitContainer.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
fireAfterDetailNavigate(mParameters?): sap.m.SplitContainer
Fires event afterDetailNavigate to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.core.ControlmParameters.from?The page, which had been displayed before navigation.
stringmParameters.fromId?The ID of the page, which had been displayed before navigation.
sap.ui.core.ControlmParameters.to?The page, which is now displayed after navigation.
stringmParameters.toId?The ID of the page, which is now displayed after navigation.
booleanmParameters.firstTime?Determines whether the "to" page (more precisely: a control with the ID of the page, which has been navigated to) has not been displayed/navigated to before.
booleanmParameters.isTo?Determines whether was a forward navigation, triggered by to().
booleanmParameters.isBack?Determines whether this was a back navigation, triggered by back().
booleanmParameters.isBackToTop?Determines whether this was a navigation to the root page, triggered by backToTop().
booleanmParameters.isBackToPage?Determines whether this was a navigation to a specific page, triggered by backToPage().
stringmParameters.direction?Determines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
fireAfterMasterClose(mParameters?): sap.m.SplitContainer
Fires event afterMasterClose to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
fireAfterMasterNavigate(mParameters?): sap.m.SplitContainer
Fires event afterMasterNavigate to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.core.ControlmParameters.from?The page, which had been displayed before navigation.
stringmParameters.fromId?The ID of the page, which had been displayed before navigation.
sap.ui.core.ControlmParameters.to?The page, which is now displayed after navigation.
stringmParameters.toId?The ID of the page, which is now displayed after navigation.
booleanmParameters.firstTime?Whether the "to" page (more precisely: a control with the ID of the page, which has been navigated to) has not been displayed/navigated to before.
booleanmParameters.isTo?Determines whether was a forward navigation, triggered by to().
booleanmParameters.isBack?Determines whether this was a back navigation, triggered by back().
booleanmParameters.isBackToTop?Determines whether this was a navigation to the root page, triggered by backToTop().
booleanmParameters.isBackToPage?Determines whether this was a navigation to a specific page, triggered by backToPage().
stringmParameters.direction?Determines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
fireAfterMasterOpen(mParameters?): sap.m.SplitContainer
Fires event afterMasterOpen to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
fireBeforeMasterClose(mParameters?): sap.m.SplitContainer
Fires event beforeMasterClose to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
fireBeforeMasterOpen(mParameters?): sap.m.SplitContainer
Fires event beforeMasterOpen to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
fireDetailNavigate(mParameters?): boolean

Fires event detailNavigate to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.core.ControlmParameters.from?The page, which was displayed before the current navigation.
stringmParameters.fromId?The ID of the page, which was displayed before the current navigation.
sap.ui.core.ControlmParameters.to?The page, which will be displayed after the current navigation.
stringmParameters.toId?The ID of the page, which will be displayed after the current navigation.
booleanmParameters.firstTime?Determines whether the "to" page (more precisely: a control with the ID of the page, which is currently navigated to) has not been displayed/navigated to before.
booleanmParameters.isTo?Determines whether this is a forward navigation, triggered by to().
booleanmParameters.isBack?Determines whether this is a back navigation, triggered by back().
booleanmParameters.isBackToTop?Determines whether this is a navigation to the root page, triggered by backToTop().
booleanmParameters.isBackToPage?Determines whether this was a navigation to a specific page, triggered by backToPage().
stringmParameters.direction?Determines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".
Returns:
booleanWhether or not to prevent the default action
fireMasterButton(mParameters?): sap.m.SplitContainer
Fires event masterButton to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
fireMasterNavigate(mParameters?): boolean

Fires event masterNavigate to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.core.ControlmParameters.from?The page, which was displayed before the current navigation.
stringmParameters.fromId?The ID of the page, which was displayed before the current navigation.
sap.ui.core.ControlmParameters.to?The page, which will be displayed after the current navigation.
stringmParameters.toId?The ID of the page, which will be displayed after the current navigation.
booleanmParameters.firstTime?Determines whether the "to" page (more precisely: a control with the ID of the page, which is currently being navigated to) has not been displayed/navigated to before.
booleanmParameters.isTo?Determines whether this is a forward navigation, triggered by to().
booleanmParameters.isBack?Determines whether this is a back navigation, triggered by back().
booleanmParameters.isBackToTop?Determines whether this is a navigation to the root page, triggered by backToTop().
booleanmParameters.isBackToPage?Determines whether this was a navigation to a specific page, triggered by backToPage().
stringmParameters.direction?Determines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".
Returns:
booleanWhether or not to prevent the default action
getBackgroundColor(): string

Gets current value of property backgroundColor.

Determines the background color of the SplitContainer. If set, this color overrides the default one, which is defined by the theme (should only be used when really required). Any configured background image will be placed above this colored background, but any theme adaptation in the Theme Designer will override this setting. Use the backgroundRepeat property to define whether this image should be stretched to cover the complete SplitContainer or whether it should be tiled.

Returns:
stringValue of property backgroundColor
Since:
1.11.2
getBackgroundImage(): sap.ui.core.URI

Gets current value of property backgroundImage.

Sets the background image of the SplitContainer. When set, this image overrides the default background defined by the theme (should only be used when really required). This background image will be placed above any color set for the background, but any theme adaptation in the Theme Designer will override this image setting. Use the backgroundRepeat property to define whether this image should be stretched to cover the complete SplitContainer or whether it should be tiled.

Returns:
sap.ui.core.URIValue of property backgroundImage
Since:
1.11.2
getBackgroundOpacity(): float

Gets current value of property backgroundOpacity.

Defines the opacity of the background image - between 0 (fully transparent) and 1 (fully opaque). This can be used to improve the content visibility by making the background image partly transparent.

Default value is 1.

Returns:
floatValue of property backgroundOpacity
Since:
1.11.2
getBackgroundRepeat(): boolean

Gets current value of property backgroundRepeat.

Defines whether the background image (if configured) is proportionally stretched to cover the whole SplitContainer (false) or whether it should be tiled (true).

Default value is false.

Returns:
booleanValue of property backgroundRepeat
Since:
1.11.2
getCurrentDetailPage(): sap.ui.core.Control
Returns the current displayed detail page.
Returns:
sap.ui.core.Control
getCurrentMasterPage(): sap.ui.core.Control
Returns the current displayed master page.
Returns:
sap.ui.core.Control
getCurrentPage(bMaster): sap.ui.core.Control

Returns the currently displayed page either in master area or in detail area. When the parameter is set to true, the current page in master area is returned, otherwise, the current page in detail area is returned.

This method is provided mainly for API consistency between sap.m.SplitContainer and sap.m.App, so that the same code line can be reused.

Parameters:
booleanbMasterStates if this function returns the current page in master area. If it's set to false, the current page in detail area will be returned.
Returns:
sap.ui.core.Control
Since:
1.11.1
getDefaultTransitionNameDetail(): string

Gets current value of property defaultTransitionNameDetail.

Determines the type of the transition/animation to apply when to() is called without defining the transition to use. The default is "slide", other options are "fade", "show", and the names of any registered custom transitions.

Default value is slide.

Returns:
stringValue of property defaultTransitionNameDetail
getDefaultTransitionNameMaster(): string

Gets current value of property defaultTransitionNameMaster.

Determines the type of the transition/animation to apply when to() is called, without defining the transition to use. The default is "slide", other options are "fade", "show", and the names of any registered custom transitions.

Default value is slide.

Returns:
stringValue of property defaultTransitionNameMaster
getDetailPage(sId): sap.ui.core.Control
Returns the page with the given ID in detail area. If there's no page that has the given ID, null is returned.
Parameters:
stringsIdThe ID of the page that needs to be fetched.
Returns:
sap.ui.core.Control
Since:
1.11.1
getDetailPages(): sap.ui.core.Control[]

Gets content of aggregation detailPages.

Determines the content entities, between which the SplitContainer navigates in detail area. These can be of type sap.m.Page, sap.ui.core.View, sap.m.Carousel or any other control with fullscreen/page semantics. These aggregated controls receive navigation events like beforeShow, they are documented in the pseudo interface sap.m.NavContainerChild.

Returns:
sap.ui.core.Control[]
getInitialDetail(): sap.ui.core.ID
ID of the element which is the current target of the association initialDetail, or null.
Returns:
sap.ui.core.ID
getInitialMaster(): sap.ui.core.ID
ID of the element which is the current target of the association initialMaster, or null.
Returns:
sap.ui.core.ID
getMasterButtonText(): string

Gets current value of property masterButtonText.

Determines the text displayed in master button, which has a default value "Navigation". This text is only displayed in iOS platform and the icon from the current page in detail area is displayed in the master button for the other platforms. The master button is shown/hidden depending on the orientation of the device and whether the master area is opened or not. SplitContainer manages the show/hide of the master button by itself only when the pages added to the detail area are sap.m.Page with built-in header or sap.m.Page with built-in header, which is wrapped by one or several sap.ui.core.mvc.View. Otherwise, the show/hide of master button needs to be managed by the application.

Returns:
stringValue of property masterButtonText
getMasterButtonTooltip(): string

Gets current value of property masterButtonTooltip.

Specifies the tooltip of the master button. If the tooltip is not specified, the title of the page, which is displayed is the master part, is set as tooltip to the master button.

Returns:
stringValue of property masterButtonTooltip
Since:
1.48
getMasterPage(sId): sap.ui.core.Control
Returns the page with the given ID in master area (if there's no page that has the given ID, null is returned).
Parameters:
stringsIdThe ID of the page that needs to be fetched
Returns:
sap.ui.core.Control
Since:
1.11.1
getMasterPages(): sap.ui.core.Control[]

Gets content of aggregation masterPages.

Determines the content entities, between which the SplitContainer navigates in master area. These can be of type sap.m.Page, sap.ui.core.View, sap.m.Carousel or any other control with fullscreen/page semantics. These aggregated controls receive navigation events like beforeShow, they are documented in the pseudo interface sap.m.NavContainerChild.

Returns:
sap.ui.core.Control[]
getMode(): sap.m.SplitAppMode

Gets current value of property mode.

Defines whether the master page will always be displayed (in portrait and landscape mode - StretchCompressMode), or if it should be hidden when in portrait mode (ShowHideMode). Default is ShowHideMode. Other possible values are Hide (Master is always hidden) and Popover (master is displayed in popover).

Default value is ShowHideMode.

Returns:
sap.m.SplitAppModeValue of property mode
getPage(sId, bMaster): sap.ui.core.Control
Returns the page with the given ID from either master area, or detail area depending on the master parameter (if there's no page that has the given ID, null is returned).
Parameters:
stringsIdThe ID of the page that needs to be fetched
booleanbMasterIf the page with given ID should be fetched from the master area. If it's set to false, the page will be fetched from detail area.
Returns:
sap.ui.core.Control
Since:
1.11.1
getPreviousPage(bMaster): sap.ui.core.Control
Returns the previous page (the page, from which the user drilled down to the current page with to()). Note: this is not the page, which the user has seen before, but the page which is the target of the next back() navigation. If there is no previous page, "undefined" is returned.
Parameters:
booleanbMasterStates if this function returns the previous page in master area. If it's set to false, the previous page in detail area will be returned.
Returns:
sap.ui.core.Control
hideMaster(): sap.m.SplitContainer
Used to hide the master page when in ShowHideMode and the device is in portrait mode.
Returns:
sap.m.SplitContainer
indexOfDetailPage(oDetailPage): int
Checks for the provided sap.ui.core.Control in the aggregation detailPages. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloDetailPageThe detailPage whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
indexOfMasterPage(oMasterPage): int
Checks for the provided sap.ui.core.Control in the aggregation masterPages. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloMasterPageThe masterPage whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertDetailPage(oDetailPage, iIndex): sap.m.SplitContainer
Inserts a detailPage into the aggregation detailPages.
Parameters:
sap.ui.core.ControloDetailPagethe detailPage to insert; if empty, nothing is inserted
intiIndexthe 0-based index the detailPage should be inserted at; for a negative value of iIndex, the detailPage is inserted at position 0; for a value greater than the current size of the aggregation, the detailPage is inserted at the last position
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
insertMasterPage(oMasterPage, iIndex): sap.m.SplitContainer
Inserts a masterPage into the aggregation masterPages.
Parameters:
sap.ui.core.ControloMasterPagethe masterPage to insert; if empty, nothing is inserted
intiIndexthe 0-based index the masterPage should be inserted at; for a negative value of iIndex, the masterPage is inserted at position 0; for a value greater than the current size of the aggregation, the masterPage is inserted at the last position
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
insertPreviousPage(sPageId, sTransitionName, oData): sap.m.SplitContainer

Inserts the page/control with the specified ID into the navigation history stack of the NavContainer.

This can be used for deep-linking when the user directly reached a drilldown detail page using a bookmark and then wants to navigate up in the drilldown hierarchy. Normally, such a back navigation would not be possible as there is no previous page in the SplitContainer's history stack.

Parameters:
stringsPageIdThe ID of the control/page/screen, which is inserted into the history stack. The respective control must be aggregated by the SplitContainer, otherwise this will cause an error.
stringsTransitionNameThe type of the transition/animation, which would have been used to navigate from the (inserted) previous page to the current page. When navigating back, the inverse animation will be applied. This parameter can be omitted; then the default value is "slide" (horizontal movement from the right).
objectoDataThis optional object can carry any payload data which would have been given to the inserted previous page if the user would have done a normal forward navigation to it.
Returns:
sap.m.SplitContainer
isMasterShown(): boolean
Returns whether master area is currently displayed on the screen. In desktop browser or tablet, this method returns true when master area is displayed on the screen, regardless if in portrait or landscape mode. On mobile phone devices, this method returns true when the currently displayed page is from the pages, which are added to the master area, otherwise, it returns false.
Returns:
boolean
Since:
1.16.5
removeAllDetailPages(): sap.ui.core.Control[]

Removes all the controls from the aggregation detailPages.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeAllMasterPages(): sap.ui.core.Control[]

Removes all the controls from the aggregation masterPages.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeDetailPage(vDetailPage): sap.ui.core.Control
Removes a detailPage from the aggregation detailPages.
Parameters:
int|string|sap.ui.core.ControlvDetailPageThe detailPage to remove or its index or id
Returns:
sap.ui.core.ControlThe removed detailPage or null
removeMasterPage(vMasterPage): sap.ui.core.Control
Removes a masterPage from the aggregation masterPages.
Parameters:
int|string|sap.ui.core.ControlvMasterPageThe masterPage to remove or its index or id
Returns:
sap.ui.core.ControlThe removed masterPage or null
setBackgroundColor(sBackgroundColor): sap.m.SplitContainer

Sets a new value for property backgroundColor.

Determines the background color of the SplitContainer. If set, this color overrides the default one, which is defined by the theme (should only be used when really required). Any configured background image will be placed above this colored background, but any theme adaptation in the Theme Designer will override this setting. Use the backgroundRepeat property to define whether this image should be stretched to cover the complete SplitContainer or whether it should be tiled.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
stringsBackgroundColorNew value for property backgroundColor
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
Since:
1.11.2
setBackgroundImage(sBackgroundImage): sap.m.SplitContainer

Sets a new value for property backgroundImage.

Sets the background image of the SplitContainer. When set, this image overrides the default background defined by the theme (should only be used when really required). This background image will be placed above any color set for the background, but any theme adaptation in the Theme Designer will override this image setting. Use the backgroundRepeat property to define whether this image should be stretched to cover the complete SplitContainer or whether it should be tiled.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
sap.ui.core.URIsBackgroundImageNew value for property backgroundImage
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
Since:
1.11.2
setBackgroundOpacity(fBackgroundOpacity): sap.m.SplitContainer

Sets a new value for property backgroundOpacity.

Defines the opacity of the background image - between 0 (fully transparent) and 1 (fully opaque). This can be used to improve the content visibility by making the background image partly transparent.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 1.

Parameters:
floatfBackgroundOpacityNew value for property backgroundOpacity
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
Since:
1.11.2
setBackgroundRepeat(bBackgroundRepeat): sap.m.SplitContainer

Sets a new value for property backgroundRepeat.

Defines whether the background image (if configured) is proportionally stretched to cover the whole SplitContainer (false) or whether it should be tiled (true).

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:
booleanbBackgroundRepeatNew value for property backgroundRepeat
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
Since:
1.11.2
setDefaultTransitionNameDetail(sDefaultTransitionNameDetail): sap.m.SplitContainer

Sets a new value for property defaultTransitionNameDetail.

Determines the type of the transition/animation to apply when to() is called without defining the transition to use. The default is "slide", other options are "fade", "show", and the names of any registered custom transitions.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is slide.

Parameters:
stringsDefaultTransitionNameDetailNew value for property defaultTransitionNameDetail
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
setDefaultTransitionNameMaster(sDefaultTransitionNameMaster): sap.m.SplitContainer

Sets a new value for property defaultTransitionNameMaster.

Determines the type of the transition/animation to apply when to() is called, without defining the transition to use. The default is "slide", other options are "fade", "show", and the names of any registered custom transitions.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is slide.

Parameters:
stringsDefaultTransitionNameMasterNew value for property defaultTransitionNameMaster
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
setInitialDetail(oInitialDetail): sap.m.SplitContainer
Sets the associated initialDetail.
Parameters:
sap.ui.core.ID|sap.ui.core.ControloInitialDetailID of an element which becomes the new target of this initialDetail association; alternatively, an element instance may be given
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
setInitialMaster(oInitialMaster): sap.m.SplitContainer
Sets the associated initialMaster.
Parameters:
sap.ui.core.ID|sap.ui.core.ControloInitialMasterID of an element which becomes the new target of this initialMaster association; alternatively, an element instance may be given
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
setMasterButtonText(sMasterButtonText): sap.m.SplitContainer

Sets a new value for property masterButtonText.

Determines the text displayed in master button, which has a default value "Navigation". This text is only displayed in iOS platform and the icon from the current page in detail area is displayed in the master button for the other platforms. The master button is shown/hidden depending on the orientation of the device and whether the master area is opened or not. SplitContainer manages the show/hide of the master button by itself only when the pages added to the detail area are sap.m.Page with built-in header or sap.m.Page with built-in header, which is wrapped by one or several sap.ui.core.mvc.View. Otherwise, the show/hide of master button needs to be managed by the application.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
stringsMasterButtonTextNew value for property masterButtonText
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
setMasterButtonTooltip(sMasterButtonTooltip): sap.m.SplitContainer

Sets a new value for property masterButtonTooltip.

Specifies the tooltip of the master button. If the tooltip is not specified, the title of the page, which is displayed is the master part, is set as tooltip to the master button.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
stringsMasterButtonTooltipNew value for property masterButtonTooltip
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
Since:
1.48
setMode(sMode): sap.m.SplitContainer

Sets a new value for property mode.

Defines whether the master page will always be displayed (in portrait and landscape mode - StretchCompressMode), or if it should be hidden when in portrait mode (ShowHideMode). Default is ShowHideMode. Other possible values are Hide (Master is always hidden) and Popover (master is displayed in popover).

When called with a value of null or undefined, the default value of the property will be restored.

Default value is ShowHideMode.

Parameters:
sap.m.SplitAppModesModeNew value for property mode
Returns:
sap.m.SplitContainerReference to this in order to allow method chaining
showMaster(): sap.m.SplitContainer
Used to make the master page visible when in ShowHideMode and the device is in portrait mode.
Returns:
sap.m.SplitContainer
to(sPageId, sTransitionName, oData, oTransitionParameters): sap.m.SplitContainer
Navigates to the given page inside the SplitContainer. The navigation is done inside the master area if the page has been added, otherwise, it tries to do the page navigation in the detail area.
Parameters:
stringsPageIdThe screen to which we are navigating to. The ID or the control itself can be given.
stringsTransitionName

The type of the transition/animation to apply. This parameter can be omitted; then the default value is "slide" (horizontal movement from the right). Other options are: "fade", "flip", and "show" and the names of any registered custom transitions.

None of the standard transitions is currently making use of any given transition parameters.

objectoData

This optional object can carry any payload data which should be made available to the target page. The beforeShow event on the target page will contain this data object as data property.

Use case: in scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data.

When the transitionParameters object is used, this "data" object must also be given (either as object or as null) in order to have a proper parameter order.

objectoTransitionParameters

This optional object can contain additional information for the transition function, like the DOM element which triggered the transition or the desired transition duration.

For a proper parameter order, the "data" parameter must be given when the transitionParameters parameter is used (it can be given as "null").

NOTE: It depends on the transition function how the object should be structured and which parameters are actually used to influence the transition. The "show", "slide" and "fade" transitions do not use any parameter.

Returns:
sap.m.SplitContainer
Since:
1.10.0
toDetail(sPageId, sTransitionName, oData, oTransitionParameter): sap.m.SplitContainer
Navigates to a given detail page.
Parameters:
stringsPageId
stringsTransitionName

The type of the transition/animation to apply. This parameter can be omitted; then the default is "slide" (horizontal movement from the right). Other options are: "fade", "flip", and "show" and the names of any registered custom transitions.

None of the standard transitions is currently making use of any given transition parameters.

objectoData

This optional object can carry any payload data which should be made available to the target page. The beforeShow event on the target page will contain this data object as data property.

Use case: in scenarios where the entity triggering the navigation can or should not directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data.

When the transitionParameters object is used, this data object must also be given (either as object or as null) in order to have a proper parameter order.

objectoTransitionParameter

This optional object can contain additional information for the transition function, like the DOM element, which triggered the transition or the desired transition duration.

For a proper parameter order, the data parameter must be given when the transitionParameters parameter is used (it can be given as "null").

NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition. The "show", "slide" and "fade" transitions do not use any parameter.

Returns:
sap.m.SplitContainer
toMaster(sPageId, sTransitionName, oData, oTransitionParameters): sap.m.SplitContainer
Navigates to a given master page.
Parameters:
stringsPageIdThe screen to which drilldown should happen. The ID or the control itself can be given.
stringsTransitionName

The type of the transition/animation to apply. This parameter can be omitted; then the default value is "slide" (horizontal movement from the right). Other options are: "fade", "flip", and "show" and the names of any registered custom transitions.

None of the standard transitions is currently making use of any given transition parameters.

objectoData

Since version 1.7.1. This optional object can carry any payload data which should be made available to the target page. The beforeShow event on the target page will contain this data object as data property.

Use case: in scenarios where the entity triggering the navigation can't or shouldn't directly initialize the target page, it can fill this object and the target page itself (or a listener on it) can take over the initialization, using the given data.

When the transitionParameters object is used, this data object must also be given (either as object or as null) in order to have a proper parameter order.

objectoTransitionParameters

Since version 1.7.1. This optional object can contain additional information for the transition function, like the DOM element, which triggered the transition or the desired transition duration.

For a proper parameter order, the data parameter must be given when the transitionParameters parameter is used (it can be given as "null").

NOTE: it depends on the transition function how the object should be structured and which parameters are actually used to influence the transition. The "show", "slide" and "fade" transitions do not use any parameter.

Returns:
sap.m.SplitContainer