ActionScript® 3.0 Referenzhandbuch für die Adobe® Flash®-Plattform
Home  |  Liste der Pakete und Klassen ausblenden |  Pakete  |  Klassen  |  Neue Funktionen  |  Stichwortverzeichnis  |  Anhänge  |  Warum auf Englisch?
Filter: Daten werden vom Server abgerufen...
Daten werden vom Server abgerufen...
flash.text.engine 

GroupElement  - AS3

Paketflash.text.engine
Klassepublic final class GroupElement
VererbungGroupElement Inheritance ContentElement Inheritance Object

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Ein GroupElement-Objekt gruppiert eine Sammlung von TextElement-, GraphicElement- oder anderen GroupElement-Objekten, die Sie als Einheit der content-Eigenschaft eines TextBlock-Objekts zuweisen können. Ein GroupElement-Objekt kann auch einfach über die gleiche Formatierung innerhalb eines anderen GroupElement-Objekts verfügen.

Wenn ein GroupElement ein anderes GroupElement enthält, behält das innere GroupElement seine eigene Formatierung (ElementFormat-Einstellungen). Es übernimmt nicht die Formatierung des äußeren GroupElement-Objekts.

Bei einem GroupElement sind die meisten Formateigenschaften wirkungslos. Aus diesem Grund ist es zulässig, eine Textzeile für ein GroupElement-Objekt zu erstellen, das einen elementFormat-Parameter mit dem Wert null hat. Einige Formateigenschaften wie kerning und ligature wirken sich an den Stellen auf die Formatierung aus, an denen sich Mitglieder der Gruppe überschneiden. Hat die Gruppe ein null-Format, bestimmt das Format des vorhergehenden Elements die Formatierung an den Stellen, an denen sich Mitglieder der Gruppe überschneiden.

Beispiele anzeigen

Verwandte API-Elemente



Öffentliche Eigenschaften
 EigenschaftDefiniert von
 Inheritedconstructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.
Object
  elementCount : int
[schreibgeschützt] Die Anzahl der Elemente innerhalb der Gruppe.
GroupElement
 InheritedelementFormat : ElementFormat
Das ElementFormat-Objekt, das für das Element verwendet wird.
ContentElement
 InheritedeventMirror : EventDispatcher
Das EventDispatcher-Objekt, das Kopien von jedem Ereignis erhält, das für auf diesem content-Element basierende gültige Textzeilen ausgelöst wurde.
ContentElement
 InheritedgroupElement : GroupElement
[schreibgeschützt] Das GroupElement-Objekt, das dieses Element enthält, oder null, falls es sich nicht in einer Gruppe befindet.
ContentElement
 InheritedrawText : String
[schreibgeschützt] Eine Kopie des Texts in diesem Element, einschließlich aller U+FDEF-Zeichen.
ContentElement
 Inheritedtext : String
[schreibgeschützt] Eine Kopie des Texts in diesem Element, ausschließlich aller U+FDEF-Zeichen, die Grafikelemente im String repräsentieren.
ContentElement
 InheritedtextBlock : flash.text.engine:TextBlock
[schreibgeschützt] Der TextBlock, zu dem dieses Element gehört.
ContentElement
 InheritedtextBlockBeginIndex : int
[schreibgeschützt] Der Index, den das erste Zeichen dieses Elements im Textblock belegt.
ContentElement
 InheritedtextRotation : String
Die Drehung, die auf das Element als Einheit angewendet werden soll.
ContentElement
 InheriteduserData : *
Ermöglicht einer Anwendung, beliebige Daten mit dem Element zu verknüpfen.
ContentElement
Öffentliche Methoden
 MethodeDefiniert von
  
GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")
Erstellt eine neue GroupElement-Instanz.
GroupElement
  
Ruft ein Element aus der Gruppe ab.
GroupElement
  
Gibt das Element zurück, das das vom charIndex-Parameter angegebene Zeichen enthält.
GroupElement
  
