Guida di riferimento di ActionScript® 3.0 per la piattaforma Adobe® Flash®
Home  |  Nascondi elenco pacchetti e classi |  Pacchetti  |  Classi  |  Novità  |  Indice  |  Appendici  |  Perché in inglese?
Filtri: Recupero dati dal server...
Recupero dati dal server...
flash.text.engine 

GroupElement  - AS3

Pacchettoflash.text.engine
Classepublic final class GroupElement
EreditarietàGroupElement Inheritance ContentElement Inheritance Object

Versione linguaggio: ActionScript 3.0
Versioni runtime: Flash Player 10, AIR 1.5, Flash Lite 4

Un oggetto GroupElement raggruppa un insieme di oggetti TextElement, GraphicElement o altri oggetti GroupElement che potete assegnare come un insieme alla proprietà content di un oggetto TextBlock. Un oggetto GroupElement può inoltre condividere semplicemente la formattazione comune all'interno di un altro oggetto GroupElement.

Quando un oggetto GroupElement contiene un altro GroupElement, quello interno mantiene la propria formattazione (impostazioni ElementFormat). Non eredita la formattazione dell'oggetto GroupElement esterno.

In un oggetto GroupElement, la maggior parte delle proprietà di formattazione non ha alcun impatto. Per questo motivo, è possibile creare una riga di testo per un oggetto GroupElement che dispone di un parametro elementFormat. Alcune proprietà di formattazione, ad esempio kerning e ligature, incidono sulla formattazione quando si verificano intersezioni tra i membri del gruppo. Se il formato del gruppo è null, in caso di intersezioni tra i membri del gruppo, il formato dell'elemento precedente determinata la formattazione.

Vedere gli esempi

Altri esempi

Elementi API correlati



Proprietà pubbliche
 ProprietàDefinito da
 Inheritedconstructor : Object
Un riferimento all'oggetto classe o alla funzione di costruzione per una determinata istanza di oggetto.
Object
  elementCount : int
[sola lettura] Il numero di elementi nel gruppo.
GroupElement
 InheritedelementFormat : ElementFormat
L'oggetto ElementFormat usato per l'elemento.
ContentElement
 InheritedeventMirror : EventDispatcher
L'oggetto EventDispatcher che riceve le copie di ogni evento inviato alle righe di testo valide in base a questo elemento content.
ContentElement
 InheritedgroupElement : GroupElement
[sola lettura] L'oggetto GroupElement che contiene questo elemento; oppure null se non fa parte di un gruppo.
ContentElement
 InheritedrawText : String
[sola lettura] Una copia del testo nell'elemento, inclusi i caratteri U+FDEF.
ContentElement
 Inheritedtext : String
[sola lettura] Una copia del testo nell'elemento, esclusi i caratteri U+FDEF che rappresentano elementi grafici nella stringa.
ContentElement
 InheritedtextBlock : flash.text.engine:TextBlock
[sola lettura] L'oggetto TextBlock al quale appartiene questo elemento.
ContentElement
 InheritedtextBlockBeginIndex : int
[sola lettura] L'indice nel testo del blocco di testo del primo carattere di questo elemento.
ContentElement
 InheritedtextRotation : String
La rotazione da applicare all'elemento come un'unità.
ContentElement
 InheriteduserData : *
Fornisce un modo per consentire a un'applicazione di associare dati arbitrari con l'elemento.
ContentElement
Metodi pubblici
 MetodoDefinito da
  
GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")
Crea una nuova istanza GroupElement.
GroupElement
  
Recupera un elemento dall'interno del gruppo.
GroupElement
  
Restituisce l'elemento contenente il carattere specificato dal parametro charIndex.
GroupElement
  
Restituisce l'indice dell'elemento specificato dal parametro element.
GroupElement
  
groupElements(beginIndex:int, endIndex:int):GroupElement
Sostituisce un intervallo di elementi, specificato dai parametri beginIndex e endIndex, con un nuovo oggetto GroupElement contenente tali elementi.
GroupElement
 Inherited
