TextConverter  - AS3

Liczba formatów.

Należy zarejestrować nowy format przeznaczony do importowania/eksportowania. Nowy format zostanie dodany na końcu — jako format o najniższym priorytecie. Położenie może mieć znaczenie dla klientów mających do wyboru liczne opcje dotyczące tego, którego formatu używać, na przykład podczas importowania ze schowka zewnętrznego. Nowy format może obsługiwać importowanie i/lub eksportowanie. Jeśli format został już dodany, będzie on występować w wielu położeniach. Zostanie użyte pierwsze znalezione położenie.

Parametry

Nowy format przeznaczony do importowania/eksportowania należy zarejestrować w określonym położeniu. Położenie może mieć znaczenie dla klientów mających do wyboru liczne opcje dotyczące tego, którego formatu używać, na przykład podczas importowania ze schowka zewnętrznego. Niższe liczby oznaczają wyższy priorytet; te moduły konwersji zostaną wypróbowane w pierwszej kolejności. Nowy format może obsługiwać importowanie i/lub eksportowanie. Jeśli format został już dodany, będzie on występować w wielu położeniach. Zostanie użyte pierwsze znalezione położenie.

Parametry

Eksportuje obiekt TextFlow do określonego formatu.

W celu określenia wartości parametru format należy użyć jednej ze stałych statycznych dostarczanych z tą klasą, typu MIME lub formatu zdefiniowanego przez użytkownika dla modułów eksportu zdefiniowanych przez użytkownika.

• TextConverter.TEXT_FIELD_HTML_FORMAT
• TextConverter.PLAIN_TEXT_FORMAT
• TextConverter.TEXT_LAYOUT_FORMAT

W parametrze conversionType należy określić typ eksportowanych danych za pomocą jednej ze stałych statycznych podawanych przez klasę ConversionType lub typu danych zdefiniowanego przez użytkownika dla funkcji eksportu zdefiniowanych przez użytkownika.

• ConversionType.STRING_TYPE
• ConversionType.XML_TYPE

Parametry

Powiązane elementy interfejsu API

Tworzy i zwraca moduł konwersji eksportu, którego można następnie użyć do eksportowania z obiektu TextFlow do źródłowego ciągu znaków lub obiektu XML. Z tej funkcji należy skorzystać, jeśli istnieje wiele osobnych operacji eksportu do wykonania. Użycie jej jest równoważne wywołaniu flashx.textLayout.conversion.TextConverter.export().

W celu określenia parametru format należy użyć stałej statycznej udostępnionej razem z klasą.

• TextConverter.TEXT_FIELD_HTML_FORMAT
• TextConverter.PLAIN_TEXT_FORMAT
• TextConverter.TEXT_LAYOUT_FORMAT

Jeśli format został dodany wiele razy, zostanie użyte pierwsze znalezione wystąpienie.

Parametry

Powiązane elementy interfejsu API

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 getExporter_example 
    {
        // Serialize the TextFlow into a String
        public function export(textFlow:TextFlow):String
        {
            var exporter:ITextExporter = TextConverter.getExporter(TextConverter.TEXT_LAYOUT_FORMAT);
            return exporter.export(textFlow, ConversionType.STRING_TYPE) as String;
        }
    }
}

Zwraca nazwę formatu o numerze określonym przez indeks.

Parametry

Zwraca obiekt FormatDescriptor dla formatu o numerze określonym przez indeks.

Parametry

Tworzy i zwraca moduł konwersji importu, za pomocą którego można następnie przeprowadzić importowanie do obiektu TextFlow z ciągu źródłowego, z obiektu XML lub z dowolnych formatów danych zdefiniowanych przez użytkownika. Z tej metody należy korzystać, jeśli istnieje wiele osobnych operacji importowania do wykonania lub podczas importowania jest wymagana obsługa błędów. Użycie jej jest równoważne wywołaniu flashx.textLayout.conversion.TextConverter.importToFlow().

W celu określenia parametru format należy użyć jednej ze stałych statycznych podawanych przez tę klasę, typu MIME lub formatu danych zdefiniowanego przez użytkownika.

• TextConverter.TEXT_FIELD_HTML_FORMAT
• TextConverter.PLAIN_TEXT_FORMAT
• TextConverter.TEXT_LAYOUT_FORMAT

