TextConverter  - AS3

Количество форматов.

Регистрация нового формата для импорта или экспорта. Новый формат будет добавлен к концу как имеющий наиболее низкий приоритет. Расположение исключительно важно для клиентов, имеющих несколько вариантов форматов для использования, например при импорте из внешнего буфера обмена. Новый формат может поддерживать экспорт или импорт. Если формат уже добавлен, он будет присутствовать в нескольких местоположениях. При этом будет использоваться первый найденный формат.

Параметры

Регистрация нового формата для импорта или экспорта в указанном местоположении. Расположение исключительно важно для клиентов, имеющих несколько вариантов форматов для использования, например при импорте из внешнего буфера обмена. Меньшие числа обозначают более высокий приоритет; сначала будут использоваться именно эти конвертеры. Новый формат может поддерживать экспорт или импорт. Если формат уже добавлен, он будет присутствовать в нескольких местоположениях. При этом будет использоваться первый найденный формат.

Параметры

Обеспечивает экспорт TextFlow в указанный формат.

Для определения параметра format используйте одну из статических констант, предоставляемых этим классом, тип MIME или определенный пользователем формат для средств экспорта, указанных пользователем:

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

Укажите тип экспортируемых данных в параметре conversionType и одну из статических констант, предоставленных классом ConversionType, или определенный пользователем тип данных для средств экспорта, указанных пользователем:

• ConversionType.STRING_TYPE
• ConversionType.XML_TYPE

Параметры

Связанные элементы API

Создает и возвращает конвертер экспорта, который впоследствии может использоваться для экспорта из TextFlow в исходную строку или XML-объект. Эта функция применяется при наличии множества отдельных операций экспорта, подлежащих выполнению. Она эквивалентна вызову метода flashx.textLayout.conversion.TextConverter.export().

Для определения параметра format используется одна из статических констант, предоставляемых с этим классом:

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

Если формат добавляется несколько раз, будет использоваться первый найденный формат.

Параметры

Связанные элементы 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;
        }
    }
}

Возвращает имя формата для формата индекса.

Параметры

Возвращает FormatDescriptor для формата индекса.

Параметры

Создает и возвращает конвертер импорта, который впоследствии может использоваться для импорта из исходной строки, XML-объекта или любых указанных пользователем форматов данных в TextFlow. Этот метод применяется при наличии множества отдельных операций импорта, подлежащих выполнению, или в случае необходимости обработки ошибок в ходе импорта. Она эквивалентна вызову метода flashx.textLayout.conversion.TextConverter.importToFlow().

Для определения параметра format используется одна из статических констант, предоставляемых с этим классом, тип MIME или определенный пользователем формат данных:

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

Если формат добавляется несколько раз, будет использоваться первый найденный формат.

Параметры

Связанные элементы 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;
        }
    }
}

Создает TextFlow из исходного содержимого в заданном формате.

Для определения параметра format используется одна из статических констант, предоставляемых с этим классом, или определенное пользователем значение для средств импорта, зарегистрированных пользователем:

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

Параметры

Связанные элементы API

Удаление формата. Если формат добавлялся несколько раз, будет удален только первый найденный формат.

Параметры

Удаление формата в местоположении индекса.

Параметры

Формат обычного текста. Эта константа применяется для создания TextFlow из простой неотформатированной строки или для создания простой неотформатированной строки из TextFlow.

Формат HTML. Эта константа применяется для импорта из TextFlow или экспорта в TextFlow с использованием формата HTML. Text Layout Framework HTML поддерживает подмножество тегов и атрибутов, поддерживаемых классом TextField в пакете flash.text.

В следующей таблице представлены HTML-теги и атрибуты, поддерживаемые для импорта и экспорта (теги и атрибуты, поддерживаемые TextField, но не поддерживаемые Text Layout Framework, специально отмечаются как не поддерживаемые):

При импорте неопределенного тега средство импорта textFieldHTMLFormat установит одно свойство typeName в FlowElement для этого имени тега или создаст DivElement или SubParagraphGroupElement, свойство typeName которых будет соответствовать имени тега.

Средство экспорта textFieldHTMLFormat выполнит экспорт typeName как тега XML, если он будет отличаться от значения по умолчанию.

Связанные элементы API

Формат TextLayout. Эта константа применяется для импорта из TextFlow или экспорта в TextFlow с использованием формата разметки TextLayout. В формате Text Layout обеспечивается обнаружение следующих ошибок:

• непредвиденного пространства имен;
• неизвестных элементов;
• неизвестных атрибутов.

В этом примере демонстрируется применение класса преобразования TextConverter. Текст в стандартном формате разметки импортируется в объект TextFlow, после чего выводится на экран. Затем текст экспортируется в 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;
        }
    }
}