Indica se per un oggetto è definita una proprietà specifica.
Object
 Inherited
Indica se un'istanza della classe Object si trova nella catena di prototipi dell'oggetto specificato come parametro.
Object
  
Unisce il testo dall'intervallo di elementi specificati dai parametri beginIndex e endIndex nell'elemento specificato da beginIndex, senza influire sul formato di tale elemento.
GroupElement
 Inherited
Indica se la proprietà specificata esiste ed è enumerabile.
Object
  
replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement>
Sostituisce un intervallo di elementi, specificato dai parametri beginIndex e endIndex, con il contenuto del parametro newElements.
GroupElement
  
Imposta gli elementi nel gruppo sul contenuto del vettore.
GroupElement
 Inherited
Imposta la disponibilità di una proprietà dinamica per le operazioni cicliche.
Object
  
Divide in due un oggetto TextElement, creando un nuovo oggetto TextElement nella posizione specificata.
GroupElement
 Inherited
Restituisce la rappresentazione in formato stringa di questo oggetto, formattato in base alle convenzioni specifiche per le versioni localizzate.
Object
 Inherited
Restituisce la rappresentazione in formato stringa dell'oggetto specificato.
Object
  
Separa gli elementi in un oggetto GroupElement nidificato che groupIndex specifica all'interno di un oggetto GroupElement esterno.
GroupElement
 Inherited
Restituisce il valore di base dell'oggetto specificato.
Object
Descrizione delle proprietà

elementCount

proprietà
elementCount:int  [sola lettura]

Versione linguaggio: ActionScript 3.0
Versioni runtime: Flash Player 10, AIR 1.5, Flash Lite 4

Il numero di elementi nel gruppo.



Implementazione
    public function get elementCount():int
Descrizione della funzione di costruzione

GroupElement

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

Versione linguaggio: ActionScript 3.0
Versioni runtime: Flash Player 10, AIR 1.5, Flash Lite 4

Crea una nuova istanza GroupElement.

Parametri
elements:Vector.<ContentElement> (default = null) — Un vettore di oggetti ContentElement che devono essere contenuti in GroupElement. Il vettore può essere vuoto. Il valore predefinito è null.
 
elementFormat:ElementFormat (default = null) — Il formato dell'elemento per il gruppo. Il valore predefinito è null. Questo formato viene applicato alle intersezioni tra elementi nel gruppo; tali elementi non ereditano il formato.
 
eventMirror:EventDispatcher (default = null) — L'oggetto EventDispatcher che riceve le copie di ogni evento inviato alle righe di testo create in base a questo elemento content. Il valore predefinito è null.
 
textRotation:String (default = "rotate0") — La rotazione applicata all'elemento come un'unità. Utilizzate le costanti TextRotation per questa proprietà. Il valore predefinito è TextRotation.ROTATE_0.

Genera
ArgumentError — L'oggetto element specificato contiene elementi null.
 
ArgumentError — L'oggetto element specificato contiene un elemento che non è una sottoclasse conosciuta di ContentElement.
 
ArgumentError — L'oggetto element specificato contiene elementi specificati come content di un oggetto TextBlock.
 
ArgumentError — L'oggetto element specificato contiene elementi che sono già membri di un gruppo, o sono presenti più di una volta in elements.

Elementi API correlati

Descrizione dei metodi

getElementAt

()metodo
public function getElementAt(index:int):ContentElement

Versione linguaggio: ActionScript 3.0
Versioni runtime: Flash Player 10, AIR 1.5, Flash Lite 4

Recupera un elemento dall'interno del gruppo.

Parametri

index:int — L'indice dell'elemento da recuperare.

Restituisce
ContentElement

Genera
RangeError — Se index non è compreso nell'intervallo.

getElementAtCharIndex

()metodo 
public function getElementAtCharIndex(charIndex:int):ContentElement

Versione linguaggio: ActionScript 3.0
Versioni runtime: Flash Player 10, AIR 1.5, Flash Lite 4

Restituisce l'elemento contenente il carattere specificato dal parametro charIndex.

Parametri

