Class sap.ui.core.routing.TargetsModule: sap/ui/core/routing/Targets

known direct subclasses: Targets, Targets


Since: 1.28.1.
Constructor Summary
new sap.ui.core.routing.Targets(oOptions)Provides a convenient way for placing views into the correct containers of your application.
Event Summary
display(oEvent)Will be fired when a target is displayed Could be triggered by calling the display function or by the sap.ui.core.routing.Router when a target is referenced in a matching route.
titleChanged(oEvent)Will be fired when the title of the "TitleTarget" has been changed.
Method Summary
sap.ui.core.routing.Targets.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.core.routing.Targets with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.core.routing.Targets.getMetadata()Returns a metadata object for class sap.ui.core.routing.Targets.
addTarget(sName, oTarget)Creates a target by using the given name and options.
attachDisplay(oData?, fnFunction, oListener?)Attach event-handler fnFunction to the 'display' event of this sap.ui.core.routing.Targets.
attachTitleChanged(oData?, fnFunction, oListener?)Attach event-handler fnFunction to the 'titleChanged' event of this sap.ui.core.routing.Targets.
destroy()Destroys the targets instance and all created targets.
detachDisplay(fnFunction, oListener)Detach event-handler fnFunction from the 'display' event of this sap.ui.core.routing.Targets.
detachTitleChanged(fnFunction, oListener)Detach event-handler fnFunction from the 'titleChanged' event of this sap.ui.core.routing.Targets.
display(vTargets, oData?, sTitleTarget?)Creates a view and puts it in an aggregation of the specified control.
fireDisplay(mArguments?)Fire event created to attached listeners.
getTarget(vName)Returns a target by its name (if you pass myTarget: { view: "myView" }) in the config myTarget is the name.
getViews()Returns the views instance passed to the constructor
Methods borrowed from class sap.ui.base.Object
Constructor Detail
new sap.ui.core.routing.Targets(oOptions)
Provides a convenient way for placing views into the correct containers of your application. The main benefit of Targets is lazy loading: you do not have to create the views until you really need them. If you are using the mobile library, please use sap.m.routing.Targets instead of this class.
Parameters:
objectoOptions
sap.ui.core.routing.ViewsoOptions.viewsthe views instance will create the views of all the targets defined, so if 2 targets have the same viewName, the same instance of the view will be displayed.
objectoOptions.config?

this config allows all the values oOptions.targets.anyName allows, these will be the default values for properties used in the target.
For example if you are only using xmlViews in your app you can specify viewType="XML" so you don't have to repeat this in every target.
If a target specifies viewType="JS", the JS will be stronger than the XML here is an example.


{
    config: {
        viewType : "XML"
    }
    targets : {
        xmlTarget : {
            ...
        },
        jsTarget : {
            viewType : "JS"
            ...
        }
    }
}

Then the effective config that will be used looks like this:

{
    xmlTarget : {
        // coming from the defaults
        viewType : "XML"
        ...
    },
    jsTarget : {
       // XML is overwritten by the "JS" of the targets property
       viewType : "JS"
      ...
    }
}

stringoOptions.config.rootView?The id of the rootView - This should be the id of the view that contains the control with the controlId since the control will be retrieved by calling the sap.ui.core.mvc.View#byId function of the rootView. If you are using a component and add the routing.targets do not set this parameter, since the component will set the rootView to the view created by the sap.ui.core.UIComponent#createContent function. If you specify the "parent" property of a target, the control will not be searched in the root view but in the view Created by the parent (see parent documentation).
booleanoOptions.config.async?, Default: false@since 1.34 Whether the views which are created through this Targets are loaded asyncly. This option can be set only when the Targets is used standalone without the involvement of a Router. Otherwise the async option is inherited from the Router.
objectoOptions.targetsOne or multiple targets in a map.
objectoOptions.targets.anyName

a new target, the key severs as a name. An example:


