| Paquete | flash.text.engine |
| Clase | public final class GroupElement |
| Herencia | GroupElement  ContentElement Object |
| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5, Flash Lite 4 |
content de un objeto TextBlock. Un objeto GroupElement también puede limitarse a compartir formato común con otro objeto GroupElement.
Cuando un GroupElement contiene otro GroupElement, el GroupElement interior retiene su propio formato (configuración de ElementFormat). No hereda el formato del GroupElement exterior.
En un GroupElement, la mayoría de las propiedades de formato no tienen impacto. Por este motivo, está justificado crear una línea de texto para un objeto GroupElement que tenga un parámetro elementFormat nulo. Algunas propiedades de formato como el ajuste en caracteres y la ligadura afectan al formato en las intersecciones que tienen lugar entre miembros del grupo. Si el grupo tiene un formato nulo, el formato del elemento precedente determina el formato en las intersecciones que se producen entre miembros del grupo.
Elementos de API relacionados
Propiedades públicas
Ocultar propiedades públicas heredadas
Mostrar propiedades públicas heredadas| Propiedad | Definido por | ||
|---|---|---|---|
 | constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | Object | |
| elementCount : int [solo lectura]
Número de elementos del grupo. | GroupElement | ||
| elementFormat : ElementFormat
El objeto ElementFormat utilizado para el elemento. | ContentElement | |
| eventMirror : EventDispatcher
El objeto EventDispatcher que recibe copias de cada evento distribuido en las líneas de texto válidas según este elemento de contenido. | ContentElement | |
| groupElement : GroupElement [solo lectura]
El objeto GroupElement que contiene este elemento o null si no se encuentra en ningún grupo. | ContentElement | |
| rawText : String [solo lectura]
Una copia del texto en el elemento, incluidos los caracteres U+FDEF. | ContentElement | |
| text : String [solo lectura]
Una copia del texto en el elemento, sin incluir los caracteres U+FDEF que representan elementos gráficos en la cadena. | ContentElement | |
| textBlock : flash.text.engine:TextBlock [solo lectura]
Objeto TextBlock al que pertenece el elemento. | ContentElement | |
| textBlockBeginIndex : int [solo lectura]
Índice del bloque de texto del primer carácter de este elemento. | ContentElement | |
| textRotation : String
La rotación aplicada al elemento como una unidad. | ContentElement | |
| userData : *
Permite a la aplicación asociar datos arbitrarios al elemento. | ContentElement | |
Métodos públicos
| Método | Definido por | ||
|---|---|---|---|
GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")
Crea una nueva instancia de GroupElement. | GroupElement | ||
Recupera un elemento del grupo. | GroupElement | ||
Devuelve el elemento que contiene el carácter especificado por el parámetro charIndex. | GroupElement | ||
Devuelve el índice del elemento especificado por el parámetro element. | GroupElement | ||
Reemplaza el rango de elementos especificados por los parámetros beginIndex y endIndex con un nuevo elemento GroupElement que los contiene. | GroupElement | ||
|
Indica si un objeto tiene definida una propiedad especificada. | Object | |
|
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | |
Combina el texto del rango de elementos especificados por beginIndex y endIndex en el elemento especificado por beginIndex sin que esto afecte al formato de dicho elemento. | GroupElement | ||
|
Indica si existe la propiedad especificada y si es enumerable. | Object | |
replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement>
Reemplaza el rango de elementos especificados por los parámetros beginIndex y endIndex con el contenido del parámetro newElements. | GroupElement | ||
Define los elementos del grupo según el contenido del vector. | GroupElement | ||
|
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | |
Divide un objeto TextElement en dos, creando un nuevo objeto TextElement en la posición especificada. | GroupElement | ||
|
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | |
|
Devuelve la representación de cadena del objeto especificado. | Object | |
Desagrupa los elementos de un objeto GroupElement anidado especificado por groupIndex dentro de un objeto GroupElement exterior. | GroupElement | ||
|
Devuelve el valor simple del objeto especificado. | Object | |
Constantes públicas
Información sobre propiedades
elementCount | propiedad |
Información sobre constructores
GroupElement | () | Información sobre |
public function GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Crea una nueva instancia de GroupElement.
Parámetroselements:Vector.<ContentElement> (default = null)null.
| |
elementFormat:ElementFormat (default = null)null. Este formato se aplica a las intersecciones entre elementos del grupo; estos elementos no heredan el formato.
| |
eventMirror:EventDispatcher (default = null)EventDispatcher que recibe copias de cada evento distribuido en las líneas de texto creados en base a este elemento de contenido. El valor predeterminado es null.
| |
textRotation:String (default = "rotate0")TextRotation para esta propiedad. El valor predeterminado es TextRotation.ROTATE_0.
|
Emite
ArgumentError — El parámetro element especificado contiene elementos null.
| |
ArgumentError — El parámetro element especificado contiene un elemento que no es una subclase conocida de ContentElement.
| |
ArgumentError — El parámetro element especificado contiene elementos que se especifican según el contenido de un TextBlock.
| |
ArgumentError — El parámetro element especificado contiene elementos que ya son miembros de un grupo o aparecen más de una vez en elements.
|
Elementos de API relacionados
Información sobre métodos
getElementAt | () | método |
public function getElementAt(index:int):ContentElement| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Recupera un elemento del grupo.
Parámetros
index:int — Índice del elemento que debe recuperarse.
|
ContentElement |
Emite
RangeError — Si index está fuera de rango.
|
getElementAtCharIndex | () | método |
public function getElementAtCharIndex(charIndex:int):ContentElement| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Devuelve el elemento que contiene el carácter especificado por el parámetro charIndex.
Parámetros
charIndex:int — El valor del índice basado en cero del carácter cuyo elemento se quiere encontrar. Un valor de 0 corresponde al primer carácter del grupo, no al primer carácter de TextBlock.
|
ContentElement — El elemento que contiene el carácter en charIndex.
|
Emite
RangeError — Si charIndex está fuera del rango de 0 - rawText.length.
|
getElementIndex | () | método |
public function getElementIndex(element:ContentElement):int| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Devuelve el índice del elemento especificado por el parámetro element.
Parámetros
element:ContentElement — El elemento del grupo cuyo índice se quiere recuperar.
|
int — Índice del elemento especificado por element, o -1 si el elemento no está en el grupo.
|
groupElements | () | método |
public function groupElements(beginIndex:int, endIndex:int):GroupElement| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Reemplaza el rango de elementos especificados por los parámetros beginIndex y endIndex con un nuevo elemento GroupElement que los contiene. Según su diseño, se sustituyen los elementos de beginIndex a endIndex-1.
Parámetros
beginIndex:int — El valor de índice basado en cero de la posición inicial del rango que se va a agrupar.
| |
endIndex:int — El valor de índice basado en cero que sigue a la posición final del rango que se va a agrupar.
|
GroupElement — El nuevo grupo.
|
Emite
RangeError — Si beginIndex o endIndex está fuera de rango.
|
mergeTextElements | () | método |
public function mergeTextElements(beginIndex:int, endIndex:int):flash.text.engine:TextElement| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Combina el texto del rango de elementos especificados por beginIndex y endIndex en el elemento especificado por beginIndex sin que esto afecte al formato de dicho elemento. Según su diseño, se combina el texto de beginIndex a endIndex-1. Finalizada la combinación del texto, los elementos de beginIndex+1 a endIndex-1 se eliminan del grupo, se anulan sus referencias y sus propiedades group se establecen en null.
Parámetros
beginIndex:int — El valor de índice basado en cero de la posición inicial del rango que se va a combinar.
| |
endIndex:int — El valor de índice basado en cero que sigue a la posición final del rango que se va a combinar.
|
flash.text.engine:TextElement — El primer elemento de texto del rango (que ahora contiene todo el texto del rango).
|
Emite
RangeError — Si beginIndex o endIndex está fuera de rango.
| |
ArgumentError — Si cualquiera de los elementos del rango especificado no son TextElement.
|
Elementos de API relacionados
replaceElements | () | método |
public function replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement>| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Reemplaza el rango de elementos especificados por los parámetros beginIndex y endIndex con el contenido del parámetro newElements. Se sustituyen los elementos de beginIndex a endIndex-1.
Para eliminar elementos, transfiera null a newElements. Para insertar un elemento, transfiera el mismo valor para beginIndex y endIndex. El nuevo elemento se inserta delante del índice especificado. Para adjuntar un elemento, transfiera elementCount a beginIndex y endIndex.
Una vez finalizada la operación, los elementos reemplazados se quedan sin referencias y sus propiedades group se establecen en null y se devuelven.
Parámetros
beginIndex:int — El valor de índice basado en cero para la posición inicial del rango de sustitución.
| |
endIndex:int — El valor de índice basado en cero que sigue a la posición final del rango de sustitución.
| |
newElements:Vector.<ContentElement> — Los elementos que van a reemplazar al rango de elementos especificado.
|
Vector.<ContentElement> — Un vector que contiene los elementos reemplazados.
|
Emite
RangeError — Los elementos beginIndex o endIndex especificados están fuera de rango.
| |
ArgumentError — El parámetro newElements especificado contiene elementos null.
| |
ArgumentError — El parámetro newElements especificado contiene this.
| |
ArgumentError — El parámetro newElements especificado contiene elementos que no son una subclase conocida de ContentElement.
| |
ArgumentError — El parámetro newElements especificado contiene elementos que se indican según el contenido de un bloque TextBlock.
| |
ArgumentError — El parámetro newElements especificado contiene elementos que ya son miembros de un grupo o que aparecen más de una vez en elements.
| |
ArgumentError — Si la operación tiene como resultado rotaciones anidadas en GroupElement.
|
setElements | () | método |
public function setElements(value:Vector.<ContentElement>):void| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Define los elementos del grupo según el contenido del vector.
Parámetros
value:Vector.<ContentElement> |
Emite
ArgumentError — El parámetro value especificado contiene null elementos.
| |
ArgumentError — El parámetro value especificado contiene this.
| |
ArgumentError — El parámetro values especificado contiene elementos que no son una subclase conocida de ContentElement.
| |
ArgumentError — El parámetro values especificado contiene elementos que no s especifican como el contenido de un bloque TextBlock.
| |
ArgumentError — El parámetro value especificado contiene elementos que ya son miembros de un grupo, o que aparecen más de una vez en el valor.
| |
ArgumentError — Si la operación tiene como resultado rotaciones anidadas en GroupElement.
|
splitTextElement | () | método |
public function splitTextElement(elementIndex:int, splitIndex:int):flash.text.engine:TextElement| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Divide un objeto TextElement en dos, creando un nuevo objeto TextElement en la posición especificada.
Parámetros
elementIndex:int — Valor de índice basado en cero de la posición del elemento en el grupo.
| |
splitIndex:int — Valor de índice basado en cero del carácter del elemento TextElement en el que se produce la división. El carácter especificado es el primero del nuevo elemento TextElement.
|
flash.text.engine:TextElement — El nuevo elemento de texto que contiene la última parte del elemento de texto original.
|
Emite
RangeError — Si elementIndex o charIndex están fuera de rango.
| |
ArgumentError — Si el elemento en elementIndex no es un elemento TextElement.
|
Elementos de API relacionados
ungroupElements | () | método |
public function ungroupElements(groupIndex:int):void| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Desagrupa los elementos de un objeto GroupElement anidado especificado por groupIndex dentro de un objeto GroupElement exterior. Finalizada la operación, los elementos desagrupados reemplazan el objeto GroupElement anidado, que pasa a ser un objeto sin referencias con su propiedad group establecida en null.
Parámetros
groupIndex:int — El valor de índice basado en cero de la posición del grupo que se va a dividir.
|
Emite
RangeError — Si groupIndex está fuera de rango.
| |
ArgumentError — Si el elemento en groupIndex no es GroupElement.
|
Ejemplos Cómo utilizar este ejemplo
GroupElementExample.as
Este ejemplo crea un cuadro rojo como un objeto GraphicElement y lo combina con dos objetos TextElement para crear un objeto GroupElement. Asigna el objeto GroupElement a la propiedad
content de un bloque TextBlock, desde el que crea tres líneas.
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);
}
}
}
}
Tue Jun 12 2018, 02:12 PM Z