Locale - BETA ActionScript® 3 (AS3 Flash) Reference for the Adobe® Flash® Platform API Reference

(Beta)

Package	fl.lang
Class	public class Locale
Inheritance	Locale EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

The fl.lang.Locale class allows you to control how multilanguage text is displayed in a SWF file. The Flash Strings panel allows you to use string IDs instead of string literals in dynamic text fields. This allows you to create a SWF file that displays text loaded from a language-specific XML file. The XML file must use the XML Localization Interchange File Format (XLIFF). There are three ways to display the language-specific strings contained in the XLIFF files:

"automatically at runtime"—Flash Player replaces string IDs with strings from the XML file matching the default system language code returned by flash.system.capabilities.language.
"manually using stage language"—String IDs are replaced by strings at compile time and cannot be changed by Flash Player.
"via ActionScript at runtime"—String ID replacement is controlled using ActionScript at runtime. This option gives you control over both the timing and language of string ID replacement.

You can use the properties and methods of this class when you want to replace the string IDs "via ActionScript at runtime."

All of the properties and methods available are static, which means that they are accessed through the fl.lang.Locale class itself rather than through an instance of the class.

Note: The Locale class is installed in the Flash Authoring classpath and is automatically compiled into your SWF files. Using the Locale class increases the SWF file size slightly since the class is compiled into the SWF.

Related API Elements

flash.system.Capabilities.language

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		autoReplace : Boolean [static] Determines whether strings are replaced automatically after loading the XML file.	Locale
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		languageCodeArray : Array [static] [read-only] An array containing language codes for the languages that have been specified or loaded into the FLA file.	Locale
		stringIDArray : Array [static] [read-only] An array containing all the string IDs in the FLA file.	Locale

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addDelayedInstance(instance:Object, stringID:String):* [static] Adds the {instance, string ID} pair into the internal array for later use.	Locale
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		addXMLPath(langCode:String, path:String):void [static] Adds the {languageCode and languagePath} pair into the internal array for later use.	Locale
		checkXMLStatus():Boolean [static] Returns true if the XML file is loaded; false otherwise.	Locale
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getDefaultLang():String [static] The default language code as set in the Strings panel dialog box or by calling the setDefaultLang() method.	Locale
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initialize():void [static] Automatically determines the language to use and loads the XML language file.	Locale
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		loadLanguageXML(xmlLanguageCode:String, customXmlCompleteCallback:Function = null):void [static] Loads the specified XML language file.	Locale
		loadString(id:String):String [static] Returns the string value associated with the given string ID in the current language.	Locale
		loadStringEx(stringID:String, languageCode:String):String [static] Returns the string value associated with the given string ID and language code.	Locale
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setDefaultLang(langCode:String):void [static] Sets the default language code.	Locale
		setLoadCallback(loadCallback:Function):* [static] Sets the callback function that is called after the XML file is loaded.	Locale
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setString(stringID:String, languageCode:String, stringValue:String):void [static] Sets the new string value of a given string ID and language code.	Locale
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

Method Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Locale - AS3 Flash

Packagesx

Language Elements

Appendixes

Package fl.lang

autoReplace

languageCodeArray

stringIDArray

addDelayedInstance

addXMLPath

checkXMLStatus

getDefaultLang

initialize

loadLanguageXML

loadString

loadStringEx

setDefaultLang

setLoadCallback

setString

	`instance:Object` — Instance name of the text field to populate.

	`stringID:String` — Language string ID.

	`langCode:String` — The language code.

	`path:String` — The XML path to add.

	`xmlLanguageCode:String` — The language code for the XML language file that you want to load.

	`customXmlCompleteCallback:Function` (default = `null`) — Custom callback function to call when XML language file loads.

	`stringID:String` — The identification (ID) number of the string to load.

	`languageCode:String` — The language code.

	`stringID:String` — The identification (ID) number of the string to set.

	`languageCode:String` — The language code.

	`stringValue:String` — A string value.