FlowComposerBase

包	flashx.textLayout.compose
类	public class FlowComposerBase
继承	FlowComposerBase Object
子类	StandardFlowComposer

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

FlowComposerBase 类是 Text Layout Framework 流合成器类的基类，用于控制 ContainerController 对象中文本行的合成。

FlowComposerBase 是一个实用程序类，用于实现多种类型的流合成器通用的方法和属性。应用程序代码通常不会实例化或使用该类，除非将其扩展为创建自定义流合成器。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		damageAbsoluteStart : int [只读] 需要合成和更新的文本流中第一个元素之前的绝对位置。	FlowComposerBase
		numLines : int [只读] 在流中合成的行的总数。	FlowComposerBase
		swfContext : ISWFContext 用于根据需要进行 FTE 调用的 ISWFContext 实例。	FlowComposerBase
		textFlow : flashx.textLayout.elements:TextFlow [只读] 此流合成器连接到的 TextFlow 对象。	FlowComposerBase

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		FlowComposerBase() 构造函数。	FlowComposerBase
		damage(startPosition:int, damageLength:int, damageType:String):void 将行标记为已损坏并需要重新合成。	FlowComposerBase
		findLineAtPosition(absolutePosition:int, preferPrevious:Boolean = false):flashx.textLayout.compose:TextFlowLine 返回包含指定位置处内容的 TextFlowLine 对象。	FlowComposerBase
		findLineIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int 返回包含指定位置处内容的 TextFlowLine 对象的顺序行号。	FlowComposerBase
		getLineAt(index:int):flashx.textLayout.compose:TextFlowLine 返回具有指定行号的行。	FlowComposerBase
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isDamaged(absolutePosition:int):Boolean 指示在流起始位置与包含指定位置处内容的行之间，是否有任何 TextFlowLine 对象标记为受损。	FlowComposerBase
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		updateLengths(startPosition:int, deltaLength:int):void 更新行中的长度以维护到 TextFlow 的映射。	FlowComposerBase
		valueOf():Object 返回指定对象的原始值。	Object

属性详细信息

damageAbsoluteStart

属性

damageAbsoluteStart:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

需要合成和更新的文本流中第一个元素之前的绝对位置。

实现
public function get damageAbsoluteStart():int

numLines

属性

numLines:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

在流中合成的行的总数。默认情况下，TLF 不合成整个流，并且此值可能不正确。使用 composeToPosition 合成所有行。

实现
public function get numLines():int

swfContext

属性

swfContext:ISWFContext

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

用于根据需要进行 FTE 调用的 ISWFContext 实例。

默认情况下，ISWFContext 实现是该 FlowComposerBase 对象。应用程序可以提供一个自定义实现，以使用嵌入在其它 SWF 文件中的字体，或者缓存并重用文本行。

实现
public function get swfContext():ISWFContext
public function set swfContext(value:ISWFContext):void

textFlow

属性

textFlow:flashx.textLayout.elements:TextFlow [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

此流合成器连接到的 TextFlow 对象。

实现
public function get textFlow():flashx.textLayout.elements:TextFlow

()

构造函数

public function FlowComposerBase()

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

构造函数。

方法详细信息

damage

()

方法

public function damage(startPosition:int, damageLength:int, damageType:String):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

将行标记为已损坏并需要重新合成。

参数

	`startPosition:int` — 要损坏的范围的开头

	`damageLength:int` — 要损坏的字符数

	`damageType:String` — 损坏的类型。flashx.textLayout.compose.FlowDamageType 之一

findLineAtPosition

()

方法

 public function findLineAtPosition(absolutePosition:int, preferPrevious:Boolean = false):flashx.textLayout.compose:TextFlowLine

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回包含指定位置处内容的 TextFlowLine 对象。

可将位置视为一个文本流中两个字符或其它元素之间的分界。如果 absolutePosition 值表示的位置介于一行中最后一个元素与下一行中第一个元素之间，那么，当 preferPrevious 参数设置为 true 时将返回前一行，而 preferPrevious 参数设置为 false 时则会返回后一行。

参数

	`absolutePosition:int` — 需要使用 TextFlowLine 对象的内容的位置。

	`preferPrevious:Boolean` (default = `false`) — 指定当位置介于一行中最后一个元素与下一行中第一个元素之间时，返回哪一行。

flashx.textLayout.compose:TextFlowLine — 包含指定位置处内容的 TextFlowLine，如果未找到则为 null。

findLineIndexAtPosition

()

方法

public function findLineIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回包含指定位置处内容的 TextFlowLine 对象的顺序行号。

第一行的编号为 0，最后一行的编号等于行数减一。如果 absolutePosition 指定的位置超出了文本流的末尾，则该方法一定返回将指定给添加到文本流中下一个新行的编号（等于当前行的行数）。

可将位置视为一个文本流中两个字符或其它元素之间的分界。如果 absolutePosition 值表示的位置介于一个容器中最后一行与下一个容器中第一行之间，那么，当 preferPrevious 参数设置为 true 时将返回前一个容器，而 preferPrevious 参数设置为 false 时则会返回后一个容器。

参数

	`absolutePosition:int` — 需要文本行的内容的位置。

	`preferPrevious:Boolean` (default = `false`) — 指定当位置介于一个容器中最后一行与下一个容器中第一行之间时，返回哪一个容器的索引。

int — 指定位置的文本行的索引。如果未找到，则视为超出末尾范围并返回行数。

getLineAt

()

方法

public function getLineAt(index:int):flashx.textLayout.compose:TextFlowLine

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回具有指定行号的行。

行列表从零开始编号，直到行数减一。如果 index 的值超出了行列表的范围限制，则该函数返回 null。

参数

index:int — 要返回的 TextFlowLine 对象的行号。

flashx.textLayout.compose:TextFlowLine — 具有指定行号的 TextFlowLine，如果未找到则为 null。

isDamaged

()

方法

public function isDamaged(absolutePosition:int):Boolean

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

指示在流起始位置与包含指定位置处内容的行之间，是否有任何 TextFlowLine 对象标记为受损。

参数

absolutePosition:int — 感兴趣区域中的最后一个位置

Boolean — 如果在流起始位置到包含 absolutePosition 位置处内容的行之间，有任何 TextFlowLine 对象标记为受损，则为 true。

updateLengths

()

方法

public function updateLengths(startPosition:int, deltaLength:int):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

更新行中的长度以维护到 TextFlow 的映射。

参数

	`startPosition:int` — 长度上更改的开始

	`deltaLength:int` — 字符数更改。

法律声明 | 在线隐私策略

FlowComposerBase - AS3

类 x

damageAbsoluteStart

numLines

swfContext

textFlow