TextConverter - Adobe ActionScript® 3 (AS3 ) API 参考

包	flashx.textLayout.conversion
类	public class TextConverter
继承	TextConverter Object

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

这是用于处理导入和导出的网关类。该类用作对 Text Layout Framework 中转换功能的统一访问点。该类包含用于预定义以及用户定义的输入和/或输出转换器的注册表，还有一组转换方法。

未预定义已转换数据的格式，用户写入的转换器可以接受和返回其选择的任何格式。常用格式为字符串、XML 和 ByteArray 实例。转换器作者应该记录哪些格式受支持。

查看示例

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		numFormats : int [静态] [只读] 格式数量。	TextConverter

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		addFormat(format:String, importerClass:Class, exporterClass:Class, clipboardFormat:String):void [静态] 为导入/导出注册新格式。	TextConverter
		addFormatAt(index:int, format:String, importerClass:Class, exporterClass:Class = null, clipboardFormat:String = null):void [静态] 在指定位置为导入/导出注册新格式。	TextConverter
		export(source:flashx.textLayout.elements:TextFlow, format:String, conversionType:String):Object [静态] 将 TextFlow 导出为指定格式。	TextConverter
		getExporter(format:String):flashx.textLayout.conversion:ITextExporter [静态] 创建并返回导出转换器，可使用该转换器从 TextFlow 导出到源字符串或 XML 对象。	TextConverter
		getFormatAt(index:int):String [静态] 返回第 index 个格式的格式名称。	TextConverter
		getFormatDescriptorAt(index:int):FormatDescriptor [静态] 返回第 index 个格式的 FormatDescriptor。	TextConverter
		getImporter(format:String, config:IConfiguration = null):flashx.textLayout.conversion:ITextImporter [静态] 创建并返回导入转换器，您之后可以使用该转换器从源字符串、XML 对象或任何用户定义的数据格式导入到 TextFlow。	TextConverter
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow [静态] 基于指定格式的源内容创建 TextFlow。	TextConverter
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeFormat(format:String):void [静态] 删除格式。	TextConverter
		removeFormatAt(index:int):void [静态] 删除在索引位置的格式。	TextConverter
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object

公共常量

	常量		由以下参数定义
		PLAIN_TEXT_FORMAT : String = "plainTextFormat" [静态] 纯文本格式。	TextConverter
		TEXT_FIELD_HTML_FORMAT : String = "textFieldHTMLFormat" [静态] HTML 格式。	TextConverter
		TEXT_LAYOUT_FORMAT : String = "textLayoutFormat" [静态] TextLayout 格式。	TextConverter

属性详细信息

numFormats

属性

numFormats:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

格式数量。

实现
public static function get numFormats():int

方法详细信息

addFormat

()

方法

public static function addFormat(format:String, importerClass:Class, exporterClass:Class, clipboardFormat:String):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

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

参数

	`format:String` — 要注册的导入转换器类或为 null

	`importerClass:Class` — 要注册的导出转换器类或为 null

	`exporterClass:Class` — 标记转换器类的格式字符串。格式可以为任何名称，但必须是唯一的。

	`clipboardFormat:String` — 转换到剪贴板/从剪贴板转换时用作剪贴板格式的字符串。如果格式不支持剪贴板访问，则使其为 null。

addFormatAt

()

方法

 public static function addFormatAt(index:int, format:String, importerClass:Class, exporterClass:Class = null, clipboardFormat:String = null):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

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

参数

	`index:int` — 要注册的导入转换器类或为 null

	`format:String` — 要注册的导出转换器类或为 null

	`importerClass:Class` — 标记转换器类的格式字符串

	`exporterClass:Class` (default = `null`) — 转换到剪贴板/从剪贴板转换时用作剪贴板格式的字符串。如果格式不支持剪贴板访问，则使其为 null。

	`clipboardFormat:String` (default = `null`)

export

()

方法

public static function export(source:flashx.textLayout.elements:TextFlow, format:String, conversionType:String):Object

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

将 TextFlow 导出为指定格式。

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

TextConverter.TEXT_FIELD_HTML_FORMAT
TextConverter.PLAIN_TEXT_FORMAT
TextConverter.TEXT_LAYOUT_FORMAT

在 conversionType 参数中使用 ConversionType 类提供的静态常量之一或针对用户定义导出器的用户定义数据类型，指定所导出数据的类型：

ConversionType.STRING_TYPE
ConversionType.XML_TYPE

返回指定格式的 TextFlow 形式，否则错误时为 null。

参数

	`source:flashx.textLayout.elements:TextFlow` — 源内容

	`format:String` — 输出格式

	`conversionType:String` — 所导出数据的类型

