7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * Provides utilities to support the management of localized resources (strings and formatting patterns).
628b3b052ecff4d1843c7e919951413fbc03e79fSatyen Desai * @module intl
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * The Intl utility provides a central location for managing sets of localized resources (strings and formatting patterns).
628b3b052ecff4d1843c7e919951413fbc03e79fSatyen Desai * @class Intl
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * @uses EventTarget
54c01833b669ee8dbd4b309a4be2faa58e28ab0dAdam Moore * Private method to retrieve the language hash for a given module.
628b3b052ecff4d1843c7e919951413fbc03e79fSatyen Desai * @method _mod
628b3b052ecff4d1843c7e919951413fbc03e79fSatyen Desai * @param {String} module The name of the module
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * @return {Object} The hash of localized resources for the module, keyed by BCP language tag
628b3b052ecff4d1843c7e919951413fbc03e79fSatyen Desai * Sets the active language for the given module.
628b3b052ecff4d1843c7e919951413fbc03e79fSatyen Desai * Returns false on failure, which would happen if the language had not been registered through the <a href="#method_add">add()</a> method.
d894ed8f7003b6c2ec19d5fb3969b6c45f0d7147Satyen Desai * @method setLang
d894ed8f7003b6c2ec19d5fb3969b6c45f0d7147Satyen Desai * @param {String} module The module name.
628b3b052ecff4d1843c7e919951413fbc03e79fSatyen Desai * @param {String} lang The BCP 47 language tag.
54c01833b669ee8dbd4b309a4be2faa58e28ab0dAdam Moore * @return boolean true if successful, false if not.
30551f406370f7c8bf461a833205311de720886dSatyen Desai this.fire("intl:langChange", {module: module, prevVal: currLang, newVal: (lang === ROOT_LANG) ? "" : lang});
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * Get the currently active language for the given module.
628b3b052ecff4d1843c7e919951413fbc03e79fSatyen Desai * @method getLang
d894ed8f7003b6c2ec19d5fb3969b6c45f0d7147Satyen Desai * @param {String} module The module name.
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * @return {String} The BCP 47 language tag.
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * Register a hash of localized resources for the given module and language
d894ed8f7003b6c2ec19d5fb3969b6c45f0d7147Satyen Desai * @method add
d894ed8f7003b6c2ec19d5fb3969b6c45f0d7147Satyen Desai * @param {String} module The module name.
628b3b052ecff4d1843c7e919951413fbc03e79fSatyen Desai * @param {String} lang The BCP 47 language tag.
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * @param {Object} strings The hash of localized values, keyed by the string name.
b07c442afe94f55ef7b93a69046dd8291d1bbaacSatyen Desai * Gets the module's localized resources for the currently active language (as provided by the <a href="#method_getLang">getLang</a> method).
54c01833b669ee8dbd4b309a4be2faa58e28ab0dAdam Moore * Optionally, the localized resources for alternate languages which have been added to Intl (see the <a href="#method_add">add</a> method) can
54c01833b669ee8dbd4b309a4be2faa58e28ab0dAdam Moore * be retrieved by providing the BCP 47 language tag as the lang parameter.
d894ed8f7003b6c2ec19d5fb3969b6c45f0d7147Satyen Desai * @method get
d894ed8f7003b6c2ec19d5fb3969b6c45f0d7147Satyen Desai * @param {String} module The module name.
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * @param {String} key Optional. A single resource key. If not provided, returns a copy (shallow clone) of all resources.
85786151283612d4c36a6189954fe75894b4376fSatyen Desai * @param {String} lang Optional. The BCP 47 language tag. If not provided, the module's currently active language is used.
b07c442afe94f55ef7b93a69046dd8291d1bbaacSatyen Desai * @return String | Object A copy of the module's localized resources, or a single value if key is provided.
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * Gets the list of languages for which localized resources are available for a given module, based on the module
8698ba587fa8ee1d6aa74483b9e5efe8c0f4b701Satyen Desai * meta-data (part of loader). If loader is not on the page, returns an empty array.
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * @method getAvailableLangs
8698ba587fa8ee1d6aa74483b9e5efe8c0f4b701Satyen Desai * @param {String} module The name of the module
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * @return {Array} The array of languages available.
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * Notification event to indicate when the lang for a module has changed. There is no default behavior associated with this event,
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * so the on and after moments are equivalent.
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * @event intl:langChange
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * @param {EventFacade} e The event facade
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * <p>The event facade contains:</p>
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * <dt>module</dt><dd>The name of the module for which the language changed</dd>
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * <dt>newVal</dt><dd>The new language tag</dd>
7251b45ed93bd168e55d3ccd3b45a7f6e1c378c1Satyen Desai * <dt>prevVal</dt><dd>The current language tag</dd>
d894ed8f7003b6c2ec19d5fb3969b6c45f0d7147Satyen DesaiY.Intl.publish("intl:langChange", {emitFacade:true});
cc22ee4dba50c26571d1e3fca1ff042e6671b7e1Dav Glass}, '@VERSION@' ,{requires:['event-custom', 'intl-base']});