GroupElement

包	flash.text.engine
类	public final class GroupElement
继承	GroupElement ContentElement Object

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5, Flash Lite 4

GroupElement 对象将包括 TextElement、GraphicElement 或其他 GroupElement 对象的集合组合到一起，该集合可作为一个整体分配给 TextBlock 对象的 content 属性。GroupElement 对象也可以只共享另一个 GroupElement 对象内的公共格式。

当 GroupElement 包含另一个 GroupElement 时，内部的 GroupElement 将保留自己的格式设置（ElementFormat 设置）。它不会继承外部 GroupElement 的格式设置。

在 GroupElement 上，大多数格式属性均毫无影响。出于此原因，为具有空 elementFormat 参数的 GroupElement 对象创建文本行是合理的。一些格式属性（例如 kerning 和 ligature）会对组成员之间出现交集处的格式设置产生影响。如果组具有 null 格式，则上一元素的格式将确定组成员之间出现交集处的格式设置。

查看示例

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		elementCount : int [只读] 组中的元素数。	GroupElement
		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

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0") 创建新的 GroupElement 实例。	GroupElement
		getElementAt(index:int):ContentElement 从组中检索一个元素。	GroupElement
		getElementAtCharIndex(charIndex:int):ContentElement 返回包含由 charIndex 参数指定的字符的元素。	GroupElement
		getElementIndex(element:ContentElement):int 返回由 element 参数指定的元素的索引。	GroupElement
		groupElements(beginIndex:int, endIndex:int):GroupElement 将 beginIndex 和 endIndex 参数指定的元素范围替换为包含这些元素的一个新的 GroupElement。	GroupElement
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		mergeTextElements(beginIndex:int, endIndex:int):flash.text.engine:TextElement 将 beginIndex 和 endIndex 参数指定的元素范围中的文本合并到 beginIndex 指定的元素中，但不影响该元素的格式。	GroupElement
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement> 将 beginIndex 和 endIndex 参数指定的元素范围替换为 newElements 参数的内容。	GroupElement
		setElements(value:Vector.<ContentElement>):void 将组中的元素设置为该矢量的内容。	GroupElement
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		splitTextElement(elementIndex:int, splitIndex:int):flash.text.engine:TextElement 将 TextElement 拆分为两部分，在指定位置创建新 TextElement。	GroupElement
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		ungroupElements(groupIndex:int):void 对 groupIndex 在外部 GroupElement 对象中指定的嵌套 GroupElement 中的元素取消分组。	GroupElement
		valueOf():Object 返回指定对象的原始值。	Object

公共常量

隐藏继承的公共常量

显示继承的公共常量

	常量		由以下参数定义

属性详细信息

elementCount

属性

elementCount:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5, Flash Lite 4

组中的元素数。

实现
public function get elementCount():int

构造函数详细信息

()

构造函数

public function GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5, Flash Lite 4

创建新的 GroupElement 实例。

参数

	`elements:Vector.<ContentElement>` (default = `null`) — 要包含在 GroupElement 中的 ContentElement 对象的矢量。该矢量可以为空。默认值为 `null`。

	`elementFormat:ElementFormat` (default = `null`) — 组的元素格式。默认值为 `null`。此格式将应用于组中元素之间的交集，这些元素不继承该格式。

	`eventMirror:EventDispatcher` (default = `null`) — `EventDispatcher` 对象，该对象将接收调度到基于此内容元素创建的文本行的每个事件的副本。默认值为 `null`。

	`textRotation:String` (default = "`rotate0`") — 作为一个单元应用于元素的旋转。将 `TextRotation` 常量用于此属性。默认值为 `TextRotation.ROTATE_0`。

引发

	`ArgumentError` — 指定的 `element` 包含 `null` 元素。

	`ArgumentError` — 指定的 `element` 包含不是 `ContentElement` 的已知子类的元素。

	`ArgumentError` — 指定的 `element` 包含已作为 `TextBlock` 的 `content` 指定的元素。

	`ArgumentError` — 指定的 `element` 包含已经是组成员或在 `elements` 中出现多次的元素。

方法详细信息

getElementAt

()

方法

public function getElementAt(index:int):ContentElement

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5, Flash Lite 4

从组中检索一个元素。

参数

index:int — 要检索的元素的索引。

ContentElement

引发

RangeError — 如果 index 超出范围。

getElementAtCharIndex

()

方法

public function getElementAtCharIndex(charIndex:int):ContentElement

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5, Flash Lite 4

返回包含由 charIndex 参数指定的字符的元素。

参数

charIndex:int — 字符（您想要查找其元素）的从零开始的索引值。值 0 对应于组中的第一个字符，不对应于 TextBlock 中的第一个字符。

ContentElement — 包含 charIndex 处的字符的元素。

引发

RangeError — 如果 charIndex 不在 0 - rawText.length 范围内。

getElementIndex

()

方法

public function getElementIndex(element:ContentElement):int

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5, Flash Lite 4

返回由 element 参数指定的元素的索引。

参数

element:ContentElement — 想要检索其索引的组中的元素。

int — 由 element 指定的元素的索引；如果元素不在组中，则为 -1。

groupElements

()

方法

public function groupElements(beginIndex:int, endIndex:int):GroupElement

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5, Flash Lite 4

将 beginIndex 和 endIndex 参数指定的元素范围替换为包含这些元素的一个新的 GroupElement。正如所设计的一样，将替换从 beginIndex 到 endIndex-1 的元素。

参数

	`beginIndex:int` — 要分组的范围的开始位置的从零开始的索引值。

	`endIndex:int` — 要分组的范围的结束位置后面的从零开始的索引值。

GroupElement — 新组。

引发

RangeError — 如果 beginIndex 或 endIndex 超出范围。

mergeTextElements

()

方法

public function mergeTextElements(beginIndex:int, endIndex:int):flash.text.engine:TextElement

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5, Flash Lite 4

将 beginIndex 和 endIndex 参数指定的元素范围中的文本合并到 beginIndex 指定的元素中，但不影响该元素的格式。正如所设计的一样，将合并从 beginIndex 到 endIndex-1 的元素中的文本。在合并了从 beginIndex+1 到 endIndex-1 的元素中的文本之后，这些元素将从组中删除并处于孤立状态，且具有 null group 属性。

参数

	`beginIndex:int` — 要合并的范围的开始位置的从零开始的索引值。

	`endIndex:int` — 要合并的范围的结束位置后面的从零开始的索引值。

flash.text.engine:TextElement — 范围内的第一个文本元素，现在包含该范围内的所有文本。

引发

	`RangeError` — 如果 `beginIndex` 或 `endIndex` 超出范围。

	`ArgumentError` — 如果指定范围内的任何元素不是 TextElement。

相关 API 元素

TextElement

replaceElements

()

方法

 public function replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement>

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5, Flash Lite 4

将 beginIndex 和 endIndex 参数指定的元素范围替换为 newElements 参数的内容。将替换从 beginIndex 到 endIndex-1 的元素。

要删除元素，请为 newElements 传递 null。要插入一个元素，请为 beginIndex 和 endIndex 传递相同的值。新元素将插入到指定索引之前。要追加一个元素，请为 beginIndex 和 endIndex 传递 elementCount。

操作完成后，替换的元素将处于孤立状态，具有值为 null 的 group 属性并返回。

参数

	`beginIndex:int` — 替换范围开始位置的从零开始的索引值。

	`endIndex:int` — 替换范围结束位置后面从零开始的索引值。

	`newElements:Vector.<ContentElement>` — 要用来替换指定范围元素的元素。

Vector.<ContentElement> — 包含被替换元素的矢量。

引发

	`RangeError` — 指定的 `beginIndex` 或 `endIndex` 超出范围。

	`ArgumentError` — 指定的 `newElements` 包含 `null` 元素。

	`ArgumentError` — 指定的 `newElements` 包含 `this`。

	`ArgumentError` — 指定的 `newElements` 包含不是 `ContentElement` 的已知子类的元素。

	`ArgumentError` — 指定的 `newElements` 包含已作为 `TextBlock` 的 `content` 指定的元素。

	`ArgumentError` — 指定的 `newElements` 包含已经是组成员或在 `elements` 中出现多次的元素。

	`ArgumentError` — 如果操作将在 `GroupElement` 内生成嵌套旋转。

setElements

()

方法

public function setElements(value:Vector.<ContentElement>):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5, Flash Lite 4

将组中的元素设置为该矢量的内容。

参数

value:Vector.<ContentElement>

引发

	`ArgumentError` — 指定的 `value` 包含 `null` 元素。

	`ArgumentError` — 指定的 `value` 包含 `this`。

	`ArgumentError` — 指定的 `value` 包含非 `ContentElement` 的已知子类的元素。

	`ArgumentError` — 指定的 `value` 包含被指定为 `TextBlock` 的 `content` 的元素。

	`ArgumentError` — 指定的 `value` 包含已经是组成员或在 `value` 中出现多次的元素。

	`ArgumentError` — 如果操作将在 `GroupElement` 内生成嵌套旋转。

splitTextElement

()

方法

public function splitTextElement(elementIndex:int, splitIndex:int):flash.text.engine:TextElement

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5, Flash Lite 4

将 TextElement 拆分为两部分，在指定位置创建新 TextElement。

参数

	`elementIndex:int` — 组中该元素位置的从零开始的索引值。

	`splitIndex:int` — TextElement 中要进行拆分的位置处的字符的从零开始的索引值。指定字符为新 TextElement 中的第一个字符。

flash.text.engine:TextElement — 包含原始文本元素后面部分的新文本元素。

引发

	`RangeError` — 如果 `elementIndex` 或 `charIndex` 超出范围。

	`ArgumentError` — 如果 `elementIndex` 处的元素不是 TextElement。

相关 API 元素

TextElement

ungroupElements

()

方法

public function ungroupElements(groupIndex:int):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5, Flash Lite 4

对 groupIndex 在外部 GroupElement 对象中指定的嵌套 GroupElement 中的元素取消分组。操作完成后，取消分组的元素将替代嵌套的 GroupElement，后者将处于孤立状态，具有值为 null 的 group 属性。

参数

groupIndex:int — 要拆分的组的位置的从零开始的索引值。

引发

	`RangeError` — 如果 `groupIndex` 超出范围。

	`ArgumentError` — 如果 `groupIndex` 处的元素不是 GroupElement。

示例如何使用本示例

GroupElementExample.as

此示例创建了一个红色的框作为 GraphicElement 对象，并将该对象与两个 TextElement 对象结合在一起创建了一个 GroupElement 对象。它将 GroupElement 对象分配给从中创建三条行的 TextBlock 的 content 属性。

package {

    import flash.display.Sprite;
    import flash.display.MovieClip;
    import flash.text.engine.ContentElement;
    import flash.text.engine.TextBlock;
    import flash.text.engine.TextElement;
    import flash.text.engine.GraphicElement;
    import flash.text.engine.GroupElement;
    import flash.text.engine.TextLine;
    import flash.text.engine.ElementFormat;
    import flash.text.engine.FontDescription;
    
    public class GroupElementExample extends Sprite {
        
        public function GroupElementExample():void {
            
            var redBox:MovieClip = new MovieClip();
            redBox.graphics.beginFill(0xCC0000, 1.0);
            redBox.graphics.drawRect(0, 0, 20, 20);
            redBox.graphics.endFill(); 
            
            var format:ElementFormat = new ElementFormat();
            var fontDescription:FontDescription = new FontDescription("Arial");
            format.fontSize = 16;
            format.fontDescription = fontDescription;
            
            var str1:String = "This red box is a GraphicElement ";
            var str2:String = " in the middle of two TextElements, " +
            " which together make " +
            "up a GroupElement in a TextBlock that is broken into three lines.";
            
            var textElement1:TextElement = new TextElement(str1,format);
            var graphicElement:GraphicElement = new GraphicElement(redBox,redBox.width,redBox.height, format);
            var textElement2:TextElement = new TextElement(str2, format);
            var groupVector:Vector.<ContentElement> = new Vector.<ContentElement>();
            groupVector.push(textElement1, graphicElement, textElement2);
            var groupElement = new GroupElement(groupVector);
            var textBlock:TextBlock = new TextBlock();
            textBlock.content = groupElement;
            createTextLines(textBlock);
        }
        
        private function createTextLines(textBlock:TextBlock):void 
        {
        
            var yPos = 20;
            var line_length:Number = 450;
            var textLine:TextLine = textBlock.createTextLine (null, line_length);
 
            while (textLine)
            {
                addChild(textLine);
                textLine.x = 15;
                yPos += textLine.height+8;
                textLine.y = yPos;
                textLine = textBlock.createTextLine(textLine, line_length);
            }
        }
    }    
}

法律声明 | 在线隐私策略

GroupElement - AS3

包x

语言元素

附录

包 flash.text.engine

elementCount

GroupElement

getElementAt

getElementAtCharIndex

getElementIndex

groupElements

mergeTextElements

replaceElements

setElements

splitTextElement

ungroupElements