Locale - Referência da API Adobe ActionScript® 3 (AS3 Flash)

Pacote	fl.lang
Classe	public class Locale
Herança	Locale EventDispatcher Object

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

A classe fl.lang.Locale permite controlar como o texto multilíngue é exibido em um arquivo SWF. O painel Strings do Flash permite usar IDs de string em vez de literais de string nos campos de texto dinâmicos. Isso permite criar um arquivo SWF que exibe o texto carregado de um arquivo XML específico do idioma. O arquivo XML deve usar o padrão XLIFF (XML Localization Interchange File Format). Há três maneiras de exibir as strings específicas de idioma contidas nos arquivos XLIFF:

"automatically at runtime": o Flash Player substitui os IDs de string por strings do arquivo XML que corresponde ao código do idioma do sistema padrão retornado por flash.system.capabilities.language.
"manualmente usando idioma do palco": os IDs de string são substituídos por strings no momento da compilação e não podem ser alterados pelo Flash Player.
"via ActionScript at runtime": a substituição do ID de string é controlada usando o ActionScript durante a execução. Esta opção permite que você tenha controle sobre a duração e o idioma da substituição do ID de string.

Use as propriedades e os métodos desta classe quando quiser substituir os IDs de string "via ActionScript em tempo de execução".

Todas as propriedades e os métodos disponíveis são estáticos, o que significa que são acessados por meio da classe fl.lang.Locale em si e não por meio de uma ocorrência da classe.

Observação: a classe Locale é instalada no caminho de classe de criação do Flash e é automaticamente compilada nos seus arquivos SWF. O uso da classe Locale aumenta um pouco o tamanho do arquivo SWF uma vez que a classe é compilada no SWF.

Elementos da API relacionados

flash.system.Capabilities.language

Propriedades públicas

Ocultar propriedades públicas herdadas

Mostrar propriedades públicas herdadas

	Propriedade		Definido por
		autoReplace : Boolean [estático] Determina se as strings são substituídas automaticamente após o carregamento do arquivo XML.	Locale
		constructor : Object Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.	Object
		languageCodeArray : Array [estático] [somente leitura] Uma matriz contendo códigos de idioma para os idiomas que foram especificados ou carregados no arquivo FLA.	Locale
		stringIDArray : Array [estático] [somente leitura] Uma matriz contendo todos os IDs de string no arquivo FLA.	Locale

Métodos públicos

Ocultar métodos públicos herdados

Mostrar métodos públicos herdados

	Método		Definido por
		addDelayedInstance(instance:Object, stringID:String):* [estático] Adiciona o par {instance, string ID} à matriz interna para uso posterior.	Locale
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento.	EventDispatcher
		addXMLPath(langCode:String, path:String):void [estático] Adiciona o par {languageCode e languagePath} à matriz interna para uso posterior.	Locale
		checkXMLStatus():Boolean [estático] Retornará true se o arquivo XML estiver carregado; caso contrário, retornará false.	Locale
		dispatchEvent(event:Event):Boolean Envia um evento para o fluxo de eventos.	EventDispatcher
		getDefaultLang():String [estático] O código de idioma padrão definido na caixa de diálogo do painel Strings ou chamando o método setDefaultLang().	Locale
		hasEventListener(type:String):Boolean Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica se um objeto tem uma propriedade especificada definida.	Object
		initialize():void [estático] Determina automaticamente o idioma a ser usado e carrega o arquivo de idioma XML.	Locale
		isPrototypeOf(theClass:Object):Boolean Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.	Object
		loadLanguageXML(xmlLanguageCode:String, customXmlCompleteCallback:Function = null):void [estático] Carrega o arquivo de idioma XML especificado.	Locale
		loadString(id:String):String [estático] Retorna o valor de string associado ao ID de string especificado no idioma atual.	Locale
		loadStringEx(stringID:String, languageCode:String):String [estático] Retorna o valor de string associado ao ID de string especificado e ao código de idioma.	Locale
		propertyIsEnumerable(name:String):Boolean Indica se a propriedade especificada existe e é enumerável.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Remove um ouvinte do objeto EventDispatcher.	EventDispatcher
		setDefaultLang(langCode:String):void [estático] Define o código de idioma padrão.	Locale
		setLoadCallback(loadCallback:Function):* [estático] Define a função de retorno de chamada que é chamada após o carregamento do arquivo XML.	Locale
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Define a disponibilidade de uma propriedade dinâmica para operações de repetição.	Object
		setString(stringID:String, languageCode:String, stringValue:String):void [estático] Define o novo valor de string de um determinado ID de string e código de idioma.	Locale
		toLocaleString():String Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.	Object
		toString():String Retorna a representação de string do objeto especificado.	Object
		valueOf():Object Retorna o valor primitivo do objeto especificado.	Object
		willTrigger(type:String):Boolean Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado.	EventDispatcher

Eventos

Clique para obter mais informações sobre eventos

Ocultar eventos herdados

Mostrar eventos herdados

	Evento		Resumo	Definido por
		activate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo.	EventDispatcher
		deactivate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo.	EventDispatcher

Detalhes da propriedade

autoReplace

propriedade