Gibt den Index des Elements zurück, das vom element-Parameter angegeben wird.
GroupElement
  
groupElements(beginIndex:int, endIndex:int):GroupElement
Ersetzt den Bereich von Elementen, die die beginIndex- und endIndex-Parameter angeben, durch ein neues GroupElement, das diese Elemente enthält.
GroupElement
 Inherited
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.
Object
 Inherited
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.
Object
  
Führt den Text aus einem Bereich von Elementen zusammen, die die beginIndex- und endIndex-Parameter angeben, zu dem von beginIndex angegebenen Element zusammen, ohne das Format dieses Elements zu ändern.
GroupElement
 Inherited
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.
Object
  
replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement>
Ersetzt den Elementbereich, der durch die beginIndex- und endIndex-Parameter angegeben wird, durch den Inhalt des newElements-Parameters.
GroupElement
  
Legt die Elemente in der Gruppe auf den Inhalt des Vektors fest.
GroupElement
 Inherited
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.
Object
  
Teilt ein TextElement in zwei, wodurch an der angegebenen Position ein neues TextElement erstellt wird.
GroupElement
 Inherited
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.
Object
 Inherited
Gibt das angegebene Objekt als String zurück.
Object
  
Hebt die Gruppierung der Elemente in einem verschachtelten GroupElement auf, das groupIndex innerhalb eines äußeren GroupElement-Objekts angibt.
GroupElement
 Inherited
Gibt den Grundwert des angegebenen Objekts zurück.
Object
Eigenschaftendetails

elementCount

Eigenschaft
elementCount:int  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Die Anzahl der Elemente innerhalb der Gruppe.



Implementierung
    public function get elementCount():int
Konstruktordetails

GroupElement

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

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Erstellt eine neue GroupElement-Instanz.

Parameter
elements:Vector.<ContentElement> (default = null) — Ein Vektor von ContentElement-Objekten, die in GroupElement enthalten sein sollen. Der Vektor kann leer sein. Der Standardwert ist null.
 
elementFormat:ElementFormat (default = null) — Das Elementformat für die Gruppe. Der Standardwert ist null. Dieses Format gilt für Überschneidungen zwischen Elementen in der Gruppe; diese Elemente übernehmen das Format nicht.
 
eventMirror:EventDispatcher (default = null) — Das EventDispatcher-Objekt, das Kopien von jedem Ereignis erhält, das für Textzeilen ausgelöst wurde, die aufgrund dieses content-Elements erstellt wurden. Der Standardwert ist null.
 
textRotation:String (default = "rotate0") — Die Drehung, die auf das Element als Einheit angewendet werden soll. Verwenden Sie TextRotation-Konstanten für diese Eigenschaft. Der Standardwert ist TextRotation.ROTATE_0.

Auslöser
ArgumentError — Das angegebene element enthält null Elemente.
 
ArgumentError — Das angegebene element enthält ein Element, das keine bekannte Unterklasse von ContentElement ist.
 
ArgumentError — Das angegebene element enthält Elemente, die als content eines TextBlock spezifiziert wurden.
 
ArgumentError — Das angegebene element enthält Elemente, die bereits Mitglied einer Gruppe sind oder mehr als einmal in elements auftreten.

Verwandte API-Elemente

Methodendetails

getElementAt

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

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Ruft ein Element aus der Gruppe ab.

Parameter

index:int — Die Indexposition des abzurufenden Elements.

Rückgabewerte
ContentElement

Auslöser
RangeError — Wenn index außerhalb des gültigen Bereichs liegt.

getElementAtCharIndex

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

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Gibt das Element zurück, das das vom charIndex-Parameter angegebene Zeichen enthält.

Parameter

charIndex:int — Der auf null basierende Indexwert für das Zeichen, dessen Element Sie suchen. Ein Wert von 0 entspricht dem ersten Zeichen in der Gruppe, nicht dem ersten Zeichen im TextBlock.