{
    targets: {
        welcome: {
            viewName: "Welcome",
            viewType: "XML",
            ....
            // Other target parameters
        },
        goodbye: {
            viewName: "Bye",
            viewType: "JS",
            ....
            // Other target parameters
        }
    }
}

This will create two targets named 'welcome' and 'goodbye' you can display both of them or one of them using the display function.

stringoOptions.targets.anyName.viewName

The name of a view that will be created. To place the view into a Control use the controlAggregation and controlId. Views will only be created once per viewName.


{
    targets: {
        // If display("masterWelcome") is called, the master view will be placed in the 'MasterPages' of a control with the id splitContainter
        masterWelcome: {
            viewName: "Welcome",
            controlId: "splitContainer",
            controlAggregation: "masterPages"
        },
        // If display("detailWelcome") is called after the masterWelcome, the view will be removed from the master pages and added to the detail pages, since the same instance is used. Also the controls inside of the view will have the same state.
        detailWelcome: {
            // same view here, that's why the same instance is used
            viewName: "Welcome",
            controlId: "splitContainer",
            controlAggregation: "detailPages"
        }
    }
}

If you want to have a second instance of the welcome view you can use the following:


// Some code you execute before you display the taget named 'detailWelcome':
var oView = sap.ui.view(({ viewName : "Welcome", type : sap.ui.core.mvc.ViewType.XML});
oTargets.getViews().setView("WelcomeWithAlias", oView)

{
    targets: {
        // If display("masterWelcome") is called, the master viewName will be placed in the 'MasterPages' of a control with the id splitContainter
        masterWelcome: {
            viewName: "Welcome",
            controlId: "splitContainer",
            controlAggregation: "masterPages"
        },
        // If display("detailWelcome") is called after the masterWelcome, a second instance with an own controller instance will be added in the detail pages.
        detailWelcome: {
            // same viewName here, that's why the same instance is used
            viewName: "WelcomeWithAlias",
            controlId: "splitContainer",
            controlAggregation: "detailPages"
        }
    }
}

stringoOptions.targets.anyName.viewType?The type of the view that is going to be created. These are the supported types: sap.ui.core.mvc.ViewType. You always have to provide a viewType except if you are using sap.ui.core.routing.Views#setView.
stringoOptions.targets.anyName.viewPath?A prefix that will be prepended in front of the viewName.
Example: viewName is set to "myView" and viewPath is set to "myApp" - the created viewName will be "myApp.myView".
stringoOptions.targets.anyName.viewId?The id of the created view. This is will be prefixed with the id of the component set to the views instance provided in oOptions.views. For details see sap.ui.core.routing.Views#getView.
stringoOptions.targets.anyName.targetParent?The id of the parent of the controlId - This should be the id of the view that contains your controlId, since the target control will be retrieved by calling the sap.ui.core.mvc.View#byId function of the targetParent. By default, this will be the view created by a component, so you do not have to provide this parameter. If you are using children, the view created by the parent of the child is taken. You only need to specify this, if you are not using a Targets instance created by a component and you should give the id of root view of your application to this property.
stringoOptions.targets.anyName.controlId?The id of the control where you want to place the view created by this target. The view of the target will be put into this container Control, using the controlAggregation property. You have to specify both properties or the target will not be able to place itself. An example for containers are sap.ui.ux3.Shell with the aggregation 'content' or a sap.m.NavContainer with the aggregation 'pages'.
stringoOptions.targets.anyName.controlAggregation?The name of an aggregation of the controlId, that contains views. Eg: a sap.m.NavContainer has an aggregation 'pages', another Example is the sap.ui.ux3.Shell it has 'content'.
booleanoOptions.targets.anyName.clearControlAggregation?Defines a boolean that can be passed to specify if the aggregation should be cleared - all items will be removed - before adding the View to it. When using a sap.ui.ux3.Shell this should be true. For a sap.m.NavContainer it should be false. When you use the sap.m.routing.Router the default will be false.
stringoOptions.targets.anyName.parent?

A reference to another target, using the name of the target. If you display a target that has a parent, the parent will also be displayed. Also the control you specify with the controlId parameter, will be searched inside of the view of the parent not in the rootView, provided in the config. The control will be searched using the byId function of a view. When it is not found, the global id is checked.
The main usecase for the parent property is placing a view inside a smaller container of a view, which is also created by targets. This is useful for lazy loading views, only if the user really navigates to this part of your application.
Example: Our aim is to lazy load a tab of an IconTabBar (a control that displays a view initially and when a user clicks on it the view changes). It's a perfect candidate to lazy load something inside of it.
Example app structure:
We have a rootView that is returned by the createContent function of our UIComponent. This view contains an sap.m.App control with the id 'myApp'


<View xmlns="sap.m">
    <App id="myApp"/>
</View>

an xml view called 'Detail'

<View xmlns="sap.m">
    <IconTabBar>
        <items>
            <IconTabFilter>
                <!-- content of our first tab -->
            <IconTabFilter>
            <IconTabFilter id="mySecondTab">
                <!-- nothing here, since we will lazy load this one with a target -->
            <IconTabFilter>
        </items>
    </IconTabBar>
</View>

and a view called 'SecondTabContent', this one contains our content we want to have lazy loaded. Now we need to create our Targets instance with a config matching our app:

    new Targets({
        //Creates our views except for root, we created this one before - when using a component you
        views: new Views(),
        config: {
            // all of our views have that type
            viewType: 'XML',
            // a reference to the app control in the rootView created by our UIComponent
            controlId: 'myApp',
            // An app has a pages aggregation where the views need to be put into
            controlAggregation: 'pages'
        },
        targets: {
            detail: {
                viewName: 'Detail'
            },
            secondTabContent: {
                // A reference to the detail target defined above
                parent: 'detail',
                // A reference to the second Tab container in the Detail view. Here the target does not look in the rootView, it looks in the Parent view (Detail).
                controlId: 'mySecondTab',
                // An IconTabFilter has an aggregation called content so we need to overwrite the pages set in the config as default.
                controlAggregation: 'content',
                // A view containing the content
                viewName: 'SecondTabContent'
            }
        }
    });

Now if we call oTargets.display("secondTabContent") , 2 views will be created: Detail and SecondTabContent. The 'Detail' view will be put into the pages aggregation of the App. And afterwards the 'SecondTabContent' view will be put into the content Aggregation of the second IconTabFilter. So a parent will always be created before the target referencing it.

Event Detail
display(oEvent)

Will be fired when a target is displayed

Could be triggered by calling the display function or by the sap.ui.core.routing.Router when a target is referenced in a matching route.

Parameters:
objectoEvent
sap.ui.base.EventProvideroEvent.getSource
objectoEvent.getParameters
objectoEvent.getParameters.viewThe view that got displayed.
objectoEvent.getParameters.controlThe control that now contains the view in the controlAggregation
objectoEvent.getParameters.configThe options object passed to the constructor sap.ui.core.routing.Targets
objectoEvent.getParameters.nameThe name of the target firing the event
objectoEvent.getParameters.dataThe data passed into the sap.ui.core.routing.Targets#display function
titleChanged(oEvent)

Will be fired when the title of the "TitleTarget" has been changed.

A "TitleTarget" is resolved as the following:
 1. When the {@link sap.ui.core.routing.Targets#display|display} is called with only one target, the "TitleTarget" is resolved with this target when its {@link sap.ui.core.routing.Targets#constructor|title} options is set.
 2. When the {@link sap.ui.core.routing.Targets#display|display} is called with more than one target, the "TitleTarget" is resolved by default with the first target which has a {@link sap.ui.core.routing.Targets#constructor|title} option.
 3. When the 'sTitleTarget' parameter of {@link sap.ui.core.routing.Targets#display|display} is given, this specific target is then used as the "TitleTarget".

Parameters:
objectoEvent
sap.ui.base.EventProvideroEvent.getSource
objectoEvent.getParameters
stringoEvent.getParameters.titleThe current displayed title
stringoEvent.getParameters.nameThe name of the displayed target
Method Detail
sap.ui.core.routing.Targets.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.core.routing.Targets 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.base.EventProvider.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.ui.core.routing.Targets.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.core.routing.Targets.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addTarget(sName, oTarget): sap.ui.core.routing.Targets
Creates a target by using the given name and options. If there's already a target with the same name exists, the existing target is kept from being overwritten and an error log will be written to the development console.
Parameters:
stringsNamethe name of a target
objectoTargetthe options of a target. The option names are the same as the ones in "oOptions.targets.anyName" of undefined.
Returns:
sap.ui.core.routing.TargetsTargets itself for method chaining
attachDisplay(oData?, fnFunction, oListener?): sap.ui.core.routing.Targets
Attach event-handler fnFunction to the 'display' event of this sap.ui.core.routing.Targets.
Parameters:
objectoData?The object, that should be passed along with the event-object when firing the event.
functionfnFunctionThe function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
objectoListener?Object on which to call the given function.
Returns:
sap.ui.core.routing.Targetsthis to allow method chaining
attachTitleChanged(oData?, fnFunction, oListener?): sap.ui.core.routing.Targets
Attach event-handler fnFunction to the 'titleChanged' event of this sap.ui.core.routing.Targets.
Parameters:
objectoData?The object, that should be passed along with the event-object when firing the event.
functionfnFunctionThe function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
objectoListener?Object on which to call the given function.
Returns:
sap.ui.core.routing.Targetsthis to allow method chaining
Destroys the targets instance and all created targets. Does not destroy the views instance passed to the constructor. It has to be destroyed separately.
Returns:
sap.ui.core.routing.Targetsthis for chaining.
detachDisplay(fnFunction, oListener): sap.ui.core.routing.Targets

Detach event-handler fnFunction from the 'display' event of this sap.ui.core.routing.Targets.

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

Parameters:
functionfnFunctionThe function to call, when the event occurs.
objectoListenerObject on which the given function had to be called.
Returns:
sap.ui.core.routing.Targetsthis to allow method chaining
detachTitleChanged(fnFunction, oListener): sap.ui.core.routing.Targets

Detach event-handler fnFunction from the 'titleChanged' event of this sap.ui.core.routing.Targets.

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

Parameters:
functionfnFunctionThe function to call, when the event occurs.
objectoListenerObject on which the given function had to be called.
Returns:
sap.ui.core.routing.Targetsthis to allow method chaining
display(vTargets, oData?, sTitleTarget?): sap.ui.core.routing.Targets|Promise
Creates a view and puts it in an aggregation of the specified control.
Parameters:
string|string[]vTargetsthe key of the target as specified in the undefined. To display multiple targets you may also pass an array of keys.
objectoData?an object that will be passed to the display event in the data property. If the target has parents, the data will also be passed to them.
stringsTitleTarget?the name of the target from which the title option is taken for firing the titleChanged event
Returns:
sap.ui.core.routing.Targets|Promisethis pointer for chaining or a Promise
fireDisplay(mArguments?): sap.ui.core.routing.Targets
Fire event created to attached listeners.
Parameters:
objectmArguments?the arguments to pass along with the event.
Returns:
sap.ui.core.routing.Targetsthis to allow method chaining
Returns a target by its name (if you pass myTarget: { view: "myView" }) in the config myTarget is the name.
Parameters:
string|string[]vNamethe name of a single target or the name of multiple targets
Returns:
sap.ui.core.routing.Target|undefined|sap.ui.core.routing.Target[]The target with the coresponding name or undefined. If an array way passed as name this will return an array with all found targets. Non existing targets will not be returned but will log an error.
Returns the views instance passed to the constructor
Returns:
sap.ui.core.routing.Viewsthe views instance