| Pakket | flash.text.engine |
| Klasse | public final class GroupElement |
| Overerving | GroupElement  ContentElement Object |
| Taalversie: | ActionScript 3.0 |
| Runtimeversies: | Flash Player 10, AIR 1.5, Flash Lite 4 |
content van een TextBlock-object. Een GroupElement-object kan ook gemeenschappelijke opmaak delen in een ander GroupElement-object.
Wanneer een GroupElement een ander GroupElement bevat, behoudt het binnenste GroupElement zijn eigen opmaak (ElementFormat-instellingen). Het erft de opmaak van het buitenste GroupElement niet.
In een GroupElement hebben de meeste opmaakeigenschappen geen effect. Daarom mag u een tekstregel maken voor een GroupElement-object dat een parameter elementFormat met de waarde null heeft. Enkele opmaakeigenschappen, zoals kerning en ligature hebben wel effect op opmaak, waar snijvlakken bestaan tussen leden van de groep. Als de groep opmaak null heeft, bepaalt de opmaak van het voorgaande element de opmaak op de plaatsen waar snijvlakken tussen leden van de groep zijn.
Verwante API-elementen
Openbare eigenschappen
Overerfde openbare eigenschappen verbergen
Overerfde openbare eigenschappen weergeven| Eigenschap | Gedefinieerd door | ||
|---|---|---|---|
 | constructor : Object