Rückgabewerte
ContentElement — Das Element, das das Zeichen bei charIndex enthält.

Auslöser
RangeError — Wenn charIndex nicht im Bereich von 0 - rawText.length liegt.

getElementIndex

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

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Gibt den Index des Elements zurück, das vom element-Parameter angegeben wird.

Parameter

element:ContentElement — Das Element in der Gruppe, dessen Index Sie abrufen möchten.

Rückgabewerte
int — Der Index des Elements, das von element angegeben wird, oder -1, wenn das Element nicht in der Gruppe enthalten ist.

groupElements

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

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Ersetzt den Bereich von Elementen, die beginIndex- und endIndex-Parameter angeben, durch ein neues GroupElement, das diese Elemente enthält. Wie geplant werden die Elemente ab beginIndex bis endIndex-1 ersetzt.

Parameter

beginIndex:int — Der auf Null basierende Indexwert für die Startposition des zu zusammenzuführenden Bereichs.
 
endIndex:int — Der auf Null basierende Indexwert nach der Endposition des zu zusammenzuführenden Bereichs.

Rückgabewerte
GroupElement — Die neue Gruppe.

Auslöser
RangeError — Wenn beginIndex oder endIndex außerhalb des gültigen Bereichs liegt.

mergeTextElements

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

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Führt den Text aus einem Bereich von Elementen zusammen, die die beginIndex- und endIndex-Parameter angeben, zu dem von beginIndex angegebenen Element zusammen, ohne das Format dieses Elements zu ändern. Wie geplant wird der Text aus Elementen ab beginIndex bis endIndex-1 zusammengeführt. Nachdem ihr Text zusammengeführt wurde, werden Elemente von beginIndex+1 bis endIndex-1 aus der Gruppe entfernt und verwaisen mit dem Wert null für die groupEigenschaft.

Parameter

beginIndex:int — Der auf Null basierende Indexwert für die Startposition des zu zusammenzuführenden Bereichs.
 
endIndex:int — Der auf Null basierende Indexwert nach der Endposition des zu zusammenzuführenden Bereichs.

Rückgabewerte
flash.text.engine:TextElement — Das erste Textelement im Bereich, das jetzt den gesamten Text im Bereich enthält.

Auslöser
RangeError — Wenn beginIndex oder endIndex außerhalb des gültigen Bereichs liegt.
 
ArgumentError — Wenn eines der Elemente im angegebenen Bereich kein TextElement ist.

Verwandte API-Elemente

replaceElements

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

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Ersetzt den Elementbereich, der durch die beginIndex- und endIndex-Parameter angegeben wird, durch den Inhalt des newElements-Parameter. Die Elemente ab beginIndex bis endIndex-1 werden ersetzt.

Um Elemente zu löschen, übergeben Sie null für newElements. Um ein Element einzufügen, übergeben Sie denselben Wert für beginIndex und endIndex. Das neue Element wird vor dem angegebenen Index eingefügt. Um ein Element anzuhängen, übergeben Sie elementCount für beginIndex und endIndex.

Nach dem Vorgang sind die ersetzten Elemente verwaist; für die group-Eigenschaften wird der Wert null zurückgegeben.

Parameter

beginIndex:int — Der auf Null basierende Indexwert für die Startposition des Ersetzungsbereichs.
 
endIndex:int — Der auf Null basierende Indexwert, der der Endposition des Ersetzungsbereichs folgt.
 
newElements:Vector.<ContentElement> — Die Elemente, durch die der angegebene Elementbereich ersetzt werden soll.

Rückgabewerte
Vector.<ContentElement> — Ein Vektor, der die ersetzten Elemente enthält.

Auslöser
RangeError — Der angegebene beginIndex bzw. endIndex befindet sich nicht im gültigen Bereich.
 
ArgumentError — Die angegebenen newElements enthalten null Elemente.
 