charIndex:int — Il valore dell'indice a base zero per il carattere di cui desiderate trovare l'elemento. Un valore 0 corrisponde al primo carattere nel gruppo, non al primo carattere in TextBlock.

Restituisce
ContentElement — L'elemento contenente il carattere nella posizione charIndex.

Genera
RangeError — Se charIndex non è compreso nell'intervallo di 0 - rawText.length.

getElementIndex

()metodo 
public function getElementIndex(element:ContentElement):int

Versione linguaggio: ActionScript 3.0
Versioni runtime: Flash Player 10, AIR 1.5, Flash Lite 4

Restituisce l'indice dell'elemento specificato dal parametro element.

Parametri

element:ContentElement — L'elemento nel gruppo di cui desiderate recuperare l'indice.

Restituisce
int — L'indice dell'elemento specificato da element, oppure -1 se l'elemento non è presente nel gruppo.

groupElements

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

Versione linguaggio: ActionScript 3.0
Versioni runtime: Flash Player 10, AIR 1.5, Flash Lite 4

Sostituisce un intervallo di elementi, specificato dai parametri beginIndex e endIndex, con un nuovo oggetto GroupElement contenente tali elementi. Come indicato, gli elementi compresi tra beginIndex e endIndex-1 vengono sostituiti.

Parametri

beginIndex:int — Il valore dell'indice a base zero della posizione iniziale dell'intervallo da raggruppare.
 
endIndex:int — Il valore dell'indice a base zero che segue la posizione finale dell'intervallo da raggruppare.

Restituisce
GroupElement — Il nuovo gruppo.

Genera
RangeError — Se beginIndex o endIndex non è compreso nell'intervallo.

mergeTextElements

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

Versione linguaggio: ActionScript 3.0
Versioni runtime: Flash Player 10, AIR 1.5, Flash Lite 4

Unisce il testo dall'intervallo di elementi specificati dai parametri beginIndex e endIndex nell'elemento specificato da beginIndex, senza influire sul formato di tale elemento. Come indicato, il testo degli elementi compresi tra beginIndex e endIndex-1 viene unito. Dopo l'unione del testo, gli elementi da beginIndex+1 a endIndex-1 vengono rimossi dal gruppo e isolati, con il valore null per le proprietà group.

Parametri

beginIndex:int — Il valore dell'indice a base zero della posizione iniziale dell'intervallo da unire.
 
endIndex:int — Il valore dell'indice a base zero che segue la posizione finale dell'intervallo da unire.

Restituisce
flash.text.engine:TextElement — Il primo elemento di testo nell'intervallo, che ora contiene tutto il testo nell'intervallo.

Genera
RangeError — Se beginIndex o endIndex non è compreso nell'intervallo.
 
ArgumentError — Se qualsiasi elemento nell'intervallo specificato non è TextElement.

Elementi API correlati

replaceElements

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

Versione linguaggio: ActionScript 3.0
Versioni runtime: Flash Player 10, AIR 1.5, Flash Lite 4

Sostituisce un intervallo di elementi, specificato dai parametri beginIndex e endIndex, con il contenuto del parametro newElements. Gli elementi compresi tra beginIndex e endIndex-1 vengono sostituiti.

Per eliminare degli elementi, passate null per newElements. Per inserire un elemento, passate lo stesso valore per beginIndex e endIndex. Il nuovo elemento viene inserito prima dell'indice specificato. Per aggiungere un elemento, passate elementCount per beginIndex e endIndex.

Dopo l'operazione, gli elementi sostituiti vengono isolati, con proprietà group null, e restituiti.

Parametri

beginIndex:int — L'indice a base zero del punto iniziale dell'intervallo da sostituire.
 
endIndex:int — Il valore dell'indice a base zero che segue la posizione finale dell'intervallo da sostituire.
 
newElements:Vector.<ContentElement> — Gli elementi da utilizzare per la sostituzione dell'intervallo di elementi specificato.

Restituisce
Vector.<ContentElement> — Un vettore contenente gli elementi sostituiti.

