TextFlowLine

包	flashx.textLayout.compose
类	public final class TextFlowLine
继承	TextFlowLine Object
实现	IVerticalJustificationLine

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

TextFlowLine 类表示文本流中的单个文本行。

使用该类可以访问有关如何合成文本行的信息：其位置、高度、宽度等。当修改了文本流 (TextFlow) 时，位于修改位置及其之前位置的文本行将被标记为无效，因为它们需要重新合成。位于修改位置之后的行可能不会立即损坏，但是可能在重新合成文本后立即重新生成。可以访问受损的 TextFlowLine，但是访问的任何值反映的都是 TextFlow 的原有状态。重新合成 TextFlow 时，它会生成新行，您可以通过调用 TextFlow.flowComposer.findLineAtPosition() 获取给定位置的新行。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		absoluteStart : int [只读] TextFlow 对象中行的位置，是绝对字符位置。	TextFlowLine
		ascent : Number [只读] 指定从基线到行中最高字符顶部的像素数。	TextFlowLine
		columnIndex : int [只读] 该行所在的列编号，第一列为 0。	TextFlowLine
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		controller : ContainerController [只读] 放置了该行的容器的控制器（ContainerController 对象）。	TextFlowLine
		descent : Number [只读] 指定从基线到行中最低字符底部的像素数。	TextFlowLine
		height : Number [只读] 行的高度（像素数）。	TextFlowLine
		lineOffset : Number [只读] 在对齐段落中的行之前，行与相应容器边界（由段落方向和容器块行进方向表示）之间的偏移（像素数）。	TextFlowLine
		location : int [只读] 来自 TextFlowLineLocation 的一个值，用于指定一行在段落内的位置。	TextFlowLine
		paragraph : ParagraphElement [只读] 行所在的段落 (ParagraphElement)。	TextFlowLine
		spaceAfter : Number [只读] 行之后留出的空格数。	TextFlowLine
		spaceBefore : Number [只读] 行之前留出的空格数。	TextFlowLine
		textHeight : Number [只读] 文本行的高度，等于 ascent + descent。	TextFlowLine
		textLength : int [只读] 下一行的字符数，包括末尾空格。	TextFlowLine
		textLineExists : Boolean [只读] 指示该 TextFlowLine 是否具有 flash.text.engine.TextLine 对象。	TextFlowLine
		unjustifiedTextWidth : Number [只读] 行未两端对齐时的宽度。	TextFlowLine
		validity : String [只读] 行的有效性。	TextFlowLine
		x : Number 该行相对于其容器的水平位置，以距容器左侧的像素偏移表示。	TextFlowLine
		y : Number 行相对于其容器的垂直位置，表达为距容器顶部的偏移（以像素为单位）。	TextFlowLine

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		TextFlowLine(textLine:flash.text.engine:TextLine, paragraph:ParagraphElement, outerTargetWidth:Number = 0, lineOffset:Number = 0, absoluteStart:int = 0, numChars:int = 0) 构造函数 - 创建新 TextFlowLine 实例。	TextFlowLine
		getBounds():Rectangle 将行边界范围返回为一个矩形。	TextFlowLine
		getTextLine(forceValid:Boolean = false):flash.text.engine:TextLine 返回该行的 flash.text.engine.TextLine 对象，如果由于垃圾收集而使该对象不存在，则可能会重新创建。	TextFlowLine
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		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
		valueOf():Object 返回指定对象的原始值。	Object

属性详细信息

absoluteStart

属性

absoluteStart:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

TextFlow 对象中行的位置，是绝对字符位置。

实现
public function get absoluteStart():int

相关 API 元素

flashx.textLayout.elements.TextFlow

ascent

属性

ascent:Number [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

指定从基线到行中最高字符顶部的像素数。对于仅包含图形元素的 TextLine，将 ascent 设置为 0。

实现
public function get ascent():Number

columnIndex

属性

columnIndex:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

该行所在的列编号，第一列为 0。

实现
public function get columnIndex():int

controller

属性

controller:ContainerController [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

放置了该行的容器的控制器（ContainerController 对象）。

实现
public function get controller():ContainerController

descent

属性

descent:Number [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

指定从基线到行中最低字符底部的像素数。对于仅包含图形元素的 TextLine，将 descent 设置为 0。

实现
public function get descent():Number

height

属性

height:Number [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

行的高度（像素数）。

实现
public function get height():Number

lineOffset

属性

lineOffset:Number [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

在对齐段落中的行之前，行与相应容器边界（由段落方向和容器块行进方向表示）之间的偏移（像素数）。

实现
public function get lineOffset():Number

location

属性

location:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

来自 TextFlowLineLocation 的一个值，用于指定一行在段落内的位置。

实现
public function get location():int

paragraph

属性

paragraph:ParagraphElement [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

行所在的段落 (ParagraphElement)。

实现
public function get paragraph():ParagraphElement

spaceAfter

属性

spaceAfter:Number [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

行之后留出的空格数。

如果该行是后面包含空格的段落中的最后一行，则该行将具有 spaceAfter 值。如果该行位于一个列的底端，则会忽略 spaceAfter。否则，该行位于列中其它行之前，且必须垂直放置下一行，才可确保在此段落中的最后一行与下一段落中的第一行之间至少留有这些空格。

实现
public function get spaceAfter():Number

相关 API 元素

TextLayoutFormat.paragraphSpaceAfter

spaceBefore

属性

spaceBefore:Number [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

行之前留出的空格数。

如果该行是前面包含空格的段落中的第一行，则该行将具有 spaceBefore 值。如果该行位于列的顶端，则会忽略 spaceBefore。否则，该行位于列中其它行之后，且会垂直放置，以确保在该行与上一段落中的最后一行之间至少留有这些空格。

实现
public function get spaceBefore():Number

相关 API 元素

TextLayoutFormat.paragraphSpaceBefore

textHeight

属性

textHeight:Number [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

文本行的高度，等于 ascent + descent。该值根据限制行的基线之间（可以是表意字符顶部与底部之间或上缘与下缘之间）的差进行计算，具体取决于 y=0 的基线是否是表意的（例如 TextBaseline.IDEOGRAPHIC_TOP）。

实现
public function get textHeight():Number

相关 API 元素

TextBaseline

textLength

属性

textLength:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

下一行的字符数，包括末尾空格。

实现
public function get textLength():int

textLineExists

属性

textLineExists:Boolean [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

指示该 TextFlowLine 是否具有 flash.text.engine.TextLine 对象。如果未对 TextLine 对象进行垃圾收集，则该值为 true，否则为 false。

实现
public function get textLineExists():Boolean

相关 API 元素

TextLine

unjustifiedTextWidth

属性

unjustifiedTextWidth:Number [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

行未两端对齐时的宽度。对于未两端对齐的文本，该值与 textLength 相同。对于两端对齐的文本，该值是未两端对齐时的文本长度，而 textLength 表示实际的行宽。例如，当将以下字符串两端对齐并具有 500 宽度值时，该字符串的实际宽度为 500，而未两端对齐的字符串宽度为 268.9921875。

实现
public function get unjustifiedTextWidth():Number

validity

属性

validity:String [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

行的有效性。

如果自创建一行之后更改了文本、应用于该行的属性或控制器设置，则该行可能无效。一个无效的行仍然可以显示，您也可以使用该行，但是使用的值将是创建该行时的值。getTextLine 返回的行也会处于无效状态。

实现
public function get validity():String

x

属性

x:Number

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

该行相对于其容器的水平位置，以距容器左侧的像素偏移表示。

注意：尽管此属性在技术上为读写属性，但应将其作为只读属性对待。setter 存在仅仅是为了满足 IVerticalJustificationLine 接口的要求，该接口为该属性定义 getter 和 setter。尽管有可能使用 setter，但使用它将导致不可预测的结果。

实现
public function get x():Number
public function set x(value:Number):void

相关 API 元素

y

属性

y:Number

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

行相对于其容器的垂直位置，表达为距容器顶部的偏移（以像素为单位）。

实现
public function get y():Number
public function set y(value:Number):void

相关 API 元素

构造函数详细信息

()

构造函数

public function TextFlowLine(textLine:flash.text.engine:TextLine, paragraph:ParagraphElement, outerTargetWidth:Number = 0, lineOffset:Number = 0, absoluteStart:int = 0, numChars:int = 0)

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

构造函数 - 创建新 TextFlowLine 实例。

注意：任何客户端均不应调用此。其用于创建自定义合成器。

参数

	`textLine:flash.text.engine:TextLine` — 将用于该行的 TextLine 显示对象。

	`paragraph:ParagraphElement` — 将该行放置到的段落 (ParagraphElement)。

	`outerTargetWidth:Number` (default = `0`) — 合成行时的宽度，不包括缩进。

	`lineOffset:Number` (default = `0`) — 在对齐段落中的行之前，行与相应容器边界（由段落方向和容器块行进方向表示）之间的偏移（像素数）。

	`absoluteStart:int` (default = `0`) — 文本流中行的起始字符位置。

	`numChars:int` (default = `0`) — 行中的字符数。

方法详细信息

getBounds

()

方法

public function getBounds():Rectangle

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

将行边界范围返回为一个矩形。

Rectangle — 表示行边界范围的矩形。

getTextLine

()

方法

public function getTextLine(forceValid:Boolean = false):flash.text.engine:TextLine

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回该行的 flash.text.engine.TextLine 对象，如果由于垃圾收集而使该对象不存在，则可能会重新创建。将 forceValid 设置为 true 会重新生成 TextLine。如果无法重新创建 TextLine，则返回 null。

参数

forceValid:Boolean (default = false) — 如果为 true，则会重新生成 TextLine（如果它存在但无效）。

flash.text.engine:TextLine — 该行的对象，如果无法重新创建 TextLine 对象，则为 null。

相关 API 元素

TextLine

法律声明 | 在线隐私策略

TextFlowLine - AS3

类 x

absoluteStart

ascent

columnIndex

controller

descent

height

lineOffset

location

paragraph

spaceAfter

spaceBefore

textHeight

textLength

textLineExists

unjustifiedTextWidth

validity

x

y

TextFlowLine

getBounds

getTextLine