flash.text.engine
public class ContentElement
继承ContentElement Inheritance Object
子类 GraphicElement, GroupElement, TextElement

语言版本: ActionScript 3.0
运行时版本: Flash Player 10, AIR 1.5

ContentElement 类用作可在 GroupElement 中显示的元素类型(即 GraphicElement、另一个 GroupElement 或 TextElement)的基类。

ContentElement 是一种抽象基类;因此,不能直接实例化 ContentElement。调用 new ContentElement() 会引发 ArgumentError 异常。

您只能将 ContentElement 元素分配给一个 GroupElement 或一个文本块的 content 属性。

另请参见

ElementFormat
GraphicElement
GroupElement
TextBlock.content
TextElement
TextLineMirrorRegion
TextRotation


公共属性
 属性定义方
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
  elementFormat : ElementFormat
用于元素的 ElementFormat 对象。
ContentElement
  eventMirror : EventDispatcher
EventDispatcher 对象,该对象将接收调度到基于此内容元素的有效文本行的每个事件的副本。
ContentElement
  groupElement : GroupElement
[只读 (read-only)] 包含此元素的 GroupElement 对象;如果此元素不在一个组中,则为 null。
ContentElement
 Inheritedprototype : Object
[静态] 对类或函数对象的原型对象的引用。
Object
  rawText : String
[只读 (read-only)] 元素中的文本的副本,包括 U+FDEF 字符。
ContentElement
  text : String
[只读 (read-only)] 元素中的文本的副本,不包括表示 String 中的图形元素的 U+FDEF 字符。
ContentElement
  textBlock : TextBlock
[只读 (read-only)] 此元素所属的 TextBlock。
ContentElement
  textBlockBeginIndex : int
[只读 (read-only)] 文本块中此元素的第一个字符的索引。
ContentElement
  textRotation : String
应用于元素的旋转(旋转时将元素作为一个单元)。
ContentElement
  userData : *
为作者提供了一种将任意数据与元素相关联的途径。
ContentElement
公共方法
 方法定义方
  
ContentElement(elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")
调用 new ContentElement() 构造函数会引发 ArgumentError 异常。
ContentElement
 Inherited
指示对象是否已经定义了指定的属性。
Object
 Inherited
指示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
 Inherited
指示指定的属性是否存在、是否可枚举。
Object
 Inherited
设置循环操作动态属性的可用性。
Object
 Inherited
返回指定对象的字符串表示形式。
Object
 Inherited
返回指定对象的原始值。
Object
公共常量
 常量定义方
  GRAPHIC_ELEMENT : uint = 0xFDEF
[静态] 指示文本中存在图形元素。
ContentElement
属性详细信息
elementFormat属性
elementFormat:ElementFormat  [读写]

语言版本: ActionScript 3.0
运行时版本: Flash Player 10, AIR 1.5

用于元素的 ElementFormat 对象。

默认值为 null

如果设置了 elementFormat 属性,提供的 ElementFormat 对象已锁定,则其 locked 属性将设置为 true。无法修改已锁定的 ElementFormat。



实现
    public function get elementFormat():ElementFormat
    public function set elementFormat(value:ElementFormat):void

另请参见

eventMirror属性 
eventMirror:EventDispatcher  [读写]

语言版本: ActionScript 3.0
运行时版本: Flash Player 10, AIR 1.5

EventDispatcher 对象,该对象将接收调度到基于此内容元素的有效文本行的每个事件的副本。指定的对象可用于设置文本链接或其他交互式文本片段的侦听器,原因是在运行时确定从特定内容元素生成行的哪个部分可能会很难。还可以使用侦听器来应用装饰(如下划线),因为在布置完文本之前,无法确定这些装饰的度量。默认值为 null,这意味着不调度任何镜像的事件。

事件镜像在文本行中将自己声明为 TextLineMirrorRegion 类的实例。取决于双向处理和断行,可能会生成一个或多个镜像区域。

默认值为 null



实现
    public function get eventMirror():EventDispatcher
    public function set eventMirror(value:EventDispatcher):void

另请参见

groupElement属性 
groupElement:GroupElement  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: Flash Player 10, AIR 1.5

包含此元素的 GroupElement 对象;如果此元素不在一个组中,则为 null

默认值为 null



实现
    public function get groupElement():GroupElement

另请参见

rawText属性 
rawText:String  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: Flash Player 10, AIR 1.5

元素中的文本的副本,包括 U+FDEF 字符。U+FDEF 字符为表示 String 中的图形元素的任意字符。



实现
    public function get rawText():String
text属性 
text:String  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: Flash Player 10, AIR 1.5

元素中的文本的副本,不包括表示 String 中的图形元素的 U+FDEF 字符。



实现
    public function get text():String

另请参见

textBlock属性 
textBlock:TextBlock  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: Flash Player 10, AIR 1.5

此元素所属的 TextBlock。

默认值为 null



实现
    public function get textBlock():TextBlock

另请参见

textBlockBeginIndex属性 
textBlockBeginIndex:int  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: Flash Player 10, AIR 1.5

文本块中此元素的第一个字符的索引。此值不进行缓存;每当调用此方法时便会计算此值。

默认值为 -1。



实现
    public function get textBlockBeginIndex():int
textRotation属性 
textRotation:String  [读写]

语言版本: ActionScript 3.0
运行时版本: Flash Player 10, AIR 1.5

应用于元素的旋转(旋转时将元素作为一个单元)。将 TextRotation 常量用于此属性。

默认值为 TextRotation.ROTATE_0

任何字型的最终旋转均为 ElementFormat.textRotation、ContentElement.textRotation 与 TextBlock.lineRotation 之和。

ContentElement.textRotation 用于创建一小串文本,其旋转不同于包含行。例如,日语文本中的 TCY 串。TCY 代表 Tate-Chu-Yoko,是指某些垂直显示的日文文本中的少量水平显示的文本(通常是数字)。若要创建包含 TCY 串的日语垂直文本段落,请执行以下操作:

  1. 设置 TextBlock.lineRotation=TextRotation.ROTATE_90
  2. TextBlock.content 设置为由三个 TextElement 对象构成的 GroupElement。这些元素中的第一个元素应为 TCY 串之前的日语文本,第二个元素应为 TCY 串的拉丁语文本,第三个元素应为 TCY 串之后的日语文本。
  3. 将 TCY TextElementtextRotation 属性设置为 TextRotation.ROTATE_270。TCY 文本元素将作为一个单元进行旋转。它首先开始执行从行中继承的 90 度旋转。再加上 270 度将使其旋转到水平位置。

无法嵌套旋转的内容元素。在内容元素的任何层次结构中,不管结构多复杂,都只能设置一个内容元素的 textRotation 属性。如果检测到嵌套的旋转,则以下方法和属性 setter 将引发参数错误:

  1. ContentElement.textRotation
  2. GroupElement.setElements
  3. GroupElement.replaceElements

若要设置此属性的值,请使用下列字符串值:

字符串值Description
TextRotation.ROTATE_0 不旋转元素。
TextRotation.ROTATE_90 将元素顺时针旋转 90 度。
TextRotation.ROTATE_180 将元素旋转 180 度。
TextRotation.ROTATE_270 将元素顺时针旋转 270 度。
TextRotation.AUTO 不支持.



实现
    public function get textRotation():String
    public function set textRotation(value:String):void

引发
ArgumentError — 如果设置的值不是 TextRotation 的成员。
 
ArgumentError — 如果设置为 TextRotation.AUTO
 
ArgumentError — 如果操作将在 GroupElement 内生成嵌套旋转。

另请参见

userData属性 
public var userData:*

语言版本: ActionScript 3.0
运行时版本: Flash Player 10, AIR 1.5

为作者提供了一种将任意数据与元素相关联的途径。

默认值为 null

构造函数详细信息
ContentElement()构造函数
public function ContentElement(elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")

语言版本: ActionScript 3.0
运行时版本: Flash Player 10, AIR 1.5

调用 new ContentElement() 构造函数会引发 ArgumentError 异常。但是,可以调用 ContentElement 的以下子类的构造函数:

参数
elementFormat:ElementFormat (default = null) — 元素中文本的元素格式。默认值为 null
 
eventMirror:EventDispatcher (default = null)EventDispatcher 对象,该对象将接收调度到基于此内容元素创建的有效文本行的每个事件的副本。默认值为 null
 
textRotation:String (default = "rotate0") — 作为一个单元应用于元素的旋转。将 TextRotation 常量用于此属性。默认值为 TextRotation.ROTATE_0
常量详细信息
GRAPHIC_ELEMENT常量
public static const GRAPHIC_ELEMENT:uint = 0xFDEF

语言版本: ActionScript 3.0
运行时版本: Flash Player 10, AIR 1.5

指示文本中存在图形元素。

另请参见