Jeśli format został dodany wiele razy, zostanie użyte pierwsze znalezione wystąpienie.

Parametry

Powiązane elementy interfejsu API

package flashx.textLayout.conversion.examples
{
    import flashx.textLayout.conversion.ITextImporter;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.elements.TextFlow;
    
    public class getImporter_example 
    {
        public function importAndCheckErrors():TextFlow
        {
            var markup:String = "<TextFlow xmlns='http://ns.adobe.com/textLayout/2008'><p><span>Hello, World</span></p></TextFlow>";
            var importer:ITextImporter = TextConverter.getImporter(TextConverter.TEXT_LAYOUT_FORMAT);
            importer.throwOnError = false;
            var textFlow:TextFlow = importer.importToFlow(markup);
            if (!textFlow)
            {
                var errors:Vector.<String> = importer.errors;
                //deal with import errors
            }
            return textFlow;
        }
    }
}

Tworzy obiekt TextFlow z zawartości ródłowej w określonym formacie.

W celu określenia parametru format należy użyć jednej ze stałych statycznych podawanych przez tę klasę, typu MIME lub wartości zdefiniowanej przez użytkownika w przypadku funkcji importowania zarejestrowanych przez użytkownika.

• TextConverter.TEXT_FIELD_HTML_FORMAT
• TextConverter.PLAIN_TEXT_FORMAT
• TextConverter.TEXT_LAYOUT_FORMAT

Parametry

Powiązane elementy interfejsu API

Usuwa format. Jeśli format został dodany wiele razy, zostanie usunięte tylko jego pierwsze znalezione wystąpienie.

Parametry

Usuwa format o podanym indeksie.

Parametry

Format zwykłego tekstu. Służy do tworzenia obiektów TextFlow z prostego, niesformatowanego ciągu znaków lub do utworzenia prostego, niesformatowanego ciągu znaków z obiektu TextFlow.

Format HTML. Służy do importowania z lub eksportowania do obiektu TextFlow treści w formacie HTML. W podzbiorze języka HTML obsługiwanym przez architekturę Text Layout Framework można stosować znaczniki i atrybuty obsługiwane przez klasę TextField w pakiecie flash.text.

W poniższej tabeli wymieniono znaczniki i atrybuty HTML obsługiwane przez proces importowania i eksportowania (znaczniki i atrybuty obsługiwane przez klasę TextField, ale nieobsługiwane przez architekturę Text Layout Framework, są wyraźnie opisane jako nieobsługiwane):

Gdy jest importowany nieznany znacznik, moduł importu textFieldHTMLFormat ustawia dla pojedynczej właściwości typeName elementu FlowElement nazwę tego znacznika albo tworzy element DivElement lub SubParagraphGroupElement, dla którego we właściwości typeName jest ustawiana nazwa znacznika.

Moduł eksportu textFieldHTMLFormat eksportuje właściwość typeName jako znacznik XML, gdy różni się ona różnić od domyślnego.

Powiązane elementy interfejsu API

Format TextLayout. Służy do importowania z lub eksportowania do obiektu TextFlow treści w formacie TextLayout ze znacznikami. Format Text Layout wykryje następujące błędy:

• Nieoczekiwana przestrzeń nazw
• Nieznany element
• Nieznany atrybut

Ten przykład ilustruje użycie klasy konwersji TextConverter. Tekst w standardowym formacie ze znacznikami został zaimportowany do obiektu TextFlow, a następnie wyświetlony. Następnie tekst został wyeksportowany w formacie XML.

package flashx.textLayout.conversion.examples 
{
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.conversion.ConversionType;

    public class TextConverter_example extends Sprite
    {
        public function TextConverter_example()
        {
            var markup:String = "<TextFlow xmlns='http://ns.adobe.com/textLayout/2008'><p><span>Hello, World</span></p></TextFlow>";
            var textFlow:TextFlow = TextConverter.importToFlow(markup, TextConverter.TEXT_LAYOUT_FORMAT);
            textFlow.flowComposer.addController(new ContainerController(this, 200, 50));
            textFlow.flowComposer.updateAllControllers();
            //export to XML
            var xmlOut:XML = TextConverter.export(textFlow,TextConverter.TEXT_LAYOUT_FORMAT, ConversionType.XML_TYPE) as XML;
        }
    }
}