| //////////////////////////////////////////////////////////////////////////////// |
| // |
| // Licensed to the Apache Software Foundation (ASF) under one or more |
| // contributor license agreements. See the NOTICE file distributed with |
| // this work for additional information regarding copyright ownership. |
| // The ASF licenses this file to You under the Apache License, Version 2.0 |
| // (the "License"); you may not use this file except in compliance with |
| // the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| // |
| //////////////////////////////////////////////////////////////////////////////// |
| |
| package mx.resources |
| { |
| |
| import flash.events.IEventDispatcher; |
| import flash.system.ApplicationDomain; |
| import flash.system.SecurityDomain; |
| |
| /** |
| * The APIs of the IResourceManager interface |
| * provide localization support for Flex applications. |
| * |
| * <p>There are three main concepts involved in localization: |
| * locales, resources, and resource bundles.</p> |
| * |
| * <p>A locale specifies a language and a country |
| * for which your application has been localized. |
| * For example, the locale <code>"en_US"</code> |
| * specifies English as spoken in the United States. |
| * (See the mx.resources.Locale class for more information.)</p> |
| * |
| * <p>A resource is a named value that is locale-dependent. |
| * For example, your application might have a resource |
| * whose name is <code>"OPEN"</code> |
| * and whose value for an English locale is <code>"Open"</code> |
| * but whose value for a French locale is <code>"Ouvrir"</code>.</p> |
| * |
| * <p>A resource bundle is a named group of resources |
| * whose values have been localized for a particular locale. |
| * A resource bundle is identified by the combination of its |
| * <code>bundleName</code> and its <code>locale</code>, |
| * and has a <code>content</code> object that contains |
| * the name-value pairs for the bundle's resources. |
| * See the documentation for mx.resources.IResourceBundle |
| * for information about how you typically create resource |
| * bundles from properties files.</p> |
| * |
| * <p>A single ResourceManager object implementing the IResourceManager |
| * interface manages multiple resource bundles, possibly for multiple |
| * locales, and provides access to the resources that they contain. |
| * For example, you can retrieve a specific resource as a String by calling |
| * <code>resourceManager.getString(bundleName, resourceName)</code>.</p> |
| * |
| * <p>All classes that extend UIComponent, Formatter, or Validator |
| * have a <code>resourceManager</code> property |
| * that provides a reference to the object implementing this interface. |
| * Other classes can call <code>ResourceManager.getInstance()</code> |
| * to obtain this object.</p> |
| * |
| * <p>Resource retrieval methods such as <code>getString()</code> |
| * search for resources in the locales specified |
| * by the <code>localeChain</code> property. |
| * By changing this property, you can make your application |
| * suddenly use, for example, Japanese rather than English resources.</p> |
| * |
| * <p>When your application starts, the ResourceManager is automatically |
| * populated with whatever resource bundles were compiled |
| * into the application. |
| * If you create a code module, by default the resources that its classes |
| * need are compiled into the module. |
| * When the module is loaded into an application, any bundles that the |
| * application does not already have are added to the ResourceManager.</p> |
| * |
| * <p>You can compile "resource modules" which have only resources in them, |
| * and load them with the <code>loadResourceModule()</code> method |
| * of IResourceManager. |
| * With resource modules, you can support multiple locales by loading |
| * the resources you need at run time rather than compiling them into |
| * your application.</p> |
| * |
| * <p>Although the ResourceManager is normally populated with resource bundles |
| * that were compiled into your application or loaded from modules, |
| * you can also programmatically create resource bundles and add them |
| * to the ResourceManager yourself with the <code>addResourceBundle()</code> |
| * method.</p> |
| * |
| * @see mx.resources.ResourceManager |
| * @see mx.resources.IResourceBundle |
| * @see mx.resources.ResourceBundle |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| public interface IResourceManager extends IEventDispatcher |
| { |
| //-------------------------------------------------------------------------- |
| // |
| // Properties |
| // |
| //-------------------------------------------------------------------------- |
| |
| //---------------------------------- |
| // localeChain |
| //---------------------------------- |
| |
| /** |
| * An Array of locale Strings, such as <code>[ "en_US" ]</code>, |
| * which specifies one or more locales to be searched for resources. |
| * |
| * <p>When you call the ResourceManager methods <code>getObject()</code>, |
| * <code>getString()</code>, <code>getStringArray()</code>, |
| * <code>getNumber()</code>, <code>getInt()</code>, |
| * <code>getUint()</code>, <code>getBoolean()</code>, or |
| * <code>getClass()</code> to get the value of a resource, |
| * you specify a bundle name and a resource name, |
| * but not a locale. |
| * The ResourceManager starts with the first locale in the |
| * <code>localeChain</code> and looks for a ResourceBundle |
| * with the specified bundle name for that locale. |
| * If such a ResourceBundle exists, and the specified resource |
| * exists in it, then the value of that resource is returned. |
| * Otherwise, the ResourceManager proceeds on to the other |
| * locales in the <code>localeChain</code>.</p> |
| * |
| * <p>This scheme makes it possible to have locales that do not |
| * necessarily contain a complete set of localized resources. |
| * For example, if you are localizing your application for |
| * Indian English rather than U.S. English, you need only |
| * supply resources for the <code>en_IN</code> locale in which the |
| * Indian spelling or usage differs from that in the U.S., |
| * and then set the <code>localeChain</code> property |
| * to <code>[ "en_IN", "en_US" ]</code>.</p> |
| * |
| * <p>Many framework classes assume that they can always |
| * obtain, from some locale, the resources that they expect, |
| * and they will throw errors if they cannot do so. |
| * Therefore, you must ensure that the <code>localeChain</code> |
| * always contains a complete set of resources. |
| * Unless you have done a complete localization of all the |
| * framework's resources as well as your own application's |
| * resources, you can keep the <code>"en_US"</code> locale |
| * at the end of your <code>localeChain</code> to ensure this.</p> |
| * |
| * <p>Setting this property causes the ResourceManager to dispatch |
| * a <code>"change"</code> Event.</p> |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function get localeChain():Array /* of String */; |
| |
| /** |
| * @private |
| */ |
| function set localeChain(value:Array /* of String */):void; |
| |
| //-------------------------------------------------------------------------- |
| // |
| // Methods |
| // |
| //-------------------------------------------------------------------------- |
| |
| /** |
| * Begins loading a resource module containing resource bundles. |
| * |
| * <p>Each call to this method returns a new event-dispatching object |
| * that you can use to learn how the loading is progressing |
| * and whether it completes successfully or results in an error. |
| * This object dispatches <code>ResourceEvent.PROGRESS</code>, |
| * <code>ResourceEvent.COMPLETE</code>, and |
| * <code>ResourceEvent.ERROR</code> events.</p> |
| * |
| * <p>When the module has been loaded, the resource bundles |
| * are added to the ResourceManager, but the <code>localeChain</code> |
| * is left unchanged. |
| * If the <code>update</code> parameter is <code>true</code>, |
| * the <code>update()</code> method will be called.</p> |
| * |
| * @param url The URL from which to load the resource module. |
| * |
| * @param update Whether to call |
| * the <code>update()</code> method when the module finishes loading. |
| * |
| * @param applicationDomain The ApplicationDomain passed to the |
| * <code>load()</code> method of the IModuleInfo class |
| * that loads the resource module. |
| * This parameter is optional and defaults to <code>null</code>. |
| * |
| * @param securityDomain The SecurityDomain passed to the |
| * <code>load()</code> method of the IModuleInfo class |
| * that loads the resource module. |
| * This parameter is optional and defaults to <code>null</code>. |
| * |
| * @return An object that is associated with this particular load operation |
| * that dispatches <code>ResourceEvent.PROGRESS</code>, |
| * <code>ResourceEvent.COMPLETE</code>, and |
| * <code>ResourceEvent.ERROR</code> events. |
| * |
| * @see mx.events.ResourceEvent |
| * @see mx.resources.IResourceManager#update() |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function loadResourceModule(url:String, update:Boolean = true, |
| applicationDomain:ApplicationDomain = null, |
| securityDomain:SecurityDomain = null): |
| IEventDispatcher; |
| |
| /** |
| * Begins unloading a loaded resource module. |
| * |
| * <p>When the module is unloaded, its resource bundles |
| * are removed from the ResourceManager, but the <code>localeChain</code> |
| * is left unchanged. |
| * If the <code>update</code> parameter is <code>true</code>, |
| * the <code>update()</code> method will be called.</p> |
| * |
| * @param url The URL that was used to load the resource module. |
| * |
| * @param update Whether to call |
| * the <code>update()</code> method when the module finishes unloading. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function unloadResourceModule(url:String, update:Boolean = true):void; |
| |
| /** |
| * Adds the specified ResourceBundle to the ResourceManager |
| * so that its resources can be accessed by ResourceManager |
| * methods such as <code>getString()</code>. |
| * |
| * @param resourceBundle The resource bundle to be added. |
| * @param useWeakReference Determines if the ResourceManager |
| * keeps a weak reference to the resource bundle. |
| * If <code>useWeakReference</code> is <code>true</code> then the ResourceManager |
| * provides a weak reference to the resource bundle. When the |
| * caller chooses to use a weak reference it becomes the |
| * caller's responsibility to keep a hard reference the resource bundle |
| * so it is not garbaged collected prematurely. If <code>useWeakReference</code> is |
| * <code>false</code>, the ResourceManager keeps a hard reference to the resource |
| * bundle so it will not be garbage collected. |
| * |
| * <p>When a Flex sub-application or module automatically adds its compiled |
| * resource bundles to the ResourceManager, it calls the <code>addResourceBundle()</code> |
| * with <code>useWeakReference</code> set to <code>true</code>, to avoid becoming pinned in memory. |
| * If you create resource bundles at runtime in a sub-application or |
| * module, you should do the same. You then need to hold on to these |
| * resource bundles with a hard reference to prevent them from being |
| * garbage collected.</p> |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function addResourceBundle(resourceBundle:IResourceBundle, |
| useWeakReference:Boolean = false):void; |
| |
| /** |
| * Removes the specified ResourceBundle from the ResourceManager |
| * so that its resources can no longer be accessed by ResourceManager |
| * methods such as <code>getString()</code>. |
| * |
| * @param locale A locale string such as <code>"en_US"</code>. |
| * |
| * @param bundleName A bundle name such as <code>"MyResources"</code>. |
| * |
| * @see mx.resources.IResourceBundle |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function removeResourceBundle(locale:String, bundleName:String):void; |
| |
| /** |
| * Removes all ResourceBundles for the specified locale |
| * from the ResourceManager so that their resources |
| * can no longer be accessed by ResourceManager methods |
| * such as <code>getString()</code>. |
| * |
| * @param locale A locale string such as <code>"en_US"</code>. |
| * |
| * @see mx.resources.IResourceBundle |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function removeResourceBundlesForLocale(locale:String):void; |
| |
| /** |
| * Dispatches a <code>change</code> event from the |
| * ResourceManager. |
| * |
| * <p>This causes binding expressions to re-evaluate |
| * if they involve the ResourceManager methods |
| * <code>getObject()</code>, <code>getString()</code>, |
| * <code>getStringArray()</code>, <code>getNumber()</code>, |
| * <code>getInt()</code>, <code>getUint()</code>, |
| * <code>getBoolean()</code>, or <code>getClass()</code>.</p> |
| * |
| * <p>This also causes the <code>resourcesChanged()</code> method |
| * of a UIComponent, Formatter, or Validator to execute. |
| * Many components implement this method to update |
| * their state based on the latest resources.</p> |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function update():void; |
| |
| /** |
| * Returns an Array of Strings specifying all locales for which |
| * ResourceBundle objects exist in the ResourceManager. |
| * |
| * <p>The order of locales in this array is not specified.</p> |
| * |
| * @return An Array of locale Strings. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function getLocales():Array /* of String */; |
| |
| /** |
| * Returns an Array of Strings specifying all locales for which |
| * ResourceBundle objects exist in the ResourceManager, |
| * ordered using user preferences as reported by |
| * <code>Capabilities.language</code> or |
| * <code>Capabilities.languages</code>. |
| * |
| * @return An Array of locale Strings. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function getPreferredLocaleChain():Array /* of String */; |
| |
| /** |
| * Returns an Array of Strings specifying the bundle names |
| * for all ResourceBundle objects that exist in the ResourceManager |
| * and that belong to the specified locale. |
| * |
| * <p>The order of bundle names in this Array is not specified.</p> |
| * |
| * @param locale A locale string such as <code>"en_US"</code>. |
| * |
| * @return An Array of bundle names. |
| * |
| * @see mx.resources.IResourceBundle |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function getBundleNamesForLocale(locale:String):Array /* of String */; |
| |
| /** |
| * Returns a ResourceBundle with the specified <code>locale</code> |
| * and <code>bundleName</code> that has been previously added |
| * to the ResourceManager with <code>addResourceBundle()</code>. |
| * If no such ResourceBundle exists, this method returns <code>null</code>. |
| * |
| * @param locale A locale string such as <code>"en_US"</code>. |
| * |
| * @param bundleName A bundle name such as <code>"MyResources"</code>. |
| * |
| * @return The ResourceBundle with the specified <code>locale</code> |
| * and <code>bundleName</code> if one exists; otherwise <code>null</code>. |
| * |
| * @see mx.resources.IResourceBundle |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function getResourceBundle(locale:String, |
| bundleName:String):IResourceBundle; |
| |
| /** |
| * Searches the locales in the <code>localeChain</code> |
| * for the specified resource and returns |
| * the first resource bundle in which it is found. |
| * If the resource isn't found, this method returns <code>null</code>. |
| * |
| * @param bundleName A bundle name such as <code>"MyResources"</code>. |
| * |
| * @param resourceName The name of a resource in the resource bundle. |
| * |
| * @return The first ResourceBundle in the <code>localeChain</code> |
| * that contains the specified resource, or <code>null</code>. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function findResourceBundleWithResource( |
| bundleName:String, |
| resourceName:String):IResourceBundle; |
| |
| [Bindable("change")] |
| |
| /** |
| * Gets the value of a specified resource as an Object. |
| * |
| * <p>The value is returned exactly as it is stored |
| * in the <code>content</code> Object of the ResourceBundle, |
| * with no conversion. |
| * If the resource was compiled from a properties files, |
| * the resource value in the <code>content</code> Object |
| * is always a String unless you used the <code>Embed()</code> |
| * or <code>ClassReference()</code> directive, in which case |
| * it is a Class. |
| * Use the <code>getString()</code>, <code>getStringArray()</code>, |
| * <code>getNumber()</code>, <code>getInt()</code> |
| * <code>getUint()</code>, <code>getBoolean()</code>, and |
| * <code>getClass()</code> methods to convert the value |
| * to more specific types.</p> |
| * |
| * <p>If the specified resource is not found, |
| * this method returns <code>undefined</code>.</p> |
| * |
| * @param bundleName The name of a resource bundle. |
| * |
| * @param resourceName The name of a resource in the resource bundle. |
| * |
| * @param locale A specific locale to be used for the lookup, |
| * or <code>null</code> to search all locales |
| * in the <code>localeChain</code>. |
| * This parameter is optional and defaults to <code>null</code>; |
| * you should seldom need to specify it. |
| * |
| * @return The resource value, exactly as it is stored |
| * in the <code>content</code> Object, |
| * or <code>undefined</code> if the resource is not found. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function getObject(bundleName:String, resourceName:String, |
| locale:String = null):*; |
| |
| [Bindable("change")] |
| |
| /** |
| * Gets the value of a specified resource as a String, |
| * after substituting specified values for placeholders. |
| * |
| * <p>This method calls <code>getObject()</code> |
| * and then casts the result to a String.</p> |
| * |
| * <p>If a <code>parameters</code> Array is passed to this method, |
| * the parameters in it are converted to Strings |
| * and then substituted, in order, for the placeholders |
| * <code>"{0}"</code>, <code>"{1}"</code>, and so on, in the String |
| * before it is returned.</p> |
| * |
| * <p>If the specified resource is not found, |
| * this method returns <code>null</code>.</p> |
| * |
| * @param bundleName The name of a resource bundle. |
| * |
| * @param resourceName The name of a resource in the resource bundle. |
| * |
| * @param parameters An Array of parameters that are |
| * substituted for the placeholders. |
| * Each parameter is converted to a String with the <code>toString()</code> method |
| * before being substituted. |
| * |
| * @param locale A specific locale to be used for the lookup, |
| * or <code>null</code> to search all locales |
| * in the <code>localeChain</code>. |
| * This parameter is optional and defaults to <code>null</code>; |
| * you should seldom need to specify it. |
| * |
| * @return The resource value, as a String, |
| * or <code>null</code> if it is not found. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function getString(bundleName:String, resourceName:String, |
| parameters:Array = null, |
| locale:String = null):String; |
| |
| [Bindable("change")] |
| |
| /** |
| * Gets the value of a specified resource as an Array of Strings. |
| * |
| * <p>This method assumes that the resource value is a String |
| * containing a comma-separated list of items. |
| * It calls the <code>getString()</code> method, splits the String |
| * into items at the commas, and trims white space |
| * before and after each item. |
| * It is useful if you have written a line such as:</p> |
| * |
| * <pre> |
| * COUNTRIES=India, China, Japan |
| * </pre> |
| * |
| * <p>in a properties file and you want to obtain the value |
| * <code>[ "India", "China", "Japan" ]</code> |
| * rather than the value <code>"India, China, Japan"</code>.</p> |
| * |
| * <p>If the specified resource is not found, |
| * this method returns <code>null</code>.</p> |
| * |
| * @param bundleName The name of a resource bundle. |
| * |
| * @param resourceName The name of a resource in the resource bundle. |
| * |
| * @param locale A specific locale to be used for the lookup, |
| * or <code>null</code> to search all locales |
| * in the <code>localeChain</code>. |
| * This parameter is optional and defaults to <code>null</code>; |
| * you should seldom need to specify it. |
| * |
| * @return The resource value, as an Array of Strings, |
| * or <code>null</code> if it is not found. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function getStringArray(bundleName:String, |
| resourceName:String, |
| locale:String = null):Array /* of String */; |
| |
| [Bindable("change")] |
| |
| /** |
| * Gets the value of a specified resource as a Number. |
| * |
| * <p>This method calls <code>getObject()</code> |
| * and casts the result to a Number. |
| * It is useful if you have written a line such as:</p> |
| * |
| * <pre> |
| * LONGITUDE=170.3 |
| * </pre> |
| * |
| * <p>in a properties file and want to obtain the value |
| * 170.3 rather than <code>"170.3"</code>.</p> |
| * |
| * <p>If the specified resource is not found, |
| * this method returns <code>NaN</code>.</p> |
| * |
| * @param bundleName The name of a resource bundle. |
| * |
| * @param resourceName The name of a resource in the resource bundle. |
| * |
| * @param locale A specific locale to be used for the lookup, |
| * or <code>null</code> to search all locales |
| * in the <code>localeChain</code>. |
| * This parameter is optional and defaults to <code>null</code>; |
| * you should seldom need to specify it. |
| * |
| * @return The resource value, as a Number, |
| * or <code>NaN</code> if it is not found. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function getNumber(bundleName:String, resourceName:String, |
| locale:String = null):Number; |
| |
| [Bindable("change")] |
| |
| /** |
| * Gets the value of a specified resource as an int. |
| * |
| * <p>This method calls <code>getObject()</code> |
| * and casts the result to an int. |
| * It is useful if you have written a line such as:</p> |
| * |
| * <pre> |
| * MINIMUM=5 |
| * </pre> |
| * |
| * <p>in a properties file and want to obtain the value |
| * 5 rather than <code>"5"</code>.</p> |
| * |
| * <p>If the specified resource is not found, |
| * this method returns 0.</p> |
| * |
| * @param bundleName The name of a resource bundle. |
| * |
| * @param resourceName The name of a resource in the resource bundle. |
| * |
| * @param locale A specific locale to be used for the lookup, |
| * or <code>null</code> to search all locales |
| * in the <code>localeChain</code>. |
| * This parameter is optional and defaults to <code>null</code>; |
| * you should seldom need to specify it. |
| * |
| * @return The resource value, as an int, |
| * or 0 if it is not found. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function getInt(bundleName:String, resourceName:String, |
| locale:String = null):int; |
| |
| [Bindable("change")] |
| |
| /** |
| * Gets the value of a specified resource as a uint. |
| * |
| * <p>This method calls the <code>getObject()</code> method |
| * and casts the result to a uint. |
| * It is useful if you have written a line such as:</p> |
| * |
| * <pre> |
| * MINIMUM=5 |
| * </pre> |
| * |
| * <p>in a properties file and want to obtain the value |
| * 5 rather than <code>"5"</code>.</p> |
| * |
| * <p>If the specified resource is not found, |
| * this method returns 0.</p> |
| * |
| * @param bundleName The name of a resource bundle. |
| * |
| * @param resourceName The name of a resource in the resource bundle. |
| * |
| * @param locale A specific locale to be used for the lookup, |
| * or <code>null</code> to search all locales |
| * in the <code>localeChain</code>. |
| * This parameter is optional and defaults to <code>null</code>; |
| * you should seldom need to specify it. |
| * |
| * @return The resource value, as a uint, |
| * or 0 if it is not found. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function getUint(bundleName:String, resourceName:String, |
| locale:String = null):uint; |
| |
| [Bindable("change")] |
| |
| /** |
| * Gets the value of a specified resource as a Boolean. |
| * |
| * <p>This method first calls <code>getString()</code> |
| * and converts the result to lowercase. |
| * It then returns <code>true</code> |
| * if the result was <code>"true"</code>. |
| * and <code>false</code> otherwise.</p> |
| * |
| * <p>If the specified resource is not found, |
| * this method returns <code>false</code>.</p> |
| * |
| * @param bundleName The name of a resource bundle. |
| * |
| * @param resourceName The name of a resource in the resource bundle. |
| * |
| * @param locale A specific locale to be used for the lookup, |
| * or <code>null</code> to search all locales |
| * in the <code>localeChain</code>. |
| * This parameter is optional and defaults to <code>null</code>; |
| * you should seldom need to specify it. |
| * |
| * @return The resource value, as a Boolean, |
| * or <code>false</code> if it is not found. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function getBoolean(bundleName:String, resourceName:String, |
| locale:String = null):Boolean; |
| |
| [Bindable("change")] |
| |
| /** |
| * Gets the value of a specified resource as a Class. |
| * |
| * <p>This method calls <code>getObject()</code> |
| * and coerces it to type Class using the <code>as</code> operator. |
| * The result will be <code>null</code> if the resource value |
| * was not a class reference. |
| * It is useful if you have written a lines such as</p> |
| * |
| * <pre> |
| * IMAGE=Embed("image.jpg") |
| * BUTTON_SKIN=ClassReference("skins.ButtonSkin_en_US") |
| * </pre> |
| * |
| * <p>in a properties file and want to obtain |
| * the Class that the <code>Embed()</code> |
| * or <code>ClassReference()</code> directive produced.</p> |
| * |
| * <p>If the specified resource is not found, |
| * this method returns <code>null</code>.</p> |
| * |
| * @param bundleName The name of a resource bundle. |
| * |
| * @param resourceName The name of a resource in the resource bundle. |
| * |
| * @param locale A specific locale to be used for the lookup, |
| * or <code>null</code> to search all locales |
| * in the <code>localeChain</code>. |
| * This parameter is optional and defaults to <code>null</code>; |
| * you should seldom need to specify it. |
| * |
| * @return The resource value, as a <code>Class</code>, |
| * or <code>null</code> if it is not found. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function getClass(bundleName:String, resourceName:String, |
| locale:String = null):Class; |
| |
| /** |
| * Creates instances of all ResourceBundle subclasses that were compiled into the SWF |
| * and adds them to the ResourceManager. |
| * |
| * <p>For example, if the <code>locales</code> parameter is [ "en_US", "ja_JP" ] |
| * and the <code>bundleNames</code> parameter is [ "core", "controls" ], |
| * then four resource bundles will be installed.</p> |
| * |
| * <p>This method is used only by classes that implement the IFlexModuleFactory interface.</p> |
| * |
| * @param applicationDomain The ApplicationDomain that is used to look up the resource bundle |
| * classes by name. |
| * |
| * @param locales An Array of Strings that specify the locales for which the SWF was compiled. |
| * |
| * @param bundleNames An Array of Strings that specify the names of the resource bundles |
| * that were compiled into the SWF. |
| * |
| * @param useWeakReference A flag that specifyies whether the resource bundles should be |
| * intalled into the ResourceManager using a weak reference. |
| * |
| * @return An Array of the ResourceBundle instances that were created |
| * and added to the ResourceManager. |
| * |
| * @see mx.core.IFlexModuleFactory |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function installCompiledResourceBundles( |
| applicationDomain:ApplicationDomain, |
| locales:Array /* of String */, |
| bundleNames:Array /* of String */, |
| useWeakReference:Boolean = false):Array; |
| |
| /** |
| * Initializes the <code>localeChain</code> property of the ResourceManager |
| * using an algorithm that compares the operating system's list of user-preferred |
| * locales with the list of locales available in the SWF. |
| * |
| * <p>For example, if the user has indicated in the operating system that she |
| * prefers French, and the SWF was compiled for the locales en_US, fr_FR, and de_DE, |
| * then the <code>localeChain</code> will be set so that the first locale in it |
| * is fr_FR.</p> |
| * |
| * <p>This method is used only by classes that implement the IFlexModuleFactory interface.</p> |
| * |
| * @param compiledLocales An Array of Strings specifying the locales |
| * for which the SWF was compiled. |
| * |
| * @see mx.core.IFlexModuleFactory |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| function initializeLocaleChain(compiledLocales:Array):void; |
| } |
| |
| } |
