Class sap.f.FlexibleColumnLayoutModule: sap/f/FlexibleColumnLayout

extends Control

Implements the master-detail-detail paradigm by displaying up to three pages in separate columns.

Overview

The control is logically similar to sap.m.SplitContainer with the difference that it capable of handling three columns (referred to as Begin, Mid and End) rather than two (Master, Detail). The width of the three columns is variable.

There are several possible layouts that can be changed either with the control's API, or by the user with the help of layout arrows.

Internally the control makes use of three instances of sap.m.NavContainer, thus forming the three columns.

Usage

Use this control for applications that need to display several logical levels of related information side by side (e.g. list of items, item, sub-item, etc.). The control is flexible in a sense that the application can focus the user's attention on one particular column by making it larger or even fullscreen.

The columns are accessible with the beginColumnPages, midColumnPages and endColumnPages aggregations.

The relative sizes and the visibility of the three columns are determined based on the value of the layout property.

Changes to the layout due to user interaction are communicated to the app with the stateChange event.

    Notes:
  • To easily implement the recommended UX design of a sap.f.FlexibleColumnLayout-based app, you can use the sap.f.FlexibleColumnLayoutSemanticHelper class.
  • To facilitate the navigation and view loading, you can use the sap.f.routing.Router

Responsive Behavior

The control automatically displays the maximum possible number of columns based on the device size and current layout. The app does not need to take into consideration the current device/screen size, but only to add content to the columns and change the value of the layout property.

For detailed information, see LayoutType enumeration.