ArgumentError — Die angegebenen newElements enthalten this.
 
ArgumentError — Die angegebenen newElements enthalten Elemente, die keine bekannte Unterklasse von ContentElement sind.
 
ArgumentError — Die angegebenen newElements enthalten Elemente, die als content eines TextBlock spezifiziert wurden.
 
ArgumentError — Die angegebenen newElements enthalten Elemente, die bereits Mitglied einer Gruppe sind oder mehr als einmal in elements auftreten.
 
ArgumentError — Wenn der Vorgang zu verschachtelten Drehungen innerhalb von GroupElement führen würde.

setElements

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

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Legt die Elemente in der Gruppe auf den Inhalt des Vektors fest.

Parameter

value:Vector.<ContentElement>


Auslöser
ArgumentError — Der angegebene value enthält null Elemente.
 
ArgumentError — Der angegebene value enthält this.
 
ArgumentError — Der angegebene value enthält Elemente, die keine bekannte Unterklasse von ContentElement sind.
 
ArgumentError — Der angegebene value enthält Elemente, die als content eines TextBlock spezifiziert wurden.
 
ArgumentError — Der angegebene value enthält Elemente, die bereits Mitglied einer Gruppe sind oder mehr als einmal in value auftreten.
 
ArgumentError — Wenn der Vorgang zu verschachtelten Drehungen innerhalb von GroupElement führen würde.

splitTextElement

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

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Teilt ein TextElement in zwei, wodurch an der angegebenen Position ein neues TextElement erstellt wird.

Parameter

elementIndex:int — Der auf Null basierende Indexwert für die Position des Elements in der Gruppe.
 
splitIndex:int — Der auf Null basierende Indexwert für das Zeichen im TextElement, bei dem die Teilung erfolgt. Das angegebene Zeichen ist das erste Zeichen des neuen TextElement.

Rückgabewerte
flash.text.engine:TextElement — Das neue Textelement, das den hinteren Teil des ursprünglichen Textelements enthält.

Auslöser
RangeError — Wenn elementIndex oder charIndex außerhalb des gültigen Bereichs liegt.
 
ArgumentError — Wenn das Element bei elementIndex kein TextElement ist.

Verwandte API-Elemente

ungroupElements

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

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Hebt die Gruppierung der Elemente in einem verschachtelten GroupElement auf, das groupIndex innerhalb eines äußeren GroupElement-Objekts angibt. Nach dem Vorgang ersetzen die Elemente, deren Gruppierung aufgehoben wurde, das verschachtelte GroupElement, das verwaist und den Wert null für die group-Eigenschaft aufweist.

Parameter

groupIndex:int — Der auf Null basierende Indexwert für die Position der zu teilenden Gruppe.


Auslöser
RangeError — Wenn groupIndex außerhalb des gültigen Bereichs liegt.
 
ArgumentError — Wenn das Element bei groupIndex kein GroupElement ist.
GroupElementExample.as

In diesem Beispiel wird ein roter Rahmen als GraphicElement-Objekt erstellt und mit zwei TextElement-Objekten kombiniert, um ein GroupElement-Objekt zu erstellen. Das GroupElement-Objekt wird der content-Eigenschaft eines TextBlock zugewiesen, aus dem es drei Zeilen erstellt.
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 ]Warum auf Englisch?
Inhalt des ActionScript 3.0-Referenzhandbuchs wird in englischer Sprache angezeigt

Nicht alle Teile des ActionScript 3.0-Referenzhandbuchs wurden in alle Sprachen übersetzt. Wenn der Text zu einem Sprachelement nicht übersetzt wurde, wird er auf Englisch angezeigt. Zum Beispiel wurden die Informationen zur ga.controls.HelpBox-Klasse nicht in andere Sprachen übersetzt. In der deutschen Version des Referenzhandbuchs erscheint der Abschnitt zur ga.controls.HelpBox-Klasse deshalb auf Englisch.