Referência do ActionScript® 3.0 para Adobe® Flash® Platform
Início  |  Ocultar listas de Pacotes e Classes |  Pacotes  |  Classes  |  Novidades  |  Índice  |  Apêndices  |  Por que inglês?
Filtros: Recuperando dados do servidor...
Recuperando dados do servidor...
flashx.textLayout.conversion 

ITextExporter  - AS3

Pacoteflashx.textLayout.conversion
Interfacepublic interface ITextExporter

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

Interface para exportar o conteúdo de texto de um exemplo TextFlow para um formato específico, que pode ser por exemplo formato de sequência de caracteres, XML ou um formato definido pelo usuário. Exportadores compatíveis com a obtenção e definição de propriedades para controlar a exportação de dados. Estas propriedades são implementadas como públicas, mas o acesso direto destas propriedades deve ser evitado, visto que um usuário pode substituir a classe de conversor no registro TextConverter, fazendo com que um downcast falhe.



Propriedades públicas
 PropriedadeDefinido por
  errors : Vector.<String>
[somente leitura] Esta propriedade contém um vetor de mensagens de erro como sequências de caracteres depois que uma chamada para um método de exportador é a propriedade throwOnError definida para false, que é o padrão.
ITextExporter
  throwOnError : Boolean
A propriedade throwOnError controla como o exportador trata erros.
ITextExporter
  useClipboardAnnotations : Boolean
A propriedade useClipboardAnnotations controla se o importador deve tratar as informações extras necessárias para a área de transferência.
ITextExporter
Métodos públicos
 MétodoDefinido por
  
Conteúdo de texto de exportação de um exemplo TextFlow em sequência de caracteres, XML ou um formato definido pelo usuário.
ITextExporter
Detalhes da propriedade

errors

propriedade
errors:Vector.<String>  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10.2, AIR 2.0

Esta propriedade contém um vetor de mensagens de erro como sequências de caracteres depois que uma chamada para um método de exportador é a propriedade throwOnError definida para false, que é o padrão. Se não houve nenhum erro, a propriedade retorna null. A propriedade é redefinida em cada chamada de método.



Implementação
    public function get errors():Vector.<String>

throwOnError

propriedade 
throwOnError:Boolean

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10.2, AIR 2.0

A propriedade throwOnError controla como o exportador trata erros. Se definir para true, os métodos emitem uma instância Error em erros. Se definir para false, que é o padrão, os erros são reunidos em um vetor de sequências de caracteres e armazenados na propriedade errors, e o exportador não é ativado.



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

useClipboardAnnotations

propriedade 
useClipboardAnnotations:Boolean

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

A propriedade useClipboardAnnotations controla se o importador deve tratar as informações extras necessárias para a área de transferência. Quando os dados estão em um TextFlow, os parágrafos são sempre completos, e incluem um caractere de terminador. Um intervalo formará parágrafos quando for colado na área de transferência, mas pode não ser incluído no terminador final. Neste caso o parágrafo precisa ser marcado como parcial se for destinado para a área de transferência, de modo que, se for depois colado, será integrado no novo texto corretamente. Se o conteúdo for destinado para a área de transferência, useClipboardAnnotations será true.



Implementação
    public function get useClipboardAnnotations():Boolean
    public function set useClipboardAnnotations(value:Boolean):void
Detalhes do método

export

()método
public function export(source:flashx.textLayout.elements:TextFlow, conversionType:String):Object

Versão da linguagem: ActionScript 3.0
Versões de runtime: Flash Player 10, AIR 1.5

Conteúdo de texto de exportação de um exemplo TextFlow em sequência de caracteres, XML ou um formato definido pelo usuário.

Defina o parâmetro conversionType para os valores a seguir, ou para um formato definido pelo usuário em exportadores definidos pelo usuário.

  • flashx.textLayout.conversion.ConversionType.STRING_TYPE;
  • flashx.textLayout.conversion.ConversionType.XML_TYPE.

Parâmetros

source:flashx.textLayout.elements:TextFlow — O TextFlow a ser exportado
 
conversionType:String — Retorne uma sequência de caracteres (STRING_TYPE) ou XML (XML_TYPE), ou qualquer formato definido pelo usuário.

Retorna
Object — Objeto O conteúdo exportado

Elementos da API relacionados


Exemplo  ( Como usar este exemplo )

Este snippet de código mostra uma utilização do método export para realizar exportações repetidas do texto formatado.

package flashx.textLayout.conversion.examples
{
    import flashx.textLayout.conversion.ConversionType;
    import flashx.textLayout.conversion.ITextExporter;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.elements.TextFlow;
    
    public class ITextExporterExample 
    {
        // Serialize the TextFlow into a String
        static public function export(textFlow:TextFlow):String
        {
            var exporter:ITextExporter = TextConverter.getExporter(TextConverter.TEXT_LAYOUT_FORMAT);
            return exporter.export(textFlow, ConversionType.STRING_TYPE) as String;
        }
    }
}




[ X ]Por que inglês?
O conteúdo na Referência do ActionScript 3.0 aparece em inglês

Nem todas as partes da Referência do ActionScript 3.0 estão traduzidas em todos os idiomas. Quando um elemento de um idioma não está traduzido, ele é exibido em inglês. Por exemplo, a classe ga.controls.HelpBox não está traduzida em nenhum idioma. Por isso, na versão da referência em português do Brasil, a classe ga.controls.HelpBox é exibida em inglês.