Locale - API-referens för Adobe ActionScript® 3 (AS3 Flash)

Paket	fl.lang
Klass	public class Locale
Arv	Locale EventDispatcher Object

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

Med klassen fl.lang.Locale kan du styra hur flerspråkig text visas i en SWF-fil. På strängpanelen i Flash kan du använda sträng-ID i stället för stränglitteraler i dynamiska textfält. Det innebär att du kan skapa en SWF-fil som visar text som läses in från språkspecifika XML-filer. XML-filen måste ha XLIFF-formatet (XML Localization Interchange File Format). Det finns tre sätt att visa språkspecifika strängar från XLIFF-filer:

"automatically at runtime" – Flash Player ersätter sträng-ID:n med strängar från den XML-fil som matchar systemspråkkoden som returneras av flash.system.capabilities.language.
"manually using stage language" – Sträng-ID:n ersätts med strängar vid kompilering. Detta kan inte ändras i Flash Player.
"via ActionScript at runtime" – Ersättning av sträng-ID:n styrs av ActionScript vid körning. Med detta alternativ anger du vilket språk som gäller vid ersättningen av sträng-ID:n och när det ska ske.

Du kan använda egenskaperna och metoderna i den här klassen när du vill ersätta sträng-ID:n "via ActionScript vid körning".

Alla tillgängliga egenskaper och metoder är statiska, vilket innebär att de används via klassen fl.lang.Locale i stället för via en instans av klassen.

Obs! Klassen installeras i klassökvägen för Flash-redigering och kompileras automatiskt till SWF-filerna. När du använder klassen Locale blir SWF-filen något större eftersom klassen kompileras till SWF-filen.

Relaterade API-element

flash.system.Capabilities.language

Publika egenskaper

Dölj ärvda publika egenskaper

Visa ärvda publika egenskaper

	Egenskap		Definieras med
		autoReplace : Boolean [statisk] Avgör om strängar ska ersättas automatiskt när XML-filen har lästs in.	Locale
		constructor : Object En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans.	Object
		languageCodeArray : Array [statisk] [skrivskyddad] En array som innehåller språkkoder för de språk som har angetts eller lästs in i FLA-filen.	Locale
		stringIDArray : Array [statisk] [skrivskyddad] En array som innehåller alla sträng-ID:n i FLA-filen.	Locale

Publika metoder

Dölj ärvda publika metoder

Visa ärvda publika metoder

	Metod		Definieras med
		addDelayedInstance(instance:Object, stringID:String):* [statisk] Lägger till paret {instance, string ID} i den interna arrayen för senare användning.	Locale
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registrerar ett händelseavlyssnarobjekt för ett EventDispatcher-objekt så att avlyssnaren får meddelanden om händelser.	EventDispatcher
		addXMLPath(langCode:String, path:String):void [statisk] Lägger till paret {languageCode och languagePath} i den interna arrayen för senare användning.	Locale
		checkXMLStatus():Boolean [statisk] Returnerar true om XML-filen har lästs in, annars returneras false.	Locale
		dispatchEvent(event:Event):Boolean Skickar en händelse till händelseflödet.	EventDispatcher
		getDefaultLang():String [statisk] Standardspråkkoden som angetts i dialogrutan på strängpanelen eller via ett anrop till metoden setDefaultLang().	Locale
		hasEventListener(type:String):Boolean Kontrollerar om EventDispatcher-objektet har några avlyssnare registrerade för en viss typ av händelse.	EventDispatcher
		hasOwnProperty(name:String):Boolean Anger om det finns en egenskap angiven för ett objekt.	Object
		initialize():void [statisk] Avgör automatiskt vilket språk som ska användas och läser in XML-språkfilen.	Locale
		isPrototypeOf(theClass:Object):Boolean Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter.	Object
		loadLanguageXML(xmlLanguageCode:String, customXmlCompleteCallback:Function = null):void [statisk] Läser in den angivna XML-språkfilen.	Locale
		loadString(id:String):String [statisk] Returnerar strängvärdet som är associerat med det givna sträng-ID:t på det aktuella språket.	Locale
		loadStringEx(stringID:String, languageCode:String):String [statisk] Returnerar strängvärdet som är associerat med givet sträng-ID och given språkkod.	Locale
		propertyIsEnumerable(name:String):Boolean Anger om den angivna egenskapen finns och är uppräkningsbar.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Tar bort en avlyssnare från EventDispatcher-objektet.	EventDispatcher
		setDefaultLang(langCode:String):void [statisk] Ställer in standardspråkkoden.	Locale
		setLoadCallback(loadCallback:Function):* [statisk] Anger vilken callback-function som ska anropas när XML-filen har lästs in.	Locale
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Anger tillgänglighet för en dynamisk egenskap för slingåtgärder.	Object
		setString(stringID:String, languageCode:String, stringValue:String):void [statisk] Anger det nya strängvärdet för ett givet sträng-ID och en given språkkod.	Locale
		toLocaleString():String Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner.	Object
		toString():String Returnerar det angivna objektets strängbeteckning.	Object
		valueOf():Object Returnerar det angivna objektets primitiva värde.	Object
		willTrigger(type:String):Boolean Kontrollerar om en händelseavlyssnare är registrerad för det här EventDispatcher-objektet eller något av dess överordnade objekt för den angivna händelsetypen.	EventDispatcher

Händelser

Klicka för mer information om händelser

Dölj ärvda händelser

Visa ärvda händelser

	Händelse		Sammanfattning	Definieras med
		activate	[utsändningshändelse] Skickas när Flash Player eller AIR får operativsystemfokus och blir aktivt.	EventDispatcher
		deactivate	[utsändningshändelse] Skickas när Flash Player eller AIR förlorar operativsystemfokus och blir inaktivt.	EventDispatcher

Egenskapsdetaljer

autoReplace

egenskap

autoReplace:Boolean

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

Avgör om strängar ska ersättas automatiskt när XML-filen har lästs in. Om värdet är true är textersättningsmetoden lika med strängpanelsinställningen "automatically at runtime". Det innebär att Flash Player kommer att avgöra standardspråket för värdmiljön och automatiskt visa texten på det språket. Om värdet är false är textersättningsmetoden lika med strängpanelsinställningen "via ActionScript at runtime". Det innebär att du måste läsa in rätt XML-fil för att visa texten.

Standardvärdet för den här inställningen motsvarar den inställning du valt för Ersätt strängar på strängpanelen: true för "automatically at runtime" (standardinställning) och false för "via ActionScript at runtime".

Implementering
public static function get autoReplace():Boolean
public static function set autoReplace(value:Boolean):void

Exempel ( Så här använder du exemplet )

I följande exempel används Locale.autoReplace-egenskapen för att fylla i det dynamiskt skapade textfältet greeting_txt på scenen med innehållet i IDS_GREETING-strängen i den engelska XML-filen. Klicka på knappen Inställningar på strängpanelen för att öppna dialogrutan med samma namn. Du kan lägga till två aktiva språk i dialogrutan Inställningar: engelska (en) och franska (fr). Ställ in alternativet Ersätt strängar på "via ActionScript at runtime" och klicka på OK. Ange slutligen IDS_GREETING som sträng-ID på strängpanelen och lägg till text för alla aktiva språk.

     var greeting_txt:TextField = new TextField();
     greeting_txt.x = 40;
     greeting_txt.y = 40;
     greeting_txt.width = 200;
     greeting_txt.height = 20;
     greeting_txt.autoSize = TextFieldAutoSize.LEFT;
     Locale.autoReplace = true;
     Locale.addDelayedInstance(greeting_txt, "IDS_GREETING");
     Locale.loadLanguageXML("en");

languageCodeArray

egenskap

languageCodeArray:Array [skrivskyddad]

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

En array som innehåller språkkoder för de språk som har angetts eller lästs in i FLA-filen. Språkkoderna är inte ordnade i bokstavsordning.

Implementering
public static function get languageCodeArray():Array

Exempel ( Så här använder du exemplet )

I följande exempel läses in XML-språkfil in baserat på det aktuella värdet för en ComboBox-komponent. Dra en ComboBox-komponent till scenen och ge den instansnamnet lang_cb. Skapa ett dynamiskt textfält med textverktyget och ge det instansnamnet greeting_txt. Lägg till minst två aktiva språk på strängpanelen, ställ in alternativet Ersätt strängar på "via ActionScript at runtime" och klicka på OK. Lägg sedan till IDS_GREETING som sträng-ID och lägg till text för alla aktiva språk. Lägg slutligen till följande ActionScript-kod i bildruta 1 på huvudtidslinjen:

     Locale.setLoadCallback(localeListener);
     lang_cb.dataProvider = Locale.languageCodeArray.sort();
     lang_cb.addEventListener("change", langListener);
     
     function langListener(eventObj:Object):void {
      Locale.loadLanguageXML(eventObj.target.value);
     }
     function localeListener(success:Boolean):void {
      if (success) {
          greeting_txt.text = Locale.loadString("IDS_GREETING");
      } else {
          greeting_txt.text = "unable to load language XML file.";
      }
     }

stringIDArray

egenskap

stringIDArray:Array [skrivskyddad]

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

En array som innehåller alla sträng-ID:n i FLA-filen. Sträng-ID:n är inte ordnade i bokstavsordning.

Implementering
public static function get stringIDArray():Array

Exempel ( Så här använder du exemplet )

I följande exempel skrivs egenskapen Locale.stringIDArray ut för den inlästa XML-språkfilen. Klicka på knappen Inställningar på strängpanelen för att öppna dialogrutan med samma namn. Lägg sedan till två aktiva språk: engelska (en) och franska (fr). Ställ in alternativet Ersätt strängar på "via ActionScript at runtime" och klicka på OK. Lägg till IDS_GREETING som sträng-ID på strängpanelen och lägg till text för alla aktiva språk.

     Locale.setLoadCallback(localeCallback);
     Locale.loadLanguageXML("fr");
     function localeCallback(success:Boolean) {
      trace(success);
      trace(Locale.stringIDArray); // IDS_GREETING
      trace(Locale.loadStringEx("IDS_GREETING", "fr")); // bonjour
     }

Metoddetaljer

addDelayedInstance

()

metod

public static function addDelayedInstance(instance:Object, stringID:String):*

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

Lägger till paret {instance, string ID} i den interna arrayen för senare användning. Detta används huvudsakligen av Flash när strängersättningmetoden är "automatically at runtime".

Parametrar

	`instance:Object` — Instansnamnet för textfältet som ska fyllas i.

	`stringID:String` — Språkets sträng-ID.

Returnerar

*

Exempel ( Så här använder du exemplet )

I följande exempel används autoReplace-egenskapen och addDelayedInstance()-metoden för att fylla i ett textfält på scenen med IDS_GREETING-strängen från den engelska XML-språkfilen.

     greeting_txt.autoSize = TextFieldAutoSize.LEFT;
     Locale.autoReplace = true;
     Locale.addDelayedInstance(greeting_txt, "IDS_GREETING");
     Locale.loadLanguageXML("en");

addXMLPath

()

metod

public static function addXMLPath(langCode:String, path:String):void

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

Lägger till paret {languageCode och languagePath} i den interna arrayen för senare användning. Detta används huvudsakligen av Flash Player när strängersättningsmetoden är "automatically at runtime" eller "via ActionScript at runtime". Med den här metoden kan du läsa in XML språkfiler från en egen plats i stället för standardplatsen som används i Flash Professional. Som standard skapar Flash Professional en XML-fil för varje språk i din arbetskatalog i en underkatalog med FLA-filens namn.

Parametrar

	`langCode:String` — Språkkoden.

	`path:String` — Den XML-sökväg som ska läggas till.

Exempel ( Så här använder du exemplet )

Exemplet nedan anger att de engelska översättningarna ("en") finns i filen "locale/locale_en.xml" och de franska översättningarna ("fr") finns i filen "locale/locale_fr.xml" i förhållande till din arbetskatalog (exempel och beskrivning av Chris Inch, från http://www.chrisinch.com):

     Locale.addXMLPath("en", "locale/locale_en.xml");
     Locale.addXMLPath("fr", "locale/locale_fr.xml");
     Locale.setLoadCallback(Delegate.create(this, languageLoaded));
     Locale.loadLanguageXML("en");
     
     private function languageLoaded(success:Boolean):Void {
        trace(Locale.loadString("IDS_HELLO");

checkXMLStatus

()

metod

public static function checkXMLStatus():Boolean

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

Returnerar true om XML-filen har lästs in, annars returneras false.

Returnerar

Boolean — Returnerar true om XML-filen har lästs in, annars returneras false.

Exempel ( Så här använder du exemplet )

I följande exempel används ett intervall för att kontrollera om språkfilen har lästs in var tionde millisekund. När XML-filen har lästs in fylls textfältsinstansen greeting_txt på scenen i med strängen IDS_GREETING.

     Locale.setLoadCallback(localeCallback);
     Locale.loadLanguageXML("en");
     // create interval to check if language XML file is loaded
     var locale_int:Number = setInterval(checkLocaleStatus, 10);
     function checkLocaleStatus():void {
      if (Locale.checkXMLStatus()) {
          clearInterval(locale_int);
          trace("clearing interval @ " + getTimer() + " ms");
      }
     }
     // callback function for Locale.setLoadCallback()
     function localeCallback(success:Boolean):void {
      greeting_txt.text = Locale.loadString("IDS_GREETING");
     }

getDefaultLang

()

metod

public static function getDefaultLang():String

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

Standardspråkkoden som angetts i dialogrutan på strängpanelen eller via ett anrop till metoden setDefaultLang().

Returnerar

String — Returnerar standardspråkkoden.

Relaterade API-element

Locale.setDefaultLang()

Exempel ( Så här använder du exemplet )

I följande exempel skapas en variabel som heter defLang och som innehåller det ursprungliga standardspråket för Flash-dokumentet. Klicka på knappen Inställningar på strängpanelen för att öppna dialogrutan med samma namn. Lägg sedan till två aktiva språk: engelska (en) och franska (fr). Ställ in alternativet Ersätt strängar på "via ActionScript at runtime" och klicka på OK. Lägg till IDS_GREETING som sträng-ID på strängpanelen och lägg till text för alla aktiva språk.

     var defLang:String = "fr";
     Locale.setDefaultLang(defLang);
     Locale.setLoadCallback(localeCallback);
     Locale.loadLanguageXML(Locale.getDefaultLang());
     function localeCallback(success:Boolean) {
      if (success) {
          trace(Locale.stringIDArray); // IDS_GREETING
          trace(Locale.loadString("IDS_GREETING"));
      } else {
          trace("unable to load XML");
      }
     }

initialize

()

metod

public static function initialize():void

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

Avgör automatiskt vilket språk som ska användas och läser in XML-språkfilen. Detta används huvudsakligen av Flash när strängersättningmetoden är "automatically at runtime".

Exempel ( Så här använder du exemplet )

I det här exemplet visas hur man använder initialize()-metoden för att automatiskt fylla i textfältet greeting_txt på scenen med användarens aktuella OS-språk. I stället för att använda metoden initialize() direkt använder du strängersättningsmetoden "automatically at runtime".

     trace(System.capabilities.language);
     Locale.autoReplace = true;
     Locale.addDelayedInstance(greeting_txt, "IDS_GREETING");
     Locale.initialize();

loadLanguageXML

()

metod

public static function loadLanguageXML(xmlLanguageCode:String, customXmlCompleteCallback:Function = null):void

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

Läser in den angivna XML-språkfilen.

Parametrar

	`xmlLanguageCode:String` — Språkkoden för den XML-språkfil som ska läsas in.

	`customXmlCompleteCallback:Function` (default = `null`) — En anpassad callback-funktion som ska anropas när XML-språkfilen läses in.

Exempel ( Så här använder du exemplet )

I följande exempel används metoden loadLanguageXML() för att läsa in den engelska XML-språkfilen (en). När språkfilen har lästs in anropas localeCallback()-metoden och textfältet greeting_txt fylls i på scenen med innehållet i strängen IDS_GREETING i XML-filen.

     Locale.setLoadCallback(localeCallback);
     Locale.loadLanguageXML("en");
     // create interval to check if language XML file is loaded
     var locale_int:Number = setInterval(checkLocaleStatus, 10);
     function checkLocaleStatus():void {
      if (Locale.checkXMLStatus()) {
          clearInterval(locale_int);
          trace("clearing interval @ " + getTimer() + " ms");
      }
     }
     // callback function for Locale.setLoadCallback()
     function localeCallback(success:Boolean):void {
      greeting_txt.text = Locale.loadString("IDS_GREETING");
     }

loadString

()

metod

public static function loadString(id:String):String

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

Returnerar strängvärdet som är associerat med det givna sträng-ID:t på det aktuella språket.

Parametrar

id:String — ID-numret för den sträng som ska läsas in.

Returnerar

String — Strängvärdet som är associerat med det givna sträng-ID:t på det aktuella språket.

Relaterade API-element

Locale.loadStringEx()

Exempel ( Så här använder du exemplet )

     Locale.setLoadCallback(localeCallback);
     Locale.loadLanguageXML("en");
     // create interval to check if language XML file is loaded
     var locale_int:Number = setInterval(checkLocaleStatus, 10);
     function checkLocaleStatus():void {
      if (Locale.checkXMLStatus()) {
          clearInterval(locale_int);
          trace("clearing interval @ " + getTimer() + " ms");
      }
     }
     // callback function for Locale.setLoadCallback()
     function localeCallback(success:Boolean):void {
      greeting_txt.text = Locale.loadString("IDS_GREETING");
     }

loadStringEx

()

metod

public static function loadStringEx(stringID:String, languageCode:String):String

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

Returnerar strängvärdet som är associerat med givet sträng-ID och given språkkod. För att inte XML-filer ska läsas in oväntat läser loadStringEx() inte in XML-språkfilen om XML-filen inte redan har lästs in. Bestäm när det är lämpligt att anropa metoden loadLanguageXML() om du vill läsa in en XML-språkfil.

Parametrar

	`stringID:String` — ID-numret för den sträng som ska läsas in.

	`languageCode:String` — Språkkoden.

Returnerar

String — Strängvärdet som är associerat med det givna sträng-ID:t på det språk som anges av parametern languageCode.

Relaterade API-element

Locale.loadString()

Exempel ( Så här använder du exemplet )

I följande exempel används metoden loadStringEx() för att spåra värdet på IDS_GREETING-strängen för den franska XML-språkfil som är inläst.

     Locale.setLoadCallback(localeCallback);
     Locale.loadLanguageXML("fr");
     function localeCallback(success:Boolean) {
      trace(success);
      trace(Locale.stringIDArray); // IDS_GREETING
      trace(Locale.loadStringEx("IDS_GREETING", "fr")); // bonjour
     }

setDefaultLang

()

metod

public static function setDefaultLang(langCode:String):void

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

Ställer in standardspråkkoden.

Parametrar

langCode:String — En sträng som betecknar en språkkod.

Relaterade API-element

Locale.getDefaultLang()

Exempel ( Så här använder du exemplet )

     var defLang:String = "fr";
     Locale.setDefaultLang(defLang);
     Locale.setLoadCallback(localeCallback);
     Locale.loadLanguageXML(Locale.getDefaultLang());
     function localeCallback(success:Boolean) {
      if (success) {
          trace(Locale.stringIDArray); // IDS_GREETING
          trace(Locale.loadString("IDS_GREETING"));
      } else {
          trace("unable to load XML");
      }
     }

setLoadCallback

()

metod

public static function setLoadCallback(loadCallback:Function):*

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

Anger vilken callback-function som ska anropas när XML-filen har lästs in.

Parametrar

loadCallback:Function — Den funktion som ska anropas när XML-språkfilen läses in.

Returnerar

*

Exempel ( Så här använder du exemplet )

     Locale.setLoadCallback(localeCallback);
     Locale.loadLanguageXML("en");
     // create interval to check if language XML file is loaded
     var locale_int:Number = setInterval(checkLocaleStatus, 10);
     function checkLocaleStatus():void {
      if (Locale.checkXMLStatus()) {
          clearInterval(locale_int);
          trace("clearing interval @ " + getTimer() + " ms");
      }
     }
     // callback function for Locale.setLoadCallback()
     function localeCallback(success:Boolean):void {
      greeting_txt.text = Locale.loadString("IDS_GREETING");
     }

setString

()

metod

public static function setString(stringID:String, languageCode:String, stringValue:String):void

Språkversion:

ActionScript 3.0

Produktversion:

Flash CS3

Körningsmiljöversioner:

Flash Player 9, AIR 1.0

Anger det nya strängvärdet för ett givet sträng-ID och en given språkkod.

Parametrar

	`stringID:String` — ID-numret för den sträng som ska anges.

	`languageCode:String` — Språkkoden.

	`stringValue:String` — Ett strängvärde.

Exempel ( Så här använder du exemplet )

I följande exempel används metoden setString() för att ställa in IDS_WELCOME-strängen för både engelska (en) och franska (fr).

     Locale.setString("IDS_WELCOME", "en", "hello");
     Locale.setString("IDS_WELCOME", "fr", "bonjour");
     trace(Locale.loadStringEx("IDS_WELCOME", "en")); // hello

Juridiska meddelanden | Onlinesekretesspolicy

Locale - AS3 Flash

Paketx

Språkelement

Bilagor

Paket fl.lang

autoReplace

languageCodeArray

stringIDArray

addDelayedInstance

addXMLPath

checkXMLStatus

getDefaultLang

initialize

loadLanguageXML

loadString

loadStringEx

setDefaultLang

setLoadCallback

setString