autoReplace:Boolean

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

Determina se as strings são substituídas automaticamente após o carregamento do arquivo XML. Se for definido como true, o método de substituição de texto será equivalente à configuração "automatically at runtime" no painel Strings. Isso significa que o Flash Player determinará o idioma padrão do ambiente de hospedagem e exibirá automaticamente o texto nesse idioma. Se for definido como false, o método de substituição de texto será equivalente à configuração "via ActionScript at runtime" no painel Strings. Isso significa que você é responsável pelo carregamento do arquivo XML apropriado para a exibição do texto.

O valor padrão desta propriedade reflete a configuração que você seleciona para a opção Substituir strings na caixa de diálogo do painel Strings: true para "automatically at runtime" (a configuração padrão) e false para "via ActionScript em tempo de execução".

Implementação
public static function get autoReplace():Boolean
public static function set autoReplace(value:Boolean):void

Exemplo ( Como usar este exemplo )

O exemplo a seguir utiliza a propriedade Locale.autoReplace para preencher o campo de texto criado dinamicamente greeting_txt no palco com o conteúdo da string IDS_GREETING no arquivo XML em inglês. No painel Strings, clique no botão Configurações para abrir a caixa de diálogo Configurações. Você pode adicionar dois idiomas ativos usando a caixa de diálogo Configurações: inglês (en) e francês (fr), definir a opção de substituição de strings como "via ActionScript at runtime" e clicar em OK. Por último, digite um ID de string de IDS_GREETING no painel Strings e adicione o texto para cada idioma ativo.

     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

propriedade

