Package | flash.text.engine |
Classe | public final class GroupElement |
Héritage | GroupElement ContentElement Object |
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5, Flash Lite 4 |
content
d’un objet TextBlock. Un objet GroupElement peut aussi partager simplement une mise en forme commune au sein d’un autre objet GroupElement.
Lorsqu’un objet GroupElement contient un autre objet GroupElement, l’objet interne conserve sa propre mise en forme (paramètres ElementFormat). Il n’hérite pas de le formatage de l’objet GroupElement externe.
La plupart des propriétés de mise en forme n’affectent pas un objet GroupElement. De ce fait, il est possible de créer une ligne de texte pour un objet GroupElement avec un paramètre elementFormat
nul. Quelques propriétés de mise en forme telles que kerning
et ligature
affectent le formatage lorsque des intersections apparaissent entre les membres du groupe. Si le groupe à un format null, le format de l’élément précédent détermine le formatage en présence de telles intersections.
Plus d’exemples
Eléments de l’API associés
Propriété | Défini par | ||
---|---|---|---|
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
elementCount : int [lecture seule]
Nombre d’éléments dans le groupe. | GroupElement | ||
elementFormat : ElementFormat
Objet ElementFormat utilisé pour l’élément. | ContentElement | ||
eventMirror : EventDispatcher
Objet EventDispatcher qui reçoit des copies de chaque événement distribué pour valider les lignes de texte créées en fonction de cet élément de contenu. | ContentElement | ||
groupElement : GroupElement [lecture seule]
Objet GroupElement contenant cet élément, ou null s’il ne fait pas partie d’un groupe. | ContentElement | ||
rawText : String [lecture seule]
Copie du texte dans l’élément, y compris les caractères U+FDEF. | ContentElement | ||
text : String [lecture seule]
Copie du texte dans l’élément, à l’exception des caractères U+FDEF représentant les éléments graphiques dans la chaîne. | ContentElement | ||
textBlock : flash.text.engine:TextBlock [lecture seule]
TextBlock auquel appartient l’élément. | ContentElement | ||
textBlockBeginIndex : int [lecture seule]
Index du premier caractère de cet élément dans le bloc de texte. | ContentElement | ||
textRotation : String
Rotation à appliquer à l’élément en tant qu’unité. | ContentElement | ||
userData : *
Permet à une application d’associer des données arbitraires à l’élément. | ContentElement |
Méthode | Défini par | ||
---|---|---|---|
GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")
Crée une nouvelle occurrence de GroupElement. | GroupElement | ||
Récupère un élément dans le groupe. | GroupElement | ||
Renvoie l’élément contenant le caractère spécifié par le paramètre charIndex. | GroupElement | ||
Renvoie l’index de l’élément spécifié par le paramètre element. | GroupElement | ||
Remplace la plage d’éléments que les paramètres beginIndex et endIndex spécifient par un nouveau GroupElement contenant ces éléments. | GroupElement | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | ||
Fusionne le texte de la plage d’éléments spécifiés par les paramètres beginIndex et endIndex dans l’élément défini par beginIndex, sans affecter le formatage de cet élément. | GroupElement | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement>
Remplace la plage d’éléments que les paramètres beginIndex et endIndex spécifient par le contenu du paramètre newElements. | GroupElement | ||
Définit les éléments du groupe sur le contenu du vecteur. | GroupElement | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Scinde un objet TextElement en deux et crée un nouvel objet TextElement à la position spécifiée. | GroupElement | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | ||
Annule le regroupement des éléments d’un GroupElement imbriqué que groupIndex spécifie au sein d’un objet GroupElement externe. | GroupElement | ||
Renvoie la valeur primitive de l’objet spécifié. | Object |
elementCount | propriété |
GroupElement | () | Constructeur |
public function GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Crée une nouvelle occurrence de GroupElement.
Paramètreselements:Vector.<ContentElement> (default = null ) — Vecteur d’objets ContentElement devant être contenus dans le GroupElement. Le vecteur peut être vide. La valeur par défaut est null .
| |
elementFormat:ElementFormat (default = null ) — Format des éléments du groupe. La valeur par défaut est null . Ce format s’applique aux intersections placées entre les éléments du groupe ; ces éléments n’héritent pas du format.
| |
eventMirror:EventDispatcher (default = null ) — Objet EventDispatcher qui reçoit des copies de chaque événement déclenché vers les lignes de texte créées en fonction de cet élément de contenu. La valeur par défaut est null .
| |
textRotation:String (default = "rotate0 ") — Rotation appliquée à l’élément en tant qu’unité. Utilisez les constantes TextRotation pour cette propriété. La valeur par défaut est TextRotation.ROTATE_0 .
|
Valeur émise
ArgumentError — L’élément spécifié contient des éléments null .
| |
ArgumentError — L’élément spécifié contient un élément qui ne correspond à aucune sous-classe connue de ContentElement .
| |
ArgumentError — L’élément spécifié contient des éléments définis en tant que content d’un TextBlock .
| |
ArgumentError — L’élément spécifié contient des éléments appartenant déjà à un groupe, ou qui apparaissent plusieurs fois dans les éléments .
|
Eléments de l’API associés
getElementAt | () | méthode |
public function getElementAt(index:int):ContentElement
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Récupère un élément dans le groupe.
Paramètres
index:int — Index de l’élément à récupérer.
|
ContentElement |
Valeur émise
RangeError — si index est hors limites.
|
getElementAtCharIndex | () | méthode |
public function getElementAtCharIndex(charIndex:int):ContentElement
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Renvoie l’élément contenant le caractère spécifié par le paramètre charIndex
.
Paramètres
charIndex:int — Valeur d’index de base zéro du caractère dont vous recherchez l’élément. Une valeur 0 correspond au premier caractère du groupe, pas au premier caractère du TextBlock.
|
ContentElement — Elément contenant le caractère au niveau de charIndex
|
Valeur émise
RangeError — Si charIndex n’appartient pas à la plage 0 - rawText.length .
|
getElementIndex | () | méthode |
public function getElementIndex(element:ContentElement):int
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Renvoie l’index de l’élément spécifié par le paramètre element
.
Paramètres
element:ContentElement — Elément du groupe dont vous souhaitez récupérer l’index.
|
int — Index de l’élément spécifié par element ou -1 si l’élément n’appartient pas au groupe.
|
groupElements | () | méthode |
public function groupElements(beginIndex:int, endIndex:int):GroupElement
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Remplace la plage d’éléments que les paramètres beginIndex
et endIndex
spécifient par un nouveau GroupElement
contenant ces éléments. Comme prévu, les éléments situés entre beginIndex et endIndex-1 sont remplacés.
Paramètres
beginIndex:int — Valeur d’index de base zéro de la position de départ de la plage à regrouper.
| |
endIndex:int — Valeur d’index de base zéro suivant la position de fin de la plage à regrouper.
|
GroupElement — Nouveau groupe.
|
Valeur émise
RangeError — Si beginIndex ou endIndex est hors limites.
|
mergeTextElements | () | méthode |
public function mergeTextElements(beginIndex:int, endIndex:int):flash.text.engine:TextElement
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Fusionne le texte de la plage d’éléments spécifiés par les paramètres beginIndex
et endIndex
dans l’élément défini par beginIndex
, sans affecter le formatage de cet élément. Comme prévu, les éléments situés entre beginIndex et endIndex-1 sont fusionnés. Après la fusion de leur texte, les éléments compris entre beginIndex+1 et endIndex-1 son supprimés du groupe et deviennent orphelins, avec les propriétés group
null
.
Paramètres
beginIndex:int — Valeur d’index de base zéro de la position de départ de la plage à fusionner.
| |
endIndex:int — Valeur d’index de base zéro suivant la position de fin de la plage à fusionner.
|
flash.text.engine:TextElement — Premier élément de texte de la plage, contenant à présent l’ensemble du texte de la plage.
|
Valeur émise
RangeError — Si beginIndex ou endIndex est hors limites.
| |
ArgumentError — Si l’un des éléments de la plage spécifiée n’est pas un TextElement.
|
Eléments de l’API associés
replaceElements | () | méthode |
public function replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement>
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Remplace la plage d’éléments que les paramètres beginIndex
et endIndex
spécifient par le contenu du paramètre newElements.
Les éléments situés entre beginIndex et endIndex-1 sont remplacés.
Pour supprimer des éléments, transmettez null
pour newElements
. Pour insérer un élément, transmettez la même valeur pour beginIndex
et endIndex
. Le nouvel élément est inséré avant l’index spécifié. Pour ajouter un élément, transmettez elementCount
pour beginIndex
et endIndex
.
Après l’opération, les éléments remplacés sont orphelins, avec des propriétés group
null
, puis sont renvoyés.
Paramètres
beginIndex:int — Valeur d’index de base zéro pour la position de début de la plage de remplacement.
| |
endIndex:int — Valeur d’index de base zéro suivant la position de fin de la plage de remplacement.
| |
newElements:Vector.<ContentElement> — Eléments à utiliser pour remplacer la plage d’éléments spécifiée.
|
Vector.<ContentElement> — Vecteur contenant les éléments qui ont été remplacés.
|
Valeur émise
RangeError — La valeur beginIndex ou endIndex est hors limite.
| |
ArgumentError — Les newElements spécifiés contiennent des éléments null .
| |
ArgumentError — Les newElements spécifiés contiennent this .
| |
ArgumentError — Les newElements spécifiés contiennent des éléments qui ne correspondent pas à une sous-classe connue de ContentElement .
| |
ArgumentError — Les newElements spécifiés contiennent des éléments définis en tant que content d’un TextBlock .
| |
ArgumentError — Les newElements spécifiés contiennent des éléments appartenant déjà à un groupe, ou qui apparaissent plusieurs fois dans les éléments .
| |
ArgumentError — Si l’opération résulte en rotations imbriquées dans GroupElement .
|
setElements | () | méthode |
public function setElements(value:Vector.<ContentElement>):void
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Définit les éléments du groupe sur le contenu du vecteur.
Paramètres
value:Vector.<ContentElement> |
Valeur émise
ArgumentError — La valeur spécifiée contient des éléments null .
| |
ArgumentError — La valeur spécifiée contient this .
| |
ArgumentError — La valeur spécifiée contient des éléments qui ne correspondent pas à une sous-classe connue de ContentElement .
| |
ArgumentError — La valeur spécifiée contient des éléments spécifiés en tant que content d’un TextBlock .
| |
ArgumentError — La valeur spécifiée contient des éléments appartenant déjà à un groupe, ou qui apparaissent plusieurs fois dans la valeur .
| |
ArgumentError — Si l’opération résulte en rotations imbriquées dans GroupElement .
|
splitTextElement | () | méthode |
public function splitTextElement(elementIndex:int, splitIndex:int):flash.text.engine:TextElement
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Scinde un objet TextElement en deux et crée un nouvel objet TextElement à la position spécifiée.
Paramètres
elementIndex:int — Valeur d’index de base zéro de la position de l’élément dans le groupe.
| |
splitIndex:int — Valeur d’index de base zéro du caractère dans le TextElement où se produit la division. Le caractère spécifié est le premier caractère du nouveau TextElement.
|
flash.text.engine:TextElement — Nouvel élément de texte contenant la dernière partie de l’élément de texte d’origine.
|
Valeur émise
RangeError — Si elementIndex ou charIndex est hors limites.
| |
ArgumentError — Si l’élément au niveau de elementIndex n’est pas un TextElement.
|
Eléments de l’API associés
ungroupElements | () | méthode |
public function ungroupElements(groupIndex:int):void
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Annule le regroupement des éléments d’un GroupElement imbriqué que groupIndex
spécifie au sein d’un objet GroupElement externe. Après l’opération, les éléments dégroupés remplacent le GroupElement imbriqué, qui devient un orphelin avec une propriété group
null
.
Paramètres
groupIndex:int — Valeur d’index de base zéro de la position du groupe à diviser.
|
Valeur émise
RangeError — Si groupIndex est hors limites.
| |
ArgumentError — Si l’élément au niveau de groupIndex n’est pas un objet GroupElement.
|
content
d’un TextBlock, à partir duquel il crée trois lignes.
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, 09:30 AM Z