mxResources

Implements internationalization. You can provide any number of resource files on the server using the following format for the filename: name[-en].properties. The en stands for any lowercase 2-character language shortcut (eg. de for german, fr for french).

If the optional language extension is omitted, then the file is used as a default resource which is loaded in all cases. If a properties file for a specific language exists, then it is used to override the settings in the default resource. All entries in the file are of the form key=value. The values may then be accessed in code via get. Lines without equal signs in the properties files are ignored.

Resource files may either be added programmatically using add or via a resource tag in the UI section of the editor configuration file, eg:

<mxEditor>
  <ui>
    <resource basename="examples/resources/mxWorkflow"/>

The above element will load examples/resources/mxWorkflow.properties as well as the language specific file for the current language, if it exists.

Values may contain placeholders of the form {1}...{n} where each placeholder is replaced with the value of the corresponding array element in the params argument passed to mxResources.get. The placeholder {1} maps to the first element in the array (at index 0).

See mxClient.language for more information on specifying the default language or disabling all loading of resources.

Lines that start with a # sign will be ignored.

Special characters

To use unicode characters, use the standard notation (eg. \u8fd1) or %u as a prefix (eg. %u20AC will display a Euro sign). For normal hex encoded strings, use % as a prefix, eg. %F6 will display a “o umlaut” (ö).

See resourcesEncoded to disable this. If you disable this, make sure that your files are UTF-8 encoded.

Summary

mxResources	Implements internationalization.
Variables
resources	Associative array that maps from keys to values.
extension	Specifies the extension used for language files.
resourcesEncoded	Specifies whether or not values in resource files are encoded with \u or percentage.
loadDefaultBundle	Specifies if the default file for a given basename should be loaded.
loadDefaultBundle	Specifies if the specific language file file for a given basename should be loaded.
Functions
isLanguageSupported	Hook for subclassers to disable support for a given language.
getDefaultBundle	Hook for subclassers to return the URL for the special bundle.
getSpecialBundle	Hook for subclassers to return the URL for the special bundle.
add	Adds the default and current language properties file for the specified basename.
parse	Parses the key, value pairs in the specified text and stores them as local resources.
get	Returns the value for the specified resource key.

Variables

resources

Associative array that maps from keys to values.

extension

Specifies the extension used for language files. Default is <mxResourceExtension>.

resourcesEncoded

Specifies whether or not values in resource files are encoded with \u or percentage. Default is false.

loadDefaultBundle

Specifies if the default file for a given basename should be loaded. Default is true.

loadDefaultBundle

Specifies if the specific language file file for a given basename should be loaded. Default is true.

Functions

isLanguageSupported

isLanguageSupported: function( lan )

Hook for subclassers to disable support for a given language. This implementation returns true if lan is in mxClient.languages.

Parameters

lan	The current language.

getDefaultBundle

getDefaultBundle: function( basename,
lan )

Hook for subclassers to return the URL for the special bundle. This implementation returns basename + extension or null if loadDefaultBundle is false.

Parameters

basename	The basename for which the file should be loaded.
lan	The current language.

getSpecialBundle

getSpecialBundle: function( basename,
lan )

Hook for subclassers to return the URL for the special bundle. This implementation returns basename + ‘_’ + lan + extension or null if <loadSpecialBundle> is false or lan equals mxClient.defaultLanguage.

If <mxResources.languages> is not null and mxClient.language contains a dash, then this method checks if isLanguageSupported returns true for the full language (including the dash). If that returns false the first part of the language (up to the dash) will be tried as an extension.

If <mxResources.language> is null then the first part of the language is used to maintain backwards compatibility.

Parameters

basename	The basename for which the file should be loaded.
lan	The language for which the file should be loaded.

add

add: function( basename,
lan )

Adds the default and current language properties file for the specified basename. Existing keys are overridden as new files are added.

Example

At application startup, additional resources may be added using the following code:

mxResources.add('resources/editor');

parse

parse: function( text )

Parses the key, value pairs in the specified text and stores them as local resources.

get

get: function( key,
params,
defaultValue )

Returns the value for the specified resource key.

Example

To read the value for ‘welomeMessage’, use the following:

var result = mxResources.get('welcomeMessage') || '';

This would require an entry of the following form in one of the English language resource files:

welcomeMessage=Welcome to mxGraph!

The part behind the || is the string value to be used if the given resource is not available.

Parameters

key	String that represents the key of the resource to be returned.
params	Array of the values for the placeholders of the form {1}...{n} to be replaced with in the resulting string.
defaultValue	Optional string that specifies the default return value.