Since: 1.46.
Constructor Summary
new sap.f.FlexibleColumnLayout(sId?, mSettings?)Constructor for a new sap.f.FlexibleColumnLayout.
Event Summary
afterBeginColumnNavigate(oControlEvent)Fires when navigation between two pages in the Begin column has completed.
afterEndColumnNavigate(oControlEvent)Fires when navigation between two pages in the End column has completed.
afterMidColumnNavigate(oControlEvent)Fires when navigation between two pages in the Mid column has completed.
beginColumnNavigate(oControlEvent)Fires when navigation between two pages in the Begin column has been triggered.
endColumnNavigate(oControlEvent)Fires when navigation between two pages in the End column has been triggered.
midColumnNavigate(oControlEvent)Fires when navigation between two pages in the Mid column has been triggered.
stateChange(oControlEvent)Fired when there is a change in the layout property or in the maximum number of columns that can be displayed at once.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.f.FlexibleColumnLayout.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.f.FlexibleColumnLayout with name sClassName and enriches it with the information contained in oClassInfo.
sap.f.FlexibleColumnLayout.getMetadata()Returns a metadata object for class sap.f.FlexibleColumnLayout.
addBeginColumnPage(oBeginColumnPage)Adds some beginColumnPage to the aggregation beginColumnPages.
addEndColumnPage(oEndColumnPage)Adds some endColumnPage to the aggregation endColumnPages.
addMidColumnPage(oMidColumnPage)Adds some midColumnPage to the aggregation midColumnPages.
attachAfterBeginColumnNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterBeginColumnNavigate event of this sap.f.FlexibleColumnLayout.
attachAfterEndColumnNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterEndColumnNavigate event of this sap.f.FlexibleColumnLayout.
attachAfterMidColumnNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterMidColumnNavigate event of this sap.f.FlexibleColumnLayout.
attachBeginColumnNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the beginColumnNavigate event of this sap.f.FlexibleColumnLayout.
attachEndColumnNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the endColumnNavigate event of this sap.f.FlexibleColumnLayout.
attachMidColumnNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the midColumnNavigate event of this sap.f.FlexibleColumnLayout.
attachStateChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the stateChange event of this sap.f.FlexibleColumnLayout.
backToPage(sPageId, oBackData, oTransitionParameters)Navigates back to a page in the FlexibleColumnLayout.
backToTopBeginColumn(oBackData, oTransitionParameter)Navigates back to the initial/top level of Begin column (this is the element aggregated as "initialPage", or the first added element).
backToTopEndColumn(oBackData, oTransitionParameter)Navigates back to the initial/top level of End column (this is the element aggregated as "initialPage", or the first added element).
backToTopMidColumn(oBackData, oTransitionParameter)Navigates back to the initial/top level of Mid column (this is the element aggregated as "initialPage", or the first added element).
destroyBeginColumnPages()Destroys all the beginColumnPages in the aggregation beginColumnPages.
destroyEndColumnPages()Destroys all the endColumnPages in the aggregation endColumnPages.
destroyMidColumnPages()Destroys all the midColumnPages in the aggregation midColumnPages.
detachAfterBeginColumnNavigate(fnFunction, oListener)Detaches event handler fnFunction from the afterBeginColumnNavigate event of this sap.f.FlexibleColumnLayout.
detachAfterEndColumnNavigate(fnFunction, oListener)Detaches event handler fnFunction from the afterEndColumnNavigate event of this sap.f.FlexibleColumnLayout.
detachAfterMidColumnNavigate(fnFunction, oListener)Detaches event handler fnFunction from the afterMidColumnNavigate event of this sap.f.FlexibleColumnLayout.
detachBeginColumnNavigate(fnFunction, oListener)Detaches event handler fnFunction from the beginColumnNavigate event of this sap.f.FlexibleColumnLayout.
detachEndColumnNavigate(fnFunction, oListener)Detaches event handler fnFunction from the endColumnNavigate event of this sap.f.FlexibleColumnLayout.
detachMidColumnNavigate(fnFunction, oListener)Detaches event handler fnFunction from the midColumnNavigate event of this sap.f.FlexibleColumnLayout.
detachStateChange(fnFunction, oListener)Detaches event handler fnFunction from the stateChange event of this sap.f.FlexibleColumnLayout.
fireAfterBeginColumnNavigate(mParameters?)Fires event afterBeginColumnNavigate to attached listeners.
fireAfterEndColumnNavigate(mParameters?)Fires event afterEndColumnNavigate to attached listeners.
fireAfterMidColumnNavigate(mParameters?)Fires event afterMidColumnNavigate to attached listeners.
fireBeginColumnNavigate(mParameters?)Fires event beginColumnNavigate to attached listeners.
fireEndColumnNavigate(mParameters?)Fires event endColumnNavigate to attached listeners.
fireMidColumnNavigate(mParameters?)Fires event midColumnNavigate to attached listeners.
fireStateChange(mParameters?)Fires event stateChange to attached listeners.
getBeginColumnPages()Gets content of aggregation beginColumnPages.
getCurrentBeginColumnPage()Returns the currently displayed Begin column page.
getCurrentEndColumnPage()Returns the currently displayed End column page.
getCurrentMidColumnPage()Returns the currently displayed Mid column page.
getEndColumnPages()Gets content of aggregation endColumnPages.
getInitialBeginColumnPage()ID of the element which is the current target of the association initialBeginColumnPage, or null.
getInitialEndColumnPage()ID of the element which is the current target of the association initialEndColumnPage, or null.
getInitialMidColumnPage()ID of the element which is the current target of the association initialMidColumnPage, or null.
getLayout()Gets current value of property layout.
getMaxColumnsCount()Returns the maximum number of columns that can be displayed at once based on the control width
getMidColumnPages()Gets content of aggregation midColumnPages.
indexOfBeginColumnPage(oBeginColumnPage)Checks for the provided sap.ui.core.Control in the aggregation beginColumnPages.
indexOfEndColumnPage(oEndColumnPage)Checks for the provided sap.ui.core.Control in the aggregation endColumnPages.
indexOfMidColumnPage(oMidColumnPage)Checks for the provided sap.ui.core.Control in the aggregation midColumnPages.
insertBeginColumnPage(oBeginColumnPage, iIndex)Inserts a beginColumnPage into the aggregation beginColumnPages.
insertEndColumnPage(oEndColumnPage, iIndex)Inserts a endColumnPage into the aggregation endColumnPages.
insertMidColumnPage(oMidColumnPage, iIndex)Inserts a midColumnPage into the aggregation midColumnPages.
removeAllBeginColumnPages()Removes all the controls from the aggregation beginColumnPages.
removeAllEndColumnPages()Removes all the controls from the aggregation endColumnPages.
removeAllMidColumnPages()Removes all the controls from the aggregation midColumnPages.
removeBeginColumnPage(vBeginColumnPage)Removes a beginColumnPage from the aggregation beginColumnPages.
removeEndColumnPage(vEndColumnPage)Removes a endColumnPage from the aggregation endColumnPages.
removeMidColumnPage(vMidColumnPage)Removes a midColumnPage from the aggregation midColumnPages.
setDefaultTransitionNameBeginColumn(sDefaultTransitionNameBeginColumn)Sets a new value for property defaultTransitionNameBeginColumn.
setDefaultTransitionNameEndColumn(sDefaultTransitionNameEndColumn)Sets a new value for property defaultTransitionNameEndColumn.
setDefaultTransitionNameMidColumn(sDefaultTransitionNameMidColumn)Sets a new value for property defaultTransitionNameMidColumn.
setInitialBeginColumnPage(oInitialBeginColumnPage)Sets the associated initialBeginColumnPage.
setInitialEndColumnPage(oInitialEndColumnPage)Sets the associated initialEndColumnPage.
setInitialMidColumnPage(oInitialMidColumnPage)Sets the associated initialMidColumnPage.
setLayout(sLayout)Sets a new value for property layout.
to(sPageId, sTransitionName, oData, oTransitionParameters)Navigates to the given page inside the FlexibleColumnLayout.
toBeginColumnPage(sPageId, sTransitionName, oData, oTransitionParameters)Navigates to a given Begin column page.
toEndColumnPage(sPageId, sTransitionName, oData, oTransitionParameters)Navigates to a given End column page.
toMidColumnPage(sPageId, sTransitionName, oData, oTransitionParameters)Navigates to a given Mid column page.
Constructor Detail
new sap.f.FlexibleColumnLayout(sId?, mSettings?)