Genera
RangeError — Il valore beginIndex o endIndex specificato non rientra nell'intervallo.
 
ArgumentError — L'oggetto newElements specificato contiene elementi null.
 
ArgumentError — L'oggetto newElements specificato contiene this.
 
ArgumentError — L'oggetto newElements specificato contiene elementi che non sono una sottoclasse conosciuta di ContentElement.
 
ArgumentError — L'oggetto newElements specificato contiene elementi specificati come content di unTextBlock.
 
ArgumentError — L'oggetto newElements specificato contiene elementi che sono già membri di un gruppo, o sono presenti più di una volta in elements.
 
ArgumentError — Se l'operazione restituisce rotazioni nidificate all'interno di GroupElement.

setElements

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

Versione linguaggio: ActionScript 3.0
Versioni runtime: Flash Player 10, AIR 1.5, Flash Lite 4

Imposta gli elementi nel gruppo sul contenuto del vettore.

Parametri

value:Vector.<ContentElement>


Genera
ArgumentError — Il valore specificato contiene elementi null.
 
ArgumentError — Il valore specificato contiene this.
 
ArgumentError — L'elemento value specificato contiene elementi che non sono una sottoclasse conosciuta di ContentElement.
 
ArgumentError — L'elemento value specificato contiene elementi specificati come content di unTextBlock.
 
ArgumentError — L'elemento value specificato contiene elementi che sono già membri di un gruppo, o sono presenti più di una volta in value.
 
ArgumentError — Se l'operazione restituisce rotazioni nidificate all'interno di GroupElement.

splitTextElement

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

Versione linguaggio: ActionScript 3.0
Versioni runtime: Flash Player 10, AIR 1.5, Flash Lite 4

Divide in due un oggetto TextElement, creando un nuovo oggetto TextElement nella posizione specificata.

Parametri

elementIndex:int — Il valore dell'indice a base zero per la posizione dell'elemento nel gruppo.
 
splitIndex:int — Il valore dell'indice a base zero per il carattere nell'oggetto TextElement in corrispondenza del quale deve avvenire la separazione. Il carattere specificato è il primo carattere nel nuovo oggetto TextElement.

Restituisce
flash.text.engine:TextElement — Il nuovo elemento di testo contenente l'ultima parte dell'elemento di testo originale.

Genera
RangeError — Se elementIndex o charIndex non è compreso nell'intervallo.
 
ArgumentError — Se l'elemento in elementIndex non è un oggetto TextElement.

Elementi API correlati

ungroupElements

()metodo 
public function ungroupElements(groupIndex:int):void

Versione linguaggio: ActionScript 3.0
Versioni runtime: Flash Player 10, AIR 1.5, Flash Lite 4

Separa gli elementi in un oggetto GroupElement nidificato che groupIndex specifica all'interno di un oggetto GroupElement esterno. Dopo l'operazione, gli elementi separati sostituiscono l'oggetto GroupElement nidificato, che diventa isolato con una proprietà group null.

Parametri

groupIndex:int — Il valore dell'indice a base zero per la posizione del gruppo da separare.


Genera
RangeError — Se groupIndex non è compreso nell'intervallo.
 
ArgumentError — Se l'elemento in groupIndex non è un oggetto GroupElement.
GroupElementExample.as

In questo esempio viene creata una casella rossa come oggetto GraphicElement, che viene combinata con due oggetti TextElement per creare un oggetto GroupElement. Assegna l'oggetto GroupElement alla proprietà content di un TextBlock, da cui crea tre righe.
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);
            }
        }
    }    
}






[ X ]Perché in inglese?
Il contenuto della Guida di riferimento di ActionScript 3.0 appare in inglese

Non tutte le parti della Guida di riferimento di ActionScript 3.0 sono tradotte in tutte le lingue. Quando un elemento del linguaggio non è tradotto, viene riportato in inglese. Ad esempio, la classe ga.controls.HelpBox non è tradotta in nessuna lingua. Pertanto, nella versione italiana della guida di riferimento, la descrizione della classe ga.controls.HelpBox è riportata in inglese.