Skip to content

Latest commit

 

History

History
83 lines (48 loc) · 4.2 KB

resource-model-91f122a.md

File metadata and controls

83 lines (48 loc) · 4.2 KB

Resource Model

The resource model is used as a wrapper for resource bundles. In data binding you use the resource model instance, for example, to bind texts of a control to language-dependent resource bundle properties.

A resource model is instantiated with a bundleName or a bundleURL. The bundle name is the name of the resource bundle and equals a SAPUI5 module name within the define/require concept. The bundle URL points to a resource bundle. If you use the bundle name, the file must have the .properties suffix. If you do not specify a locale, the system uses the login language: var oModel = new sap.ui.model.resource.ResourceModel({bundleName:"myBundle",locale:"en"});

In this resource model implementation you cannot pass parameters to your texts within the resource bundle. If you have to pass parameters, you must do this on your own. Therefore, you can load the bundle yourself or retrieve it from the model.

var myBundle = oModel.getResourceBundle();

After the resource model has been instantiated, you have a model containing the resource bundle texts as data.

Related Information

Modules and Dependencies

Localization

Resource Bundles

API Reference: sap.ui.model.resource.ResourceModel

Binding Path Syntax for Resource Models

The binding path syntax for the resource model only contains a flat list of properties.

The following example shows a simple resource model that illustrates the possible binding paths: Resource bundle content:

CLOSE_BUTTON_TEXT=Close
OPEN_BUTTON_TEXT=Open
CANCEL_BUTTON_TEXT=Cancel

Binding paths within the model:

CLOSE_BUTTON_TEXT
OPEN_BUTTON_TEXT
CANCEL_BUTTON_TEXT

Binding Texts to a Resource Bundle

If you don't want to use a component or descriptor file, or you want to use a more fine-grained resource bundle, you can declaratively instantiate a resource model in an XML or JSON view. To do so, you define the resource bundle by a name (resourceBundleName property) or a URL (resourceBundleUrl property) and assign an alias (resourceBundleAlias property) for the bundle in the view definition.

The ResourceModel required for binding these texts is created during view instantiation. The model is set as secondary model with the given alias to the view instance. If you want to bind other properties to another model, you have to create the model on your own in the corresponding controller or HTML page and attach it to the view with another alias. The binding itself behaves in the same way as every SAPUI5 data binding and as described above.

  1. Define the following resource bundle content: MY_TEXT=Hello World

  2. To bind this resource bundle content in XML views, insert the following code:

    <core:View resourceBundleName="myBundle"
           resourceBundleAlias="i18n" 
           controllerName="sap.hcm.Address" xmlns="sap.m" xmlns:core="sap.ui.core"
           xmlns:html="http://www.w3.org/1999/xhtml">
   <Panel>
      <Button text="{i18n>MY_TEXT}"/>
   </Panel>
<core:View>