用于 Adobe® Flash® Platform 的 ActionScript® 3.0 参考
主页  |  隐藏包列表和类列表 |   |   |  新增内容  |  索引  |  附录  |  为什么显示为英语?
过滤条件: AIR 30.0 和更早版本, Flash Player 30.0 和更早版本, Flash Lite 4
Flex 4.6 和更早版本, Flash Pro CS6 和更早版本
隐藏过滤条件
flash.text.engine 

ContentElement  - AS3

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

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

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

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

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

相关 API 元素



公共属性
 属性由以下参数定义
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
  elementFormat : ElementFormat
用于元素的 ElementFormat 对象。
ContentElement
  eventMirror : EventDispatcher
EventDispatcher 对象,该对象将接收调度到基于此内容元素的有效文本行的每个事件的副本。
ContentElement
  groupElement : GroupElement
[只读] 包含此元素的 GroupElement 对象;如果此元素不在一个组中,则为 null。
ContentElement
  rawText : String
[只读] 元素中文本的副本,包括任何 U+FDEF 字符。
ContentElement
  text : String
[只读] 元素中文本的副本,不包括任何表示字符串中图形元素的 U+FDEF 字符。
ContentElement
  textBlock : flash.text.engine:TextBlock
[只读] 此元素所属的 TextBlock。
ContentElement
  textBlockBeginIndex : int
[只读] 文本块中此元素的第一个字符的索引。
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
 Inherited
返回指定对象的原始值。
Object
公共常量
 常量由以下参数定义
  GRAPHIC_ELEMENT : uint = 0xFDEF
[静态] 表示文本中图形元素的状态。
ContentElement
属性详细信息

elementFormat

属性
elementFormat:ElementFormat

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

用于元素的 ElementFormat 对象。

默认值为 null

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



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

相关 API 元素

eventMirror

属性 
eventMirror:EventDispatcher

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

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

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

默认值为 null



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

相关 API 元素

groupElement

属性 
groupElement:GroupElement  [只读]

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

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

默认值为 null



实现
    public function get groupElement():GroupElement

相关 API 元素

rawText

属性 
rawText:String  [只读]

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

元素中文本的副本,包括任何 U+FDEF 字符。Unicode 字符,即 U+FDEF,标记图形元素在字符串中的位置。



实现
    public function get rawText():String

text

属性 
text:String  [只读]

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

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



实现
    public function get text():String

相关 API 元素

textBlock

属性 
textBlock:flash.text.engine:TextBlock  [只读]

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

此元素所属的 TextBlock。

默认值为 null



实现
    public function get textBlock():flash.text.engine:TextBlock

相关 API 元素

textBlockBeginIndex

属性 
textBlockBeginIndex:int  [只读]

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

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

默认值为 -1。



实现
    public function get textBlockBeginIndex():int

textRotation

属性 
textRotation:String

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

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

默认值为 TextRotation.ROTATE_0

任何字型的最终旋转均为 ElementFormat.textRotationContentElement.textRotationTextBlock.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 TextElement 的 textRotation 属性设置为 TextRotation.ROTATE_270。TCY 文本元素将作为一个单元进行旋转。它首先开始执行从行中继承的 90 度旋转。再加上 270 度将使其旋转到水平位置。

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

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

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

字符串值说明
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 内生成嵌套旋转。

相关 API 元素

userData

属性 
public var userData:*

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

为应用程序提供一种将任意数据与元素相关联的方法。

默认值为 null

构造函数详细信息

ContentElement

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

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

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

  • new GraphicElement()
  • new GroupElement()
  • new TextElement()

参数
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, Flash Lite 4

表示文本中图形元素的状态。

相关 API 元素





[ X ]为什么显示为英语?
《ActionScript 3.0 参考》中的内容以英语显示

《ActionScript 3.0 参考》中的部分内容未翻译成所有语言。当某个语言元素未翻译时,将显示为英语。例如,ga.controls.HelpBox 类未翻译成任何语言。因此在简体中文版的参考中,ga.controls.HelpBox 类显示为英语。