Object — 对象 - TextFlow 的导出形式，否则错误时为 null

getExporter

()

方法

public static function getExporter(format:String):flashx.textLayout.conversion:ITextExporter

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

创建并返回导出转换器，可使用该转换器从 TextFlow 导出到源字符串或 XML 对象。如果您要执行很多单独的导出，可以使用此函数。这与调用 flashx.textLayout.conversion.TextConverter.export() 等效。

使用此类提供的静态常量之一来指定 format 参数：

TextConverter.TEXT_FIELD_HTML_FORMAT
TextConverter.PLAIN_TEXT_FORMAT
TextConverter.TEXT_LAYOUT_FORMAT

如果已多次添加格式，则会使用首先找到的格式。

参数

format:String — 所导出数据的目标格式

flashx.textLayout.conversion:ITextExporter — 可以按指定格式导出的 ITextExporter 文本导出器

示例 ( 如何使用本示例 )

此代码段说明使用 getExporter 方法来执行带格式文本的重复导出。


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

getFormatAt

()

方法

public static function getFormatAt(index:int):String

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

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

参数

index:int

String

getFormatDescriptorAt

()

方法

public static function getFormatDescriptorAt(index:int):FormatDescriptor

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回第 index 个格式的 FormatDescriptor。

参数

index:int

FormatDescriptor

getImporter

()

方法

 public static function getImporter(format:String, config:IConfiguration = null):flashx.textLayout.conversion:ITextImporter

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

创建并返回导入转换器，您之后可以使用该转换器从源字符串、XML 对象或任何用户定义的数据格式导入到 TextFlow。如果您需要执行很多单独的导入，或者希望在导入期间处理错误，可使用此方法。这与调用 flashx.textLayout.conversion.TextConverter.importToFlow() 等效。

使用此类提供的静态常量之一来指定 format 参数，或使用 MIME 类型或用户定义的数据格式来指定。

TextConverter.TEXT_FIELD_HTML_FORMAT
TextConverter.PLAIN_TEXT_FORMAT
TextConverter.TEXT_LAYOUT_FORMAT

如果已多次添加格式，则会使用首先找到的格式。

参数

	`format:String` — 源内容的格式。使用 flashx.textLayout.conversion.TextConverter.TEXT_LAYOUT_FORMAT、PLAIN_TEXT_FORMAT、TEXT_FIELD_HTML_FORMAT 等常量、MIME 类型或用户定义的格式。

	`config:IConfiguration` (default = `null`) — 在该导入期间要使用的配置。null 表示采用当前默认值。您也可以通过 `ITextImporter.configuration` 属性设置配置。

flashx.textLayout.conversion:ITextImporter — 可以导入源数据的 ITextImporter 文本导入器

示例 ( 如何使用本示例 )

此代码段演示使用 getImporter 方法来执行带格式文本的重复导入。请注意，在每次调用 importToFlow 初期会清除错误。


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

importToFlow

()

方法

 public static function importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

基于指定格式的源内容创建 TextFlow。

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

TextConverter.TEXT_FIELD_HTML_FORMAT
TextConverter.PLAIN_TEXT_FORMAT
TextConverter.TEXT_LAYOUT_FORMAT

参数

	`source:Object` — 源内容

	`format:String` — 源内容格式

	`config:IConfiguration` (default = `null`) — 创建新的 TextFlow 时要使用的 IConfiguration

flashx.textLayout.elements:TextFlow — 从源中创建的 TextFlow，否则错误时为 null。

removeFormat

()

方法

public static function removeFormat(format:String):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

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

参数

format:String — 要删除的转换器格式字符串

removeFormatAt

()

方法

public static function removeFormatAt(index:int):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

删除在索引位置的格式。

参数

index:int — 要删除的格式

常量详细信息

PLAIN_TEXT_FORMAT

常量

public static const PLAIN_TEXT_FORMAT:String = "plainTextFormat"

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

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

TEXT_FIELD_HTML_FORMAT

常量

public static const TEXT_FIELD_HTML_FORMAT:String = "textFieldHTMLFormat"

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

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

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

标签	说明
锚标签	`<a>` 标签创建超文本链接并支持以下属性： `target`：指定加载页面的目标窗口的名称。选项包括 `_self`、`_blank`、`_parent` 和 `_top`。`_self` 选项指定当前窗口中的当前帧，`_blank` 指定一个新窗口，`_parent` 指定当前帧的父级，而 `_top` 指定当前窗口中的顶级帧。 `href`：指定一个 URL。该 URL 可以是绝对路径，也可以是相对路径（相对于加载该页的 SWF 文件的位置）。`http://www.adobe.com` 示例表示对 URL 的绝对引用；`/index.html` 示例表示相对引用。绝对 URL 必须以 http:// 为前缀，否则 Flash 会将其视为相对 URL。注意：与 TextField 类不同，不支持 ActionScript `link` 事件。也不支持 `a:link`、`a:hover` 和 `a:active` 样式。
粗体标签	`<b>` 标签以粗体形式呈现文本。粗体必须可用于所使用的字体。
换行标签	`<br>` 标记将在文本中创建一个换行符。
字体标签	`<font>` 标签指定一种字体或一个字体列表来显示文本。字体标签支持以下属性： `color`：只支持十六进制颜色 (`#FFFFFF`) 值。 `face`：指定要使用的字体的名称。如下例所示，您可以指定一个以逗号分隔的字体名称的列表，在这种情况下，Flash Player 选择第一个可用字体。如果本地计算机系统上未安装指定的字体，或 SWF 文件中未嵌入指定的字体，则 Flash Player 将选择替代字体。 `size`：指定字体的大小。您可以使用绝对像素大小（如 16 或 18），也可以使用相对点值（如 +2 或 -4）。 `letterspacing`：指定应用到每个字符右侧的间距（手动字距微调），以像素为单位。 `kerning`：指定字距微调处于启用状态还是禁用状态。非零值表示启用字距微调，而零表示禁用字距微调。
图像标签	使用 `<img>` 标记，可将外部图像文件（JPEG、GIF、PNG）、SWF 文件和影片剪辑嵌入到文本中。 `<img>` 标签支持以下属性： `src`：指定图像或 SWF 文件的 URL，或库中影片剪辑元件的链接标识符。此属性是必需的，所有其他属性都是可选的。外部文件（JPEG、GIF、PNG 和 SWF 文件）只有在完全下载之后才能显示。 `width`：所插入的图像、SWF 文件或影片剪辑的宽度（以像素为单位）。 `height`：所插入的图像、SWF 文件或影片剪辑的高度（以像素为单位）。注意：与 TextField 类不同，不支持下列属性：`align`、`hspace`、`vspace`、`id` 和 `checkPolicyFile`。
斜体标签	`<i>` 标签以斜体形式显示标签中的文本。斜体必须可用于所使用的字体。
列表项标签	注意：与 TextField 类不同，不支持 List 项标签。
段落标签	`<p>` 标签创建一个新段落。`<p>` 标签支持以下属性： align：指定段落内文本的对齐方式；有效值为 `left`、`right`、`justify` 和 `center`。 class：指定可以用于设置样式的类名称
Span 标签	`<span>` 标签支持以下属性： class：指定可用于设置样式的类名称。虽然 span 标签常用于设置样式表中定义的样式，但 TLFTextField 实例不支持样式表。TLFTextField 实例可以使用 span 标签来引用带有样式属性的类。还可以将属性直接放入 span 标签中：`<span fontFamily="Arial">Hi there</span>`。但是，系统不支持嵌套的 span 标签。
文本格式标签	使用 `<textformat>` 标签可在文本字段中使用 TextFormat 类的段落格式设置属性的子集，其中包括行距、缩进、边距和 Tab 停靠位。您可以将 `<textformat>` 标签与内置 HTML 标签结合使用。 `<textformat>` 标签具有以下属性： `indent`：指定从左边距到段落中第一个字符的缩进；对应于 `TextFormat.indent`。正数和负数均可以接受。 `blockindent`：指定应用于段落所有行的缩进。 `leftmargin`：指定段落的左边距（以点为单位）；对应于 `TextFormat.leftMargin`。 `rightmargin`：指定段落的右边距（以点为单位）；对应于 `TextFormat.rightMargin`。 `leading`：指定一行的上缘与上一行的下缘之间的像素行距（行高）。 `tabstops`：指定段落的制表位位置以逗号分隔的列表。
下划线标签	`<u>` 标签为标签文本添加下划线。

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

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

TEXT_LAYOUT_FORMAT

常量

public static const TEXT_LAYOUT_FORMAT:String = "textLayoutFormat"

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

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

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

示例如何使用本示例

TextConverter_example.as

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

法律声明 | 在线隐私策略

TextConverter - AS3

类 x

numFormats

addFormat

addFormatAt

export

getExporter

getFormatAt

getFormatDescriptorAt

getImporter

importToFlow

removeFormat

removeFormatAt

PLAIN_TEXT_FORMAT

TEXT_FIELD_HTML_FORMAT

TEXT_LAYOUT_FORMAT