TextConverter  - AS3

格式数量。

为导入/导出注册新格式。新格式将添加在末尾，作为最低优先级。对于使用的格式具有多个选择（例如从外部剪贴板导入时）的客户端来说，位置十分重要。新的格式可能支持导入和/或导出。如果已添加此格式，则会在多个位置中存在。会使用首先找到的格式。

参数

在指定位置为导入/导出注册新格式。对于使用的格式具有多个选择（例如从外部剪贴板导入时）的客户端来说，位置十分重要。较小的数字表明较高的优先级，会首先尝试这些转换器。新的格式可能支持导入和/或导出。如果已添加此格式，则会在多个位置中存在。会使用首先找到的格式。

参数

将 TextFlow 导出为指定格式。

使用此类提供的静态常量之一、MIME 类型或针对用户定义导出器的用户定义格式来指定 format 参数：

• 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;
        }
    }
}

返回第 index 个格式的格式名称。

参数

返回第 index 个格式的 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。

使用此类提供的静态常量之一、MIME 类型来指定 format 参数，或者使用针对用户注册的导入器的用户定义值来指定：

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

参数

相关 API 元素

删除格式。如果多次添加格式，则仅删除首次找到的格式。

参数

删除在索引位置的格式。

参数

纯文本格式。使用此常量，可基于简单无格式的字符串创建 TextFlow，或基于 TextFlow 创建简单无格式的字符串。

HTML 格式。使用此常量，可用 HTML 格式从 TextFlow 导入或导出到 TextFlow。Text Layout Framework HTML 支持 flash.text 包中的 TextField 类所支持的标记和属性子集。

下表列出了对于导入和导出过程支持的 HTML 标记和属性（TextField 支持但 Text Layout Framework 不支持的标记和属性被专门描述为不支持）：

未知标签导入时，textFieldHTMLFormat 导入器会将单个 FlowElement 的 typeName 属性设置为此标签名称，或使用被设置为标签名称的 typeName 属性创建 DivElement 或 SubParagraphGroupElement。

typeName 与默认情况不同时，textFieldHTMLFormat 导出器会将其导出为 XML 标签。

相关 API 元素

TextLayout 格式。使用此常量，可用 TextLayout 标记格式从 TextFlow 导入或导出到 TextFlow。文本布局格式将检测下列错误：

• 意外命名空间
• 未知元素
• 未知属性

此示例演示了 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;
        }
    }
}