Class sap.m. SplitContainer Module: sap/m/SplitContainer

oDetailPage

the detailPage to add; if empty, nothing is inserted

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

addMasterPage(oMasterPage): sap.m.SplitContainer

Adds some masterPage to the aggregation masterPages.

Parameters:

oMasterPage

the masterPage to add; if empty, nothing is inserted

Returns:

{sap.m.SplitContainer} Reference 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.Control}	oPage	The 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.
{boolean}	bMaster	States if the page should be added to the master area. If it's set to false, the page is added to detail area.

Since:: 1.11.1

Returns:

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:

{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 be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.SplitContainer` itself

Returns:

{sap.m.SplitContainer} Reference 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:

{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 be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.SplitContainer` itself

Returns:

{sap.m.SplitContainer} Reference 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:

{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 be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.SplitContainer` itself

Returns:

{sap.m.SplitContainer} Reference 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:

{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 be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.SplitContainer` itself

Returns:

{sap.m.SplitContainer} Reference 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:

{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 be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.SplitContainer` itself

Returns:

{sap.m.SplitContainer} Reference 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:

{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 be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.SplitContainer` itself

Returns:

{sap.m.SplitContainer} Reference 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.

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 be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.SplitContainer` itself

Returns:

{sap.m.SplitContainer} Reference 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:

{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 be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.SplitContainer` itself

Returns:

{sap.m.SplitContainer} Reference 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.

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 be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.SplitContainer` itself

Returns:

{sap.m.SplitContainer} Reference 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:

{object}

oBackData

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.

{object}

oTransitionParameter

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:

backMaster(oBackData, oTransitionParameter): sap.m.SplitContainer

Navigates back to the previous master page which is found in the history.

Parameters:

{object}

oBackData

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).

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.

{object}

oTransitionParameter

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:

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:

{string}

sPageId

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

{object}

oBackData

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.

{object}

oTransitionParameters

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.

Since:: 1.10.0

Returns:

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:

{object}

oBackData

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).

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.

{object}

oTransitionParameter

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:

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:

{object}

oBackData

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.

{object}

oTransitionParameter

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:

destroyDetailPages(): sap.m.SplitContainer

Destroys all the detailPages in the aggregation detailPages.

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

destroyMasterPages(): sap.m.SplitContainer

Destroys all the masterPages in the aggregation masterPages.

Returns:

{sap.m.SplitContainer} Reference 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:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.SplitContainer} Reference 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:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.SplitContainer} Reference 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:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.SplitContainer} Reference 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:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.SplitContainer} Reference 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:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.SplitContainer} Reference 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:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.SplitContainer} Reference 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:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.SplitContainer} Reference 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:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.SplitContainer} Reference 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:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

fireAfterDetailNavigate(mArguments?): sap.m.SplitContainer

Fires event afterDetailNavigate to attached listeners.

Expects the following event parameters:

from of type sap.ui.core.ControlThe page, which had been displayed before navigation.
fromId of type stringThe ID of the page, which had been displayed before navigation.
to of type sap.ui.core.ControlThe page, which is now displayed after navigation.
toId of type stringThe ID of the page, which is now displayed after navigation.
firstTime of type booleanDetermines 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.
isTo of type booleanDetermines whether was a forward navigation, triggered by to().
isBack of type booleanDetermines whether this was a back navigation, triggered by back().
isBackToTop of type booleanDetermines whether this was a navigation to the root page, triggered by backToTop().
isBackToPage of type booleanDetermines whether this was a navigation to a specific page, triggered by backToPage().
direction of type stringDetermines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

fireAfterMasterClose(mArguments?): sap.m.SplitContainer

Fires event afterMasterClose to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

fireAfterMasterNavigate(mArguments?): sap.m.SplitContainer

Fires event afterMasterNavigate to attached listeners.

Expects the following event parameters:

from of type sap.ui.core.ControlThe page, which had been displayed before navigation.
fromId of type stringThe ID of the page, which had been displayed before navigation.
to of type sap.ui.core.ControlThe page, which is now displayed after navigation.
toId of type stringThe ID of the page, which is now displayed after navigation.
firstTime of type booleanWhether 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.
isTo of type booleanDetermines whether was a forward navigation, triggered by to().
isBack of type booleanDetermines whether this was a back navigation, triggered by back().
isBackToTop of type booleanDetermines whether this was a navigation to the root page, triggered by backToTop().
isBackToPage of type booleanDetermines whether this was a navigation to a specific page, triggered by backToPage().
direction of type stringDetermines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

fireAfterMasterOpen(mArguments?): sap.m.SplitContainer

Fires event afterMasterOpen to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

fireBeforeMasterClose(mArguments?): sap.m.SplitContainer

Fires event beforeMasterClose to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

fireBeforeMasterOpen(mArguments?): sap.m.SplitContainer

Fires event beforeMasterOpen to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

fireDetailNavigate(mArguments?): 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.

Expects the following event parameters:

from of type sap.ui.core.ControlThe page, which was displayed before the current navigation.
fromId of type stringThe ID of the page, which was displayed before the current navigation.
to of type sap.ui.core.ControlThe page, which will be displayed after the current navigation.
toId of type stringThe ID of the page, which will be displayed after the current navigation.
firstTime of type booleanDetermines 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.
isTo of type booleanDetermines whether this is a forward navigation, triggered by to().
isBack of type booleanDetermines whether this is a back navigation, triggered by back().
isBackToTop of type booleanDetermines whether this is a navigation to the root page, triggered by backToTop().
isBackToPage of type booleanDetermines whether this was a navigation to a specific page, triggered by backToPage().
direction of type stringDetermines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{boolean}

Whether or not to prevent the default action

fireMasterButton(mArguments?): sap.m.SplitContainer

Fires event masterButton to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

fireMasterNavigate(mArguments?): 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.

Expects the following event parameters:

from of type sap.ui.core.ControlThe page, which was displayed before the current navigation.
fromId of type stringThe ID of the page, which was displayed before the current navigation.
to of type sap.ui.core.ControlThe page, which will be displayed after the current navigation.
toId of type stringThe ID of the page, which will be displayed after the current navigation.
firstTime of type booleanDetermines 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.
isTo of type booleanDetermines whether this is a forward navigation, triggered by to().
isBack of type booleanDetermines whether this is a back navigation, triggered by back().
isBackToTop of type booleanDetermines whether this is a navigation to the root page, triggered by backToTop().
isBackToPage of type booleanDetermines whether this was a navigation to a specific page, triggered by backToPage().
direction of type stringDetermines how the navigation was triggered, possible values are "to", "back", "backToPage", and "backToTop".

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{boolean}

Whether 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.

Since:: 1.11.2

Returns:

{string} Value of property backgroundColor

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.

Since:: 1.11.2

Returns:

{sap.ui.core.URI} Value of property backgroundImage

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.

Since:: 1.11.2

Returns:

{float} Value of property backgroundOpacity

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.

Since:: 1.11.2

Returns:

{boolean} Value of property backgroundRepeat

getCurrentDetailPage(): sap.ui.core.Control

Returns the current displayed detail page.

Returns:

getCurrentMasterPage(): sap.ui.core.Control

Returns the current displayed master page.

Returns:

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:

{boolean}

bMaster

States 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.

Since:: 1.11.1

Returns:

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:

{string} Value 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:

{string} Value 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:

{string}

sId

The ID of the page that needs to be fetched.

Since:: 1.11.1

Returns:

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:

getInitialDetail(): sap.ui.core.Control

ID of the element which is the current target of the association initialDetail, or null.

Returns:

getInitialMaster(): sap.ui.core.Control

ID of the element which is the current target of the association initialMaster, or null.

Returns:

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:

{string} Value of property masterButtonText

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:

{string}

sId

The ID of the page that needs to be fetched

Since:: 1.11.1

Returns:

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:

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.SplitAppMode} Value 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:

{string}	sId	The ID of the page that needs to be fetched
{boolean}	bMaster	If 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.

Since:: 1.11.1

Returns:

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:

{boolean}

bMaster

States 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:

hideMaster(): sap.m.SplitContainer

Used to hide the master page when in ShowHideMode and the device is in portrait mode.

Returns:

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:

oDetailPage

The detailPage whose index is looked for

Returns:

{int}

The 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:

oMasterPage

The masterPage whose index is looked for

Returns:

{int}

The 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.Control}	oDetailPage	the detailPage to insert; if empty, nothing is inserted
{int}	iIndex	the `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.SplitContainer} Reference 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.Control}	oMasterPage	the masterPage to insert; if empty, nothing is inserted
{int}	iIndex	the `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.SplitContainer} Reference 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:

{string}	sPageId	The 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.
{string}	sTransitionName	The 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).
{object}	oData	This 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:

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.

Since:: 1.16.5

Returns:

{boolean}

removeAllDetailPages(): sap.ui.core.Control[]

Removes all the controls from the aggregation detailPages.

Additionally, it unregisters them from the hosting UIArea.

Returns:

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:

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.Control}

vDetailPage

The detailPageto remove or its index or id

Returns:

{sap.ui.core.Control} The removed detailPage or null

removeMasterPage(vMasterPage): sap.ui.core.Control

Removes a masterPage from the aggregation masterPages.

Parameters:

{int|string|sap.ui.core.Control}

vMasterPage

The masterPageto remove or its index or id

Returns:

{sap.ui.core.Control} The removed masterPage or null

setBackgroundColor(sBackgroundColor): sap.m.SplitContainer

Sets a new value for property backgroundColor.

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

Parameters:

{string} sBackgroundColor New value for property backgroundColor

Since:: 1.11.2

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

setBackgroundImage(sBackgroundImage): sap.m.SplitContainer

Sets a new value for property backgroundImage.

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

Parameters:

{sap.ui.core.URI} sBackgroundImage New value for property backgroundImage

Since:: 1.11.2

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

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:

{float} fBackgroundOpacity New value for property backgroundOpacity

Since:: 1.11.2

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

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:

{boolean} bBackgroundRepeat New value for property backgroundRepeat

Since:: 1.11.2

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

setDefaultTransitionNameDetail(sDefaultTransitionNameDetail): sap.m.SplitContainer

Sets a new value for property defaultTransitionNameDetail.

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

Default value is slide.

Parameters:

{string} sDefaultTransitionNameDetail New value for property defaultTransitionNameDetail

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

setDefaultTransitionNameMaster(sDefaultTransitionNameMaster): sap.m.SplitContainer

Sets a new value for property defaultTransitionNameMaster.

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

Default value is slide.

Parameters:

{string} sDefaultTransitionNameMaster New value for property defaultTransitionNameMaster

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

setInitialDetail(oInitialDetail): sap.m.SplitContainer

Sets the associated initialDetail.

Parameters:

oInitialDetail

Id of an element which becomes the new target of this initialDetail association; alternatively, an element instance may be given

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

setInitialMaster(oInitialMaster): sap.m.SplitContainer

Sets the associated initialMaster.

Parameters:

oInitialMaster

Id of an element which becomes the new target of this initialMaster association; alternatively, an element instance may be given

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

setMasterButtonText(sMasterButtonText): sap.m.SplitContainer

Sets a new value for property masterButtonText.

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

Parameters:

{string} sMasterButtonText New value for property masterButtonText

Returns:

{sap.m.SplitContainer} Reference to this in order to allow method chaining

setMode(sMode): sap.m.SplitContainer

Sets a new value for property mode.

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.SplitAppMode} sMode New value for property mode

Returns:

{sap.m.SplitContainer} Reference 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:

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:

{string}	sPageId	The screen to which we are navigating to. The ID or the control itself can be given.
{string}	sTransitionName	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.
{object}	oData	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.
{object}	oTransitionParameters	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.

Since:: 1.10.0

Returns:

toDetail(sPageId, sTransitionName, oData, oTransitionParameter): sap.m.SplitContainer

Navigates to a given detail page.

Parameters:

{string}	sPageId
{string}	sTransitionName	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.
{object}	oData	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.
{object}	oTransitionParameter	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:

toMaster(sPageId, sTransitionName, oData, oTransitionParameters): sap.m.SplitContainer

Navigates to a given master page.

Parameters:

{string}	sPageId	The screen to which drilldown should happen. The ID or the control itself can be given.
{string}	sTransitionName	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.
{object}	oData	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.
{object}	oTransitionParameters	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: