| Pacote | flash.text.engine |
| Classe | public final class GroupElement |
| Herança | GroupElement  ContentElement Object |
| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | Flash Player 10, AIR 1.5, Flash Lite 4 |
content de um objeto TextBlock. Um objeto GroupElement também pode simplesmente compartilhar uma mesma formatação de outro objeto GroupElement.
Quando um GroupElement contém outro GroupElement, o GroupElement contido mantém sua própria formatação (configurações de ElementFormat). Ele não herda a formatação do GroupElement que o contém.
Em um GroupElement, grande parte das propriedades de formato não tem impacto. Por esse motivo, é válido criar uma linha de texto para um objeto GroupElement que tem um parâmetro elementFormat nulo. Algumas propriedades de formato, como kerning e ligature, afetam a formatação quando ocorrem intersecções entre membros do grupo. Se o grupo tiver um formato nulo, o formato do elemento precedente determinará a formatação quando ocorrem intersecções entre membros do grupo.
Elementos da API relacionados
Propriedades públicas
Ocultar propriedades públicas herdadas
Mostrar propriedades públicas herdadas| Propriedade | Definido por | ||
|---|---|---|---|
 | constructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto. | Object | |
| elementCount : int [somente leitura]
O número de elementos no grupo. | GroupElement | ||
| elementFormat : ElementFormat
O objeto ElementFormat usado para o elemento. | ContentElement | |
| eventMirror : EventDispatcher
O objeto EventDispatcher que recebe cópias de todos os eventos despachados para linhas de texto válidas com base no elemento de conteúdo. | ContentElement | |
| groupElement : GroupElement [somente leitura]
O objeto GroupElement que contém esse elemento, ou nulo, se ele não estiver em um grupo. | ContentElement | |
| rawText : String [somente leitura]
Uma cópia do texto no elemento, incluindo quaisquer caracteres U+FDEF. | ContentElement | |
| text : String [somente leitura]
Uma cópia do texto no elemento, sem incluir quaisquer caracteres U+FDEF, que representa os elementos gráficos na string. | ContentElement | |
| textBlock : flash.text.engine:TextBlock [somente leitura]
O TextBlock ao qual esse elemento pertence. | ContentElement | |
| textBlockBeginIndex : int [somente leitura]
O índice no bloco de texto dos primeiros caracteres desse elemento. | ContentElement | |
| textRotation : String
O giro a ser aplicado ao elemento como uma unidade. | ContentElement | |
| userData : *
Fornece uma maneira para um aplicativo associar dados arbitrários ao elemento. | ContentElement | |
Métodos públicos
| Método | Definido por | ||
|---|---|---|---|
GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")
Cria uma nova ocorrência de GroupElement. | GroupElement | ||
Recupera um elemento de dentro do grupo. | GroupElement | ||
Retorna o elemento que contém o caractere especificado pelo parâmetro charIndex. | GroupElement | ||
Retorna o índice do elemento especificado pelo parâmetro element. | GroupElement | ||
Substitui a faixa de elementos que os parâmetros beginIndex e endIndex especificam com um novo GroupElement que contêm os elementos. | GroupElement | ||
|
Indica se um objeto tem uma propriedade especificada definida. | Object | |
|
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro. | Object | |
Mescla o texto da faixa de elementos que os parâmetros beginIndex e endIndex especificam no elemento especificado por beginIndex sem afetar o formato do elemento. | GroupElement | ||
|
Indica se a propriedade especificada existe e é enumerável. | Object | |
replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement>
Substitui o intervalo de elementos que os parâmetros beginIndex e endIndex especificam com o conteúdo do parâmetro newElements. | GroupElement | ||
Define os elementos no grupo para o conteúdo do Vector. | GroupElement | ||
|
Define a disponibilidade de uma propriedade dinâmica para operações de repetição. | Object | |
Divide um TextElement em dois, criando um novo TextElement na posição especificada. | GroupElement | ||
|
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade. | Object | |
|
Retorna a representação de string do objeto especificado. | Object | |
Desagrupa os elementos de GroupElement aninhado que groupIndex especifica em um objeto GroupElement externo. | GroupElement | ||
|
Retorna o valor primitivo do objeto especificado. | Object | |
Constantes públicas
Detalhes da propriedade
elementCount | propriedade |
Detalhes do construtor
GroupElement | () | Construtor |
public function GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Cria uma nova ocorrência de GroupElement.
Parâmetroselements:Vector.<ContentElement> (default = null)null.
| |
elementFormat:ElementFormat (default = null)null. O formato se aplica a interseções entre elementos do grupo. Eles não herdam o formato.
| |
eventMirror:EventDispatcher (default = null)EventDispatcher que recebe cópias de todos os eventos despachados para linhas de texto criadas com base no elemento content. O valor padrão é null.
| |
textRotation:String (default = "rotate0")TextRotation para a propriedade. O valor padrão é TextRotation.ROTATE_0.
|
Lança
ArgumentError — O element especificado contém elementosnull.
| |
ArgumentError — O element especificado contém um elemento que não é uma subclasse conhecida de ContentElement.
| |
ArgumentError — O element especificado contém elementos especificados como content de TextBlock.
| |
ArgumentError — O element especificado contém elementos que já são membros de um grupo ou que são exibidos mais de uma vez em elements.
|
Elementos da API relacionados
Detalhes do método
getElementAt | () | método |
public function getElementAt(index:int):ContentElement| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Recupera um elemento de dentro do grupo.
Parâmetros
index:int — O índice do elemento a ser recuperado.
|
ContentElement |
Lança
RangeError — Se index estiver fora do intervalo.
|
getElementAtCharIndex | () | método |
public function getElementAtCharIndex(charIndex:int):ContentElement| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Retorna o elemento que contém o caractere especificado pelo parâmetro charIndex.
Parâmetros
charIndex:int — O valor de índice com base em zero do caractere cujo elemento você deseja localizar. Um valor igual a 0 corresponde ao primeiro caractere do grupo, e não ao primeiro caractere de TextBlock.
|
ContentElement — O elemento que contém o caractere em charIndex.
|
Lança
RangeError — Se charIndex não estiver no intervalo de 0 - rawText.length.
|
getElementIndex | () | método |
public function getElementIndex(element:ContentElement):int| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Retorna o índice do elemento especificado pelo parâmetro element.
Parâmetros
element:ContentElement — O elemento do grupo cujo índice você deseja recuperar.
|
int — O índice do elemento especificado por element ou -1 caso o elemento não esteja no grupo.
|
groupElements | () | método |
public function groupElements(beginIndex:int, endIndex:int):GroupElement| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Substitui a faixa de elementos que os parâmetros beginIndex e endIndex especificam com um novo GroupElement que contêm os elementos. Conforme projetado, os elementos entre beginIndex e endIndex-1 são substituídos.
Parâmetros
beginIndex:int — O valor de índice com base em zero da posição inicial da faixa de agrupamento.
| |
endIndex:int — O valor de índice com base em zero após a posição final da faixa de agrupamento.
|
GroupElement — O novo grupo.
|
Lança
RangeError — Se beginIndex ou endIndex estiver fora do intervalo.
|
mergeTextElements | () | método |
public function mergeTextElements(beginIndex:int, endIndex:int):flash.text.engine:TextElement| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Mescla o texto da faixa de elementos que os parâmetros beginIndex e endIndex especificam no elemento especificado por beginIndex sem afetar o formato do elemento. Conforme projetado, os textos dos elementos entre beginIndex e endIndex-1 são mesclados. Após a mesclagem do texto, os elementos entre beginIndex+1 e endIndex-1 são removidos do grupo e ficam órfãos, com propriedades group null.
Parâmetros
beginIndex:int — O valor de índice com base em zero da posição inicial da faixa de mesclagem.
| |
endIndex:int — O valor de índice com base em zero após a posição final da faixa de mesclagem.
|
flash.text.engine:TextElement — O primeiro elemento de texto no intervalo, agora contendo todo o texto no intervalo.
|
Lança
RangeError — Se beginIndex ou endIndex estiver fora do intervalo.
| |
ArgumentError — Se um dos elementos do intervalo especificado não for TextElement.
|
Elementos da API relacionados
replaceElements | () | método |
public function replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement>| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Substitui a faixa de elementos que os parâmetros beginIndex e endIndex especificam com o conteúdo do parâmetro newElements. Os elementos entre beginIndex e endIndex-1 são substituídos.
Para excluir elementos, transmita null para newElements. Para inserir um elemento, transmita o mesmo valor para beginIndex e endIndex. O novo elemento é inserido antes do índice especificado. Para anexar um elemento, transmita elementCount de beginIndex e endIndex.
Após a operação, os elementos substituídos estão órfãos, com propriedades null group e retornados.
Parâmetros
beginIndex:int — O valor de índice com base em zero da posição inicial do intervalo de substituição.
| |
endIndex:int — O valor de índice baseado em zero que segue a posição final do intervalo de substituição.
| |
newElements:Vector.<ContentElement> — Os elementos que devem ser usados para substituir o intervalo de elementos especificado.
|
Vector.<ContentElement> — Um Vector contendo os elementos que foram substituídos.
|
Lança
RangeError — O beginIndex ou endIndex especificado está fora do intervalo.
| |
ArgumentError — O newElements especificado contém elementosnull.
| |
ArgumentError — O newElements especificado contém this.
| |
ArgumentError — O newElements especificado contém elementos que não são uma subclasse conhecida de ContentElement.
| |
ArgumentError — O newElements especificado contém elementos especificados como content de uma TextBlock.
| |
ArgumentError — O newElements especificado contém elementos que já são membros de um grupo ou que são exibidos mais de uma vez em elements.
| |
ArgumentError — Se a operação pode resultar em rotações aninhadas dentro de GroupElement.
|
setElements | () | método |
public function setElements(value:Vector.<ContentElement>):void| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Define os elementos no grupo para o conteúdo do Vector.
Parâmetros
value:Vector.<ContentElement> |
Lança
ArgumentError — O value especificado contém elementos null.
| |
ArgumentError — O value especificado contém this.
| |
ArgumentError — O value especificado contém elementos que não são uma subclasse conhecida de ContentElement.
| |
ArgumentError — O value especificado contém elementos especificados como content de TextBlock.
| |
ArgumentError — O value especificado contém elementos que já são membros de um grupo ou que são exibidos mais de uma vez em value.
| |
ArgumentError — Se a operação pode resultar em rotações aninhadas dentro de GroupElement.
|
splitTextElement | () | método |
public function splitTextElement(elementIndex:int, splitIndex:int):flash.text.engine:TextElement| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Divide um TextElement em dois, criando um novo TextElement na posição especificada.
Parâmetros
elementIndex:int — O valor de índice com base em zero da posição do elemento no grupo.
| |
splitIndex:int — O valor de índice com base em zero do caractere no TextElement onde a divisão ocorrerá. O caractere especificado é o primeiro do novo TextElement.
|
flash.text.engine:TextElement — O novo elemento de texto contendo a última parte do elemento de texto original.
|
Lança
RangeError — Se elementIndex ou charIndex estiver fora do intervalo.
| |
ArgumentError — Se o elemento em elementIndex não for um TextElement.
|
Elementos da API relacionados
ungroupElements | () | método |
public function ungroupElements(groupIndex:int):void| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Desagrupa os elementos de GroupElement aninhado que groupIndex especifica em um objeto GroupElement externo. Após a operação, os elementos desagrupados substituem o GroupElement aninhado, que se torna órfão com uma propriedade group null.
Parâmetros
groupIndex:int — O valor de índice com base em zero da posição do grupo a ser dividido.
|
Lança
RangeError — Se groupIndex estiver fora do intervalo.
| |
ArgumentError — Se o elemento em groupIndex não for um GroupElement.
|
Exemplos Como usar este exemplo
GroupElementExample.as
O exemplo cria uma caixa vermelha como objeto GraphicElement e combina dois objetos TextElement para criar um objeto GroupElement. Ele atribui o objeto GroupElement à propriedade
content de TextBlock, do qual cria três linhas.
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);
}
}
}
}
Wed Jun 13 2018, 11:10 AM Z