Constructor for a new sap.f.FlexibleColumnLayout.

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
afterBeginColumnNavigate(oControlEvent)

Fires when navigation between two pages in the Begin column 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".
afterEndColumnNavigate(oControlEvent)

Fires when navigation between two pages in the End column 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".
afterMidColumnNavigate(oControlEvent)

Fires when navigation between two pages in the Mid column 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".
beginColumnNavigate(oControlEvent)
Fires when navigation between two pages in the Begin column 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".
endColumnNavigate(oControlEvent)
Fires when navigation between two pages in the End column 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".
midColumnNavigate(oControlEvent)
Fires when navigation between two pages in the Mid column 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".
stateChange(oControlEvent)

Fired when there is a change in the layout property or in the maximum number of columns that can be displayed at once.

    The interactions that may lead to a state change are:
  • the property layout was changed indirectly by the user clicking a layout arrow
  • the user resized the browser beyond a breakpoint, thus changing the maximum number of columns that can be displayed at once.



Note: The event is suppressed while the control has zero width and will be fired the first time it gets a non-zero width

Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.f.LayoutTypeoControlEvent.getParameters.layoutThe value of the layout property
intoControlEvent.getParameters.maxColumnsCount

The maximum number of columns that can be displayed at once based on the available screen size and control settings.

    Possible values are:
  • 3 for browser size of 1280px or more
  • 2 for browser size between 960px and 1280px
  • 1 for browser size less than 960px
booleanoControlEvent.getParameters.isNavigationArrowIndicates whether the layout changed as a result of the user clicking a layout arrow
booleanoControlEvent.getParameters.isResizeIndicates whether the maximum number of columns that can be displayed at once changed
Method Detail
sap.f.FlexibleColumnLayout.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.f.FlexibleColumnLayout 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.f.FlexibleColumnLayout.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.f.FlexibleColumnLayout.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addBeginColumnPage(oBeginColumnPage): sap.f.FlexibleColumnLayout
Adds some beginColumnPage to the aggregation beginColumnPages.
Parameters:
sap.ui.core.ControloBeginColumnPagethe beginColumnPage to add; if empty, nothing is inserted
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
addEndColumnPage(oEndColumnPage): sap.f.FlexibleColumnLayout
Adds some endColumnPage to the aggregation endColumnPages.
Parameters:
sap.ui.core.ControloEndColumnPagethe endColumnPage to add; if empty, nothing is inserted
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
addMidColumnPage(oMidColumnPage): sap.f.FlexibleColumnLayout
Adds some midColumnPage to the aggregation midColumnPages.
Parameters:
sap.ui.core.ControloMidColumnPagethe midColumnPage to add; if empty, nothing is inserted
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
attachAfterBeginColumnNavigate(oData?, fnFunction, oListener?): sap.f.FlexibleColumnLayout

Attaches event handler fnFunction to the afterBeginColumnNavigate event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayout itself.

Fires when navigation between two pages in the Begin column 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.f.FlexibleColumnLayout itself
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
attachAfterEndColumnNavigate(oData?, fnFunction, oListener?): sap.f.FlexibleColumnLayout

Attaches event handler fnFunction to the afterEndColumnNavigate event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayout itself.

Fires when navigation between two pages in the End column 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.f.FlexibleColumnLayout itself
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
attachAfterMidColumnNavigate(oData?, fnFunction, oListener?): sap.f.FlexibleColumnLayout

Attaches event handler fnFunction to the afterMidColumnNavigate event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayout itself.

Fires when navigation between two pages in the Mid column 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.f.FlexibleColumnLayout itself
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
attachBeginColumnNavigate(oData?, fnFunction, oListener?): sap.f.FlexibleColumnLayout

Attaches event handler fnFunction to the beginColumnNavigate event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayout itself.

Fires when navigation between two pages in the Begin column 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.f.FlexibleColumnLayout itself
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
attachEndColumnNavigate(oData?, fnFunction, oListener?): sap.f.FlexibleColumnLayout

Attaches event handler fnFunction to the endColumnNavigate event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayout itself.

Fires when navigation between two pages in the End column 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.f.FlexibleColumnLayout itself
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
attachMidColumnNavigate(oData?, fnFunction, oListener?): sap.f.FlexibleColumnLayout

Attaches event handler fnFunction to the midColumnNavigate event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayout itself.

Fires when navigation between two pages in the Mid column 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.f.FlexibleColumnLayout itself
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
attachStateChange(oData?, fnFunction, oListener?): sap.f.FlexibleColumnLayout

Attaches event handler fnFunction to the stateChange event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayout itself.

Fired when there is a change in the layout property or in the maximum number of columns that can be displayed at once.

    The interactions that may lead to a state change are:
  • the property layout was changed indirectly by the user clicking a layout arrow
  • the user resized the browser beyond a breakpoint, thus changing the maximum number of columns that can be displayed at once.



Note: The event is suppressed while the control has zero width and will be fired the first time it gets a non-zero width

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.f.FlexibleColumnLayout itself
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
backToPage(sPageId, oBackData, oTransitionParameters): sap.f.FlexibleColumnLayout

Navigates back to a page in the FlexibleColumnLayout. Columns are scanned for the page in the following order: Begin, Mid, End.

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.f.FlexibleColumnLayout
backToTopBeginColumn(oBackData, oTransitionParameter): sap.ui.core.Control
Navigates back to the initial/top level of Begin column (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
backToTopEndColumn(oBackData, oTransitionParameter): sap.ui.core.Control
Navigates back to the initial/top level of End column (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
backToTopMidColumn(oBackData, oTransitionParameter): sap.ui.core.Control
Navigates back to the initial/top level of Mid column (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
destroyBeginColumnPages(): sap.f.FlexibleColumnLayout
Destroys all the beginColumnPages in the aggregation beginColumnPages.
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
destroyEndColumnPages(): sap.f.FlexibleColumnLayout
Destroys all the endColumnPages in the aggregation endColumnPages.
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
destroyMidColumnPages(): sap.f.FlexibleColumnLayout
Destroys all the midColumnPages in the aggregation midColumnPages.
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
detachAfterBeginColumnNavigate(fnFunction, oListener): sap.f.FlexibleColumnLayout

Detaches event handler fnFunction from the afterBeginColumnNavigate event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayoutReference to this in order to allow method chaining
detachAfterEndColumnNavigate(fnFunction, oListener): sap.f.FlexibleColumnLayout

Detaches event handler fnFunction from the afterEndColumnNavigate event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayoutReference to this in order to allow method chaining
detachAfterMidColumnNavigate(fnFunction, oListener): sap.f.FlexibleColumnLayout

Detaches event handler fnFunction from the afterMidColumnNavigate event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayoutReference to this in order to allow method chaining
detachBeginColumnNavigate(fnFunction, oListener): sap.f.FlexibleColumnLayout

Detaches event handler fnFunction from the beginColumnNavigate event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayoutReference to this in order to allow method chaining
detachEndColumnNavigate(fnFunction, oListener): sap.f.FlexibleColumnLayout

Detaches event handler fnFunction from the endColumnNavigate event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayoutReference to this in order to allow method chaining
detachMidColumnNavigate(fnFunction, oListener): sap.f.FlexibleColumnLayout

Detaches event handler fnFunction from the midColumnNavigate event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayoutReference to this in order to allow method chaining
detachStateChange(fnFunction, oListener): sap.f.FlexibleColumnLayout

Detaches event handler fnFunction from the stateChange event of this sap.f.FlexibleColumnLayout.

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.f.FlexibleColumnLayoutReference to this in order to allow method chaining
fireAfterBeginColumnNavigate(mParameters?): sap.f.FlexibleColumnLayout
Fires event afterBeginColumnNavigate 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.f.FlexibleColumnLayoutReference to this in order to allow method chaining
fireAfterEndColumnNavigate(mParameters?): sap.f.FlexibleColumnLayout
Fires event afterEndColumnNavigate 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.f.FlexibleColumnLayoutReference to this in order to allow method chaining
fireAfterMidColumnNavigate(mParameters?): sap.f.FlexibleColumnLayout
Fires event afterMidColumnNavigate 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.f.FlexibleColumnLayoutReference to this in order to allow method chaining
fireBeginColumnNavigate(mParameters?): boolean

Fires event beginColumnNavigate 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
fireEndColumnNavigate(mParameters?): boolean

Fires event endColumnNavigate 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
fireMidColumnNavigate(mParameters?): boolean

Fires event midColumnNavigate 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
fireStateChange(mParameters?): sap.f.FlexibleColumnLayout
Fires event stateChange to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.f.LayoutTypemParameters.layout?The value of the layout property
intmParameters.maxColumnsCount?

The maximum number of columns that can be displayed at once based on the available screen size and control settings.

    Possible values are:
  • 3 for browser size of 1280px or more
  • 2 for browser size between 960px and 1280px
  • 1 for browser size less than 960px
booleanmParameters.isNavigationArrow?Indicates whether the layout changed as a result of the user clicking a layout arrow
booleanmParameters.isResize?Indicates whether the maximum number of columns that can be displayed at once changed
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
getBeginColumnPages(): sap.ui.core.Control[]

Gets content of aggregation beginColumnPages.

The content entities between which the FlexibleColumnLayout navigates in the Begin column.

These should be any control with page semantics. These aggregated controls will receive navigation events like beforeShow, they are documented in the pseudo interface sap.m.NavContainerChild.

Returns:
sap.ui.core.Control[]
getCurrentBeginColumnPage(): sap.ui.core.Control
Returns the currently displayed Begin column page.
Returns:
sap.ui.core.Control
getCurrentEndColumnPage(): sap.ui.core.Control
Returns the currently displayed End column page.
Returns:
sap.ui.core.Control
getCurrentMidColumnPage(): sap.ui.core.Control
Returns the currently displayed Mid column page.
Returns:
sap.ui.core.Control
getDefaultTransitionNameBeginColumn(): string

Gets current value of property defaultTransitionNameBeginColumn.

Determines the type of the transition/animation to apply for the Begin column 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 defaultTransitionNameBeginColumn
getDefaultTransitionNameEndColumn(): string

Gets current value of property defaultTransitionNameEndColumn.

Determines the type of the transition/animation to apply for the End column 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 defaultTransitionNameEndColumn
getDefaultTransitionNameMidColumn(): string

Gets current value of property defaultTransitionNameMidColumn.

Determines the type of the transition/animation to apply for the Mid column 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 defaultTransitionNameMidColumn
getEndColumnPages(): sap.ui.core.Control[]

Gets content of aggregation endColumnPages.

The content entities between which the FlexibleColumnLayout navigates in the End column.

These should be any control with page semantics. These aggregated controls will receive navigation events like beforeShow, they are documented in the pseudo interface sap.m.NavContainerChild.

Returns:
sap.ui.core.Control[]
getInitialBeginColumnPage(): sap.ui.core.ID
ID of the element which is the current target of the association initialBeginColumnPage, or null.
Returns:
sap.ui.core.ID
getInitialEndColumnPage(): sap.ui.core.ID
ID of the element which is the current target of the association initialEndColumnPage, or null.
Returns:
sap.ui.core.ID
getInitialMidColumnPage(): sap.ui.core.ID
ID of the element which is the current target of the association initialMidColumnPage, or null.
Returns:
sap.ui.core.ID
getLayout(): sap.f.LayoutType

Gets current value of property layout.

Determines the layout of the control - number of visible columns and their relative sizes

Default value is OneColumn.

Returns:
sap.f.LayoutTypeValue of property layout
getMaxColumnsCount(): number
Returns the maximum number of columns that can be displayed at once based on the control width
Returns:
number
getMidColumnPages(): sap.ui.core.Control[]

Gets content of aggregation midColumnPages.

The content entities between which the FlexibleColumnLayout navigates in the Mid column.

These should be any control with page semantics. These aggregated controls will receive navigation events like beforeShow, they are documented in the pseudo interface sap.m.NavContainerChild.

Returns:
sap.ui.core.Control[]
indexOfBeginColumnPage(oBeginColumnPage): int
Checks for the provided sap.ui.core.Control in the aggregation beginColumnPages. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloBeginColumnPageThe beginColumnPage whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
indexOfEndColumnPage(oEndColumnPage): int
Checks for the provided sap.ui.core.Control in the aggregation endColumnPages. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloEndColumnPageThe endColumnPage whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
indexOfMidColumnPage(oMidColumnPage): int
Checks for the provided sap.ui.core.Control in the aggregation midColumnPages. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloMidColumnPageThe midColumnPage whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertBeginColumnPage(oBeginColumnPage, iIndex): sap.f.FlexibleColumnLayout
Inserts a beginColumnPage into the aggregation beginColumnPages.
Parameters:
sap.ui.core.ControloBeginColumnPagethe beginColumnPage to insert; if empty, nothing is inserted
intiIndexthe 0-based index the beginColumnPage should be inserted at; for a negative value of iIndex, the beginColumnPage is inserted at position 0; for a value greater than the current size of the aggregation, the beginColumnPage is inserted at the last position
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
insertEndColumnPage(oEndColumnPage, iIndex): sap.f.FlexibleColumnLayout
Inserts a endColumnPage into the aggregation endColumnPages.
Parameters:
sap.ui.core.ControloEndColumnPagethe endColumnPage to insert; if empty, nothing is inserted
intiIndexthe 0-based index the endColumnPage should be inserted at; for a negative value of iIndex, the endColumnPage is inserted at position 0; for a value greater than the current size of the aggregation, the endColumnPage is inserted at the last position
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
insertMidColumnPage(oMidColumnPage, iIndex): sap.f.FlexibleColumnLayout
Inserts a midColumnPage into the aggregation midColumnPages.
Parameters:
sap.ui.core.ControloMidColumnPagethe midColumnPage to insert; if empty, nothing is inserted
intiIndexthe 0-based index the midColumnPage should be inserted at; for a negative value of iIndex, the midColumnPage is inserted at position 0; for a value greater than the current size of the aggregation, the midColumnPage is inserted at the last position
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
removeAllBeginColumnPages(): sap.ui.core.Control[]

Removes all the controls from the aggregation beginColumnPages.

Additionally, it unregisters them from the hosting UIArea.

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

Removes all the controls from the aggregation endColumnPages.

Additionally, it unregisters them from the hosting UIArea.

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

Removes all the controls from the aggregation midColumnPages.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeBeginColumnPage(vBeginColumnPage): sap.ui.core.Control
Removes a beginColumnPage from the aggregation beginColumnPages.
Parameters:
int|string|sap.ui.core.ControlvBeginColumnPageThe beginColumnPage to remove or its index or id
Returns:
sap.ui.core.ControlThe removed beginColumnPage or null
removeEndColumnPage(vEndColumnPage): sap.ui.core.Control
Removes a endColumnPage from the aggregation endColumnPages.
Parameters:
int|string|sap.ui.core.ControlvEndColumnPageThe endColumnPage to remove or its index or id
Returns:
sap.ui.core.ControlThe removed endColumnPage or null
removeMidColumnPage(vMidColumnPage): sap.ui.core.Control
Removes a midColumnPage from the aggregation midColumnPages.
Parameters:
int|string|sap.ui.core.ControlvMidColumnPageThe midColumnPage to remove or its index or id
Returns:
sap.ui.core.ControlThe removed midColumnPage or null
setDefaultTransitionNameBeginColumn(sDefaultTransitionNameBeginColumn): sap.f.FlexibleColumnLayout

Sets a new value for property defaultTransitionNameBeginColumn.

Determines the type of the transition/animation to apply for the Begin column 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:
stringsDefaultTransitionNameBeginColumnNew value for property defaultTransitionNameBeginColumn
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
setDefaultTransitionNameEndColumn(sDefaultTransitionNameEndColumn): sap.f.FlexibleColumnLayout

Sets a new value for property defaultTransitionNameEndColumn.

Determines the type of the transition/animation to apply for the End column 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:
stringsDefaultTransitionNameEndColumnNew value for property defaultTransitionNameEndColumn
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
setDefaultTransitionNameMidColumn(sDefaultTransitionNameMidColumn): sap.f.FlexibleColumnLayout

Sets a new value for property defaultTransitionNameMidColumn.

Determines the type of the transition/animation to apply for the Mid column 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:
stringsDefaultTransitionNameMidColumnNew value for property defaultTransitionNameMidColumn
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
setInitialBeginColumnPage(oInitialBeginColumnPage): sap.f.FlexibleColumnLayout
Sets the associated initialBeginColumnPage.
Parameters:
sap.ui.core.ID|sap.ui.core.ControloInitialBeginColumnPageID of an element which becomes the new target of this initialBeginColumnPage association; alternatively, an element instance may be given
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
setInitialEndColumnPage(oInitialEndColumnPage): sap.f.FlexibleColumnLayout
Sets the associated initialEndColumnPage.
Parameters:
sap.ui.core.ID|sap.ui.core.ControloInitialEndColumnPageID of an element which becomes the new target of this initialEndColumnPage association; alternatively, an element instance may be given
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
setInitialMidColumnPage(oInitialMidColumnPage): sap.f.FlexibleColumnLayout
Sets the associated initialMidColumnPage.
Parameters:
sap.ui.core.ID|sap.ui.core.ControloInitialMidColumnPageID of an element which becomes the new target of this initialMidColumnPage association; alternatively, an element instance may be given
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
setLayout(sLayout): sap.f.FlexibleColumnLayout

Sets a new value for property layout.

Determines the layout of the control - number of visible columns and their relative sizes

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

Default value is OneColumn.

Parameters:
sap.f.LayoutTypesLayoutNew value for property layout
Returns:
sap.f.FlexibleColumnLayoutReference to this in order to allow method chaining
to(sPageId, sTransitionName, oData, oTransitionParameters): sap.f.FlexibleColumnLayout
Navigates to the given page inside the FlexibleColumnLayout. Columns are scanned for the page in the following order: Begin, Mid, End.
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.f.FlexibleColumnLayout
toBeginColumnPage(sPageId, sTransitionName, oData, oTransitionParameters): sap.f.FlexibleColumnLayout
Navigates to a given Begin column 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

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

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.f.FlexibleColumnLayout
toEndColumnPage(sPageId, sTransitionName, oData, oTransitionParameters): sap.f.FlexibleColumnLayout
Navigates to a given End column 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

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

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.f.FlexibleColumnLayout
toMidColumnPage(sPageId, sTransitionName, oData, oTransitionParameters): sap.f.FlexibleColumnLayout
Navigates to a given Mid column 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

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

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.f.FlexibleColumnLayout