Verwijzing naar het klasseobject of de constructorfunctie van een bepaalde objectinstantie. | Object | |
| elementCount : int [alleen-lezen]
Het aantal elementen in de groep. | GroupElement | ||
| elementFormat : ElementFormat
Het ElementFormat-object dat voor het element wordt gebruikt. | ContentElement | |
| eventMirror : EventDispatcher
Het object EventDispatcher dat kopieën ontvangt van elke gebeurtenis die naar geldige tekstregels wordt verzonden die op dit content-element zijn gebaseerd. | ContentElement | |
| groupElement : GroupElement [alleen-lezen]
Het GroupElement-object dat dit element bevat, of null als het niet in een groep is. | ContentElement | |
| rawText : String [alleen-lezen]
Een kopie van de tekst in het element, inclusief U+FDEF-tekens. | ContentElement | |
| text : String [alleen-lezen]
Een kopie van de tekst in het element, exclusief U+FDEF-tekens die staan voor grafische elementen in de tekenreeks. | ContentElement | |
| textBlock : flash.text.engine:TextBlock [alleen-lezen]
Het TextBlock waar dit element bij hoort. | ContentElement | |
| textBlockBeginIndex : int [alleen-lezen]
De index in het tekstblok van het eerste teken van dit element. | ContentElement | |
| textRotation : String
De rotatie die wordt toegepast op het element als een eenheid. | ContentElement | |
| userData : *
Hiermee kan de toepassing willekeurige gegevens aan het element koppelen. | ContentElement | |
Openbare methoden
| Methode | Gedefinieerd door | ||
|---|---|---|---|
GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")
Hiermee wordt een nieuwe instantie GroupElement gemaakt. | GroupElement | ||
Haalt een element uit de groep op. | GroupElement | ||
Hiermee wordt het element geretourneerd met het teken dat door de parameter charIndex is opgegeven. | GroupElement | ||
Retourneert de index van het element dat wordt opgegeven door de parameter element. | GroupElement | ||
Vervangt de reeks elementen die met de parameters beginIndex en endIndex zijn opgegeven door een nieuw GroupElement dat die elementen bevat. | GroupElement | ||
|
Geeft aan of voor een object een opgegeven eigenschap is gedefinieerd. | Object | |
|
Geeft aan of een instantie van de klasse Object zich in de prototypeketen van het object bevindt dat als parameter is opgegeven. | Object | |
Voegt de tekst uit het bereik van elementen dat met de parameters beginIndex en endIndex wordt aangegeven samen in het element dat met beginIndex wordt aangegeven, zonder dat dit van invloed is op de opmaak van dat element. | GroupElement | ||
|
Geeft aan of de opgegeven eigenschap bestaat en kan worden opgesomd. | Object | |
replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement>
Vervangt het met de parameters beginIndex en endIndex opgegeven elementenbereik door de inhoud van de parameter newElements. | GroupElement | ||
Stelt de elementen in de groep in op de inhoud van de Vector. | GroupElement | ||
|
Stelt de beschikbaarheid van een dynamische eigenschap voor lusbewerkingen in. | Object | |
Verdeelt een TextElement in twee delen, waardoor er op de aangegeven positie een nieuw TextElement wordt gemaakt. | GroupElement | ||
|
Geeft de tekenreeksweergave van dit object weer, geformatteerd volgens de locatiespecifieke conventies. | Object | |
|
Retourneert een tekenreeksrepresentatie van het opgegeven object. | Object | |
Heft de groepering op van de elementen in een genest GroupElement dat groupIndex aangeeft in een buitenste GroupElement-object. | GroupElement | ||
|
Retourneert de primitieve waarde van het opgegeven object. | Object | |
Openbare constanten
Eigenschapdetails
elementCount | eigenschap |
Constructordetails
GroupElement | () | Constructor |
public function GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")| Taalversie: | ActionScript 3.0 |
| Runtimeversies: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Hiermee wordt een nieuwe instantie GroupElement gemaakt.
Parameterselements:Vector.<ContentElement> (default = null)null.
| |
elementFormat:ElementFormat (default = null)null. Deze opmaak geldt voor de intersecties tussen elementen in de groep; deze elementen nemen de opmaak niet automatisch over.
| |
eventMirror:EventDispatcher (default = null)EventDispatcher dat kopieën ontvangt van elke gebeurtenis die naar de tekstregels wordt verzonden die op dit content-element zijn gebaseerd. De standaardwaarde is null.
| |
textRotation:String (default = "rotate0")TextRotation voor deze eigenschap. De standaardwaarde is TextRotation.ROTATE_0.
|
Gegenereerde uitzondering
ArgumentError — Het opgegeven element bevat null elementen.
| |
ArgumentError — Het opgegeven element bevat een element dat geen bekende subklasse van ContentElement is.
| |
ArgumentError — Het opgegeven element bevat elementen die zijn opgegeven als de content van een TextBlock.
| |
ArgumentError — Het opgegeven element bevat elementen die al lid zijn van een groep of die meerdere keren voorkomen in de elementen.
|
Verwante API-elementen
Methodedetails
getElementAt | () | methode |
public function getElementAt(index:int):ContentElement| Taalversie: | ActionScript 3.0 |
| Runtimeversies: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Haalt een element uit de groep op.
Parameters
index:int — De index van het element dat moet worden opgehaald.
|
ContentElement |
Gegenereerde uitzondering
RangeError — Als index buiten bereik valt.
|
getElementAtCharIndex | () | methode |
public function getElementAtCharIndex(charIndex:int):ContentElement| Taalversie: | ActionScript 3.0 |
| Runtimeversies: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Hiermee wordt het element geretourneerd met het teken dat door de parameter charIndex is opgegeven.
Parameters
charIndex:int — De op nul gebaseerde indexwaarde voor het teken waarvan u het element wilt vinden. Een waarde 0 komt overeen met het eerste teken in de groep, niet het eerste teken in het TextBlock.
|
ContentElement — Het element met het teken op charIndex.
|
Gegenereerde uitzondering
RangeError — Als charIndex niet in het bereik van 0 - rawText.length valt.
|
getElementIndex | () | methode |
public function getElementIndex(element:ContentElement):int| Taalversie: | ActionScript 3.0 |
| Runtimeversies: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Retourneert de index van het element dat wordt opgegeven door de parameter element.
Parameters
element:ContentElement — Het element in de groep waarvan u de index wilt ophalen.
|
int — De index van het element dat is opgegeven door element of -1 als het element niet in de groep aanwezig is.
|
groupElements | () | methode |
public function groupElements(beginIndex:int, endIndex:int):GroupElement| Taalversie: | ActionScript 3.0 |
| Runtimeversies: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Vervangt de reeks elementen die met de parameters beginIndex en endIndex zijn opgegeven door een nieuw GroupElement dat die elementen bevat. De elementen vanaf beginIndex tot endIndex-1 worden vervangen.
Parameters
beginIndex:int — De op nul gebaseerde indexwaarde voor de beginpositie van het groeperingsbereik.
| |
endIndex:int — De op nul gebaseerde indexwaarde na de eindpositie van het groeperingsbereik.
|
GroupElement — De nieuwe groep.
|
Gegenereerde uitzondering
RangeError — Als beginIndex of endIndex buiten bereik vallen.
|
mergeTextElements | () | methode |
public function mergeTextElements(beginIndex:int, endIndex:int):flash.text.engine:TextElement| Taalversie: | ActionScript 3.0 |
| Runtimeversies: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Voegt de tekst uit het bereik van elementen dat met de parameters beginIndex en endIndex wordt aangegeven samen in het element dat met beginIndex wordt aangegeven, zonder dat dit van invloed is op de opmaak van dat element. De tekst uit de elementen van beginIndex tot endIndex-1 wordt samengevoegd. Nadat de tekst is samengevoegd, worden de elementen van beginIndex+1 tot endIndex-1 uit de groep verwijderd, hebben deze geen bovenliggende elementen meer en krijgen ze de waarde null voor de eigenschap group.
Parameters
beginIndex:int — De op nul gebaseerde indexwaarde voor de beginpositie van het bereik dat moet worden samengevoegd.
| |
endIndex:int — De op nul gebaseerde indexwaarde na de eindpositie van het bereik dat moet worden samengevoegd.
|
flash.text.engine:TextElement — Het eerste tekstelement in het bereik, dat nu alle tekst in het bereik bevat.
|
Gegenereerde uitzondering
RangeError — Als beginIndex of endIndex buiten bereik vallen.
| |
ArgumentError — Als een van de elementen in het opgegeven bereik niet TextElement is
|
Verwante API-elementen
replaceElements | () | methode |
public function replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement>| Taalversie: | ActionScript 3.0 |
| Runtimeversies: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Vervangt het met de parameters beginIndex en endIndex opgegeven elementenbereik door de inhoud van de parameter newElements. De elementen vanaf beginIndex tot endIndex-1 worden vervangen.
Als u elementen wilt verwijderen, geeft u null door voor newElements. Als u een element wilt invoegen, geeft u dezelfde waarde door voor beginIndex en endIndex. Het nieuwe element wordt voor de opgegeven index ingevoegd. Als u een element wilt toevoegen, geeft u elementCount voor beginIndex en endIndex door.
Na de bewerking hebben de vervangen elementen geen bovenliggende elementen meer en hebben ze de waarde null voor de eigenschap group, waarna ze worden geretourneerd.
Parameters
beginIndex:int — De op nul gebaseerde indexwaarde voor de beginpositie van het vervangingsbereik.
| |
endIndex:int — De op nul gebaseerde indexwaarde na de eindpositie van het vervangingsbereik.
| |
newElements:Vector.<ContentElement> — De elementen die moeten worden gebruikt om het opgegeven elementenbereik te vervangen.
|
Vector.<ContentElement> — Een Vector met de elementen die zijn geplaatst.
|
Gegenereerde uitzondering
RangeError — De opgegeven parameter beginIndex of endIndex bevindt zich buiten het bereik.
| |
ArgumentError — De opgegeven newElements bevatten null elementen.
| |
ArgumentError — De opgegeven newElements bevatten het element this.
| |
ArgumentError — De opgegeven newElements bevatten elementen die geen bekende subklasse van ContentElement zijn.
| |
ArgumentError — De opgegeven newElements bevatten elementen die zijn opgegeven als de content van een TextBlock.
| |
ArgumentError — De opgegeven newElements bevatten elementen die al lid zijn van een groep of die meerdere keren voorkomen in de elementen.
| |
ArgumentError — Als de bewerking resulteert in geneste rotaties binnen GroupElement.
|
setElements | () | methode |
public function setElements(value:Vector.<ContentElement>):void| Taalversie: | ActionScript 3.0 |
| Runtimeversies: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Stelt de elementen in de groep in op de inhoud van de Vector.
Parameters
value:Vector.<ContentElement> |
Gegenereerde uitzondering
ArgumentError — De opgegeven waarde bevat null elementen.
| |
ArgumentError — De opgegeven waarde bevat dit element.
| |
ArgumentError — De opgegeven value bevat elementen die geen bekende subklasse van ContentElement zijn.
| |
ArgumentError — De opgegeven value bevat elementen die zijn opgegeven als de content van een TextBlock.
| |
ArgumentError — De opgegeven waarde bevat elementen die al lid zijn van een groep of die meerdere keren voorkomen in de waarde.
| |
ArgumentError — Als de bewerking resulteert in geneste rotaties binnen GroupElement.
|
splitTextElement | () | methode |
public function splitTextElement(elementIndex:int, splitIndex:int):flash.text.engine:TextElement| Taalversie: | ActionScript 3.0 |
| Runtimeversies: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Verdeelt een TextElement in twee delen, waardoor er op de aangegeven positie een nieuw TextElement wordt gemaakt.
Parameters
elementIndex:int — De op nul gebaseerde indexwaarde voor de positie van het element in de groep.
| |
splitIndex:int — De op nul gebaseerde indexwaarden voor het teken in het TextElement waar moet worden gesplitst. Het opgegeven teken is het eerste teken in het nieuwe TextElement.
|
flash.text.engine:TextElement — Het nieuwe tekstelement met het laatstgenoemde deel van het oorspronkelijke tekstelement.
|
Gegenereerde uitzondering
RangeError — Als elementIndex of charIndex buiten bereik valt.
| |
ArgumentError — Als het element bij elementIndex geen TextElement is.
|
Verwante API-elementen
ungroupElements | () | methode |
public function ungroupElements(groupIndex:int):void| Taalversie: | ActionScript 3.0 |
| Runtimeversies: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Heft de groepering op van de elementen in een genest GroupElement dat groupIndex aangeeft in een buitenste GroupElement-object. Na de bewerking vervangen de niet-gegroepeerde elementen het geneste GroupElement dat geen bovenliggende elementen meer heeft en de waarde null heeft voor de eigenschap group.
Parameters
groupIndex:int — De op nul gebaseerde indexwaarde voor de positie waar de groep moet worden gesplitst.
|
Gegenereerde uitzondering
RangeError — Als groupIndex buiten bereik valt.
| |
ArgumentError — Als het element bij groupIndex geen GroupElement is.
|
Voorbeelden Hoe dit voorbeeld te gebruiken
GroupElementExample.as
In dit voorbeeld wordt een rood vak gemaakt als een GraphicElement-object en met twee TextElement-objecten gecombineerd om een GroupElement-object te maken. Het GroupElement-object wordt toegewezen aan de eigenschap
content van een TextBlock waarvan drie regels worden gemaakt.
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:42 AM Z