class sap.f.routing.Router

Control sample: sap.f.routing.Router
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/f/routing/Router
Application Component: CA-UI5-CTR

The sap.f.routing.Router class is intended to be used with sap.f.FlexibleColumnLayout as a root control.

The difference to the sap.ui.core.routing.Router are the viewLevel, transition, and transitionParameters properties that you can specify in every Route or Target created by this router.

The difference to the sap.m.routing.Router is the additional layout property that can be specified in every Route, in which case it is applied to the root control. Also, the sap.f.routing.Router supports navigations that involve both change of sap.f.LayoutType and change of the current page within a single column of the sap.f.FlexibleColumnLayout.

See sap.ui.core.routing.Router for the constructor arguments.


Constructor

Constructor for a new sap.f.routing.Router.

new sap.f.routing.Router(oRoutes?, oOwner?, oTargetsConfig?)
Param Type Default Value Description
oRoutes? object object[]

may contain many Route configurations as sap.ui.core.routing.Route#constructor.

oOwner? sap.ui.core.UIComponent

the Component of all the views that will be created by this Router, will get forwarded to the sap.ui.core.routing.Views#constructor. If you are using the componentMetadata to define your routes you should skip this parameter.

oTargetsConfig? object

the target configuration, see sap.f.routing.Targets#constructor documentation (the options object).


Methods Overview

Method Description
sap.f.routing.Router.extend

Creates a new subclass of class sap.f.routing.Router 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.routing.Router.extend.

sap.f.routing.Router.getMetadata

Returns a metadata object for class sap.f.routing.Router.

getTargetHandler

Returns the TargetHandler instance.

sap.f.routing.Router.extend

Creates a new subclass of class sap.f.routing.Router 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.routing.Router.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

sap.f.routing.Router.getMetadata

Returns a metadata object for class sap.f.routing.Router.

getTargetHandler

Returns the TargetHandler instance.