languageCodeArray:Array [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

Uma matriz contendo códigos de idioma para os idiomas que foram especificados ou carregados no arquivo FLA. Os códigos de idioma não são classificados em ordem alfabética.

Implementação
public static function get languageCodeArray():Array

Exemplo ( Como usar este exemplo )

O exemplo a seguir carrega um arquivo XML de idioma com base no valor atual de um componente ComboBox. Arraste um componente ComboBox para o palco e dê o nome de ocorrência lang_cb. Usando a ferramenta Texto, crie um campo de texto dinâmico e dê o nome greeting_txt. No painel Strings, adicione pelo menos dois idiomas, defina a opção de substituição das strings como "via ActionScript at runtime" e clique em OK. Em seguida, adicione um ID de string IDS_GREETING e insira o texto para cada idioma ativo. Por último, adicione o seguinte código ActionScript ao Quadro 1 da Linha de tempo:

     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

propriedade

stringIDArray:Array [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

Uma matriz contendo todos os IDs de string no arquivo FLA. Os IDs de string não são classificados em ordem alfabética.

Implementação
public static function get stringIDArray():Array

Exemplo ( Como usar este exemplo )

O exemplo a seguir rastreia a propriedade Locale.stringIDArray para o arquivo XML de idioma carregado no momento. No painel Strings, clique no botão Configurações para abrir a caixa de diálogo Configurações. Depois, adicione dois idiomas ativos: inglês (en) e francês (fr), defina a opção de substituição de strings como"via ActionScript at runtime" e clique em OK. No painel Strings, adicione um ID de string IDS_GREETING e, em seguida, adicione texto para cada idioma ativo.

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

Detalhes do método

addDelayedInstance

()

método

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

Adiciona o par {instance, string ID} à matriz interna para uso posterior. É utilizado pelo Flash principalmente quando o método de substituição de strings é "automatically at runtime".

Parâmetros

	`instance:Object` — Nome da ocorrência do campo de texto a ser preenchido.

	`stringID:String` — ID da string de idioma.

Retorna

*

Exemplo ( Como usar este exemplo )

O exemplo a seguir utiliza a propriedade autoReplace e o método addDelayedInstance() para preencher um campo de texto no palco com a string IDS_GREETING do arquivo de idioma XML em inglês.

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

addXMLPath

()

método

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

Adiciona o par {languageCode e languagePath} à matriz interna para uso posterior. É utilizado pelo Flash Player principalmente quando o método de substituição de strings é "automatically at runtime" ou "via ActionScript at runtime". Este método permite que você carregue arquivos de idioma de XML de um local personalizado em vez do local padrão determinado pelo Flash Professional. Por padrão, o Flash Professional cria um arquivo XML de cada idioma no seu diretório de trabalho, abaixo de um subdiretório denominado usando o nome do seu arquivo FLA.

Parâmetros

	`langCode:String` — O código do idioma.

	`path:String` — O caminho XML a ser adicionado.

Exemplo ( Como usar este exemplo )

O seguinte exemplo diz ao Flash Player que as traduções do inglês ("en") são encontradas no arquivo "locale/locale_en.xml" e traduções do francês ("fr") estão no arquivo "locale/locale_fr.xml" relacionado ao seu diretório de trabalho (exemplo e descrição fornecidos por Chris Inch, de 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

()

método

public static function checkXMLStatus():Boolean

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

Retornará true se o arquivo XML estiver carregado; caso contrário, retornará false.

Retorna

Boolean — Retornará true se o arquivo XML estiver carregado; caso contrário, retornará false.

Exemplo ( Como usar este exemplo )

O exemplo a seguir utiliza um intervalo para verificar a cada 10 milésimos de segundo se o arquivo de idioma foi carregado com êxito. Após o arquivo XML ser carregado, a ocorrência do campo de texto greeting_txt no palco é preenchida com a string IDS_GREETING do arquivo de idioma XML.

     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

()

método

public static function getDefaultLang():String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

O código de idioma padrão definido na caixa de diálogo do painel Strings ou chamando o método setDefaultLang().

Retorna

String — Retorna o código de idioma padrão.

Elementos da API relacionados

Locale.setDefaultLang()

Exemplo ( Como usar este exemplo )

O exemplo a seguir cria uma variável denominada defLang, que é usada para manter o idioma padrão inicial para o documento Flash. No painel Strings, clique no botão Configurações para abrir a caixa de diálogo Configurações. Depois, adicione dois idiomas ativos: inglês (en) e francês (fr), defina a opção de substituição de strings como"via ActionScript at runtime" e clique em OK. No painel Strings, adicione um ID de string IDS_GREETING e, em seguida, adicione texto para cada idioma ativo.

     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

()

método

public static function initialize():void

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

Determina automaticamente o idioma a ser usado e carrega o arquivo de idioma XML. É utilizado pelo Flash principalmente quando o método de substituição de strings é "automatically at runtime".

Exemplo ( Como usar este exemplo )

Este exemplo mostra como utilizar o métodoinitialize() para preencher automaticamente o campo de texto greeting_txt no palco com o idioma atual do SO do usuário. Em vez de utilizar o método initialize() diretamente, utilize o método de substituição de string "automatically at runtime".

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

loadLanguageXML

()

método

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

Carrega o arquivo de idioma XML especificado.

Parâmetros

	`xmlLanguageCode:String` — O código de idioma do arquivo de idioma XML que você deseja carregar.

	`customXmlCompleteCallback:Function` (default = `null`) — Função de retorno de chamada personalizada a ser chamada quando o arquivo de idioma XML é carregado.

Exemplo ( Como usar este exemplo )

O exemplo a seguir utiliza o método loadLanguageXML() para carregar o arquivo de idioma XML em inglês (en). Após o arquivo ser carregado, o método localeCallback() é chamado e preenche o campo de texto greeting_txt no palco com o conteúdo da string IDS_GREETING no arquivo XML.

     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

()

método

public static function loadString(id:String):String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

Retorna o valor de string associado ao ID de string especificado no idioma atual.

Parâmetros

id:String — O número de identificação (ID) da string a ser carregada.

Retorna

String — O valor de string associado ao ID de string especificado no idioma atual.

Elementos da API relacionados

Locale.loadStringEx()

Exemplo ( Como usar este exemplo )

     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

()

método

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

Retorna o valor de string associado ao ID de string especificado e ao código de idioma. A fim de evitar o carregamento de um arquivo XML inesperado, o loadStringEx() não carrega o arquivo de idioma XML se ele ainda não estiver carregado. Você terá que optar na hora certa por chamar o método loadLanguageXML() se quiser carregar um arquivo de idioma XML.

Parâmetros

	`stringID:String` — O número de identificação (ID) da string a ser carregada.

	`languageCode:String` — O código do idioma.

Retorna

String — O valor de string associado ao ID de string no idioma especificado pelo parâmetro languageCode.

Elementos da API relacionados

Locale.loadString()

Exemplo ( Como usar este exemplo )

O exemplo a seguir utiliza o método loadStringEx() para rastrear o valor da string IDS_GREETING do arquivo de idioma XML carregado em inglês.

     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

()

método

public static function setDefaultLang(langCode:String):void

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

Define o código de idioma padrão.

Parâmetros

langCode:String — Uma string representando um código de idioma.

Elementos da API relacionados

Locale.getDefaultLang()

Exemplo ( Como usar este exemplo )

     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

()

método

public static function setLoadCallback(loadCallback:Function):*

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

Define a função de retorno de chamada que é chamada após o carregamento do arquivo XML.

Parâmetros

loadCallback:Function — A função a ser chamada quando o arquivo de idioma XML é carregado.

Retorna

*

Exemplo ( Como usar este exemplo )

     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

()

método

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flash CS3

Versões de runtime:

Flash Player 9, AIR 1.0

Define o novo valor de string de um determinado ID de string e código de idioma.

Parâmetros

	`stringID:String` — O número de identificação (ID) da string a ser definida.

	`languageCode:String` — O código do idioma.

	`stringValue:String` — Um valor de string.

Exemplo ( Como usar este exemplo )

O exemplo a seguir utiliza o método setString() para definir a string IDS_WELCOME tanto para inglês (en) quanto para francês (fr).

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

Aspectos jurídicos | Política de privacidade on-line

Locale - AS3 Flash

Pacotesx

Elementos de linguagem

Apêndices

Pacote fl.lang

autoReplace

languageCodeArray

stringIDArray

addDelayedInstance

addXMLPath

checkXMLStatus

getDefaultLang

initialize

loadLanguageXML

loadString

loadStringEx

setDefaultLang

setLoadCallback

setString