FlowGroupElement

Package	flashx.textLayout.elements
Classe	public class FlowGroupElement
Héritage	FlowGroupElement FlowElement Object
Sous-classes	ParagraphFormattedElement, SubParagraphGroupElementBase

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La classe FlowGroupElement est la classe de base pour les objets FlowElement qui peuvent avoir un tableau d’enfants. Ces classes comprennent des objets TextFlow, ParagraphElement, DivElement et LinkElement.

Vous ne pouvez pas créer un objet FlowGroupElement directement. Appeler un nouvel objet FlowGroupElement() renvoie une exception d’erreur.

Propriété MXML par défautmxmlChildren

Eléments de l’API associés

DivElement
LinkElement
ParagraphElement
TextFlow

Propriétés publiques

Masquer les propriétés publiques héritées

Afficher les propriétés publiques héritées

	Propriété		Défini par
		alignmentBaseline : * TextLayoutFormat : spécifie la ligne de base sur laquelle la ligne de base dominante s’aligne.	FlowElement
		backgroundAlpha : * TextLayoutFormat : valeur alpha (transparence) pour l’arrière-plan (adopte la valeur par défaut si undefined pendant la cascade).	FlowElement
		backgroundColor : * TextLayoutFormat : couleur d’arrière-plan du texte (adopte la valeur par défaut si undefined pendant la propagation en cascade).	FlowElement
		baselineShift : * TextLayoutFormat : valeur de décalage de la ligne de base par rapport à la valeur dominantBaseline.	FlowElement
		blockProgression : * TextLayoutFormat : spécifie la progression verticale ou horizontale du positionnement de la ligne.	FlowElement
		breakOpportunity : * TextLayoutFormat : contrôle l’autorisation des sauts de ligne lors de la séparation de l’habillage du texte en plusieurs lignes.	FlowElement
		cffHinting : * TextLayoutFormat : type de repère CFF utilisé pour ce texte.	FlowElement
		clearFloats : * TextLayoutFormat : contrôle la manière dont le texte enveloppe un élément flottant.	FlowElement
		color : * TextLayoutFormat : couleur du texte.	FlowElement
		columnCount : * TextLayoutFormat : nombre de colonnes de texte (adopte la valeur par défaut si la valeur est undefined pendant la propagation en cascade).	FlowElement
		columnGap : * TextLayoutFormat : spécifie la quantité d’espace de gouttière, en pixels, à laisser entre les colonnes (adopte la valeur par défaut si undefined pendant la propagation en cascade).	FlowElement
		columnWidth : * TextLayoutFormat : largeur de colonne en pixels (adopte la valeur par défaut si undefined pendant la propagation en cascade).	FlowElement
		computedFormat : flashx.textLayout.formats:ITextLayoutFormat [lecture seule] Renvoie les attributs de format de caractère calculés qui sont appliqués à cet élément.	FlowElement
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		coreStyles : Object [lecture seule] Renvoie l’objet coreStyles sur cet objet FlowElement.	FlowElement
		digitCase : * TextLayoutFormat : le type de casse de chiffres utilisée pour ce texte.	FlowElement
		digitWidth : * TextLayoutFormat : type de largeur de chiffres utilisée pour ce texte.	FlowElement
		direction : * TextLayoutFormat : spécifie le niveau d’intégration bidirectionnelle par défaut du texte dans le bloc de texte.	FlowElement
		dominantBaseline : * TextLayoutFormat : spécifie la ligne de base de l’élément s’alignant sur alignmentBaseline pour déterminer la position verticale de l’élément sur la ligne.	FlowElement
		firstBaselineOffset : * TextLayoutFormat : spécifie la position de ligne de base de la première ligne du conteneur.	FlowElement
		fontFamily : * TextLayoutFormat : nom de la police à utiliser, ou liste de noms de police séparés par une virgule.	FlowElement
		fontLookup : * TextLayoutFormat : recherche de police à utiliser.	FlowElement
		fontSize : * TextLayoutFormat : taille du texte en pixels.	FlowElement
		fontStyle : * TextLayoutFormat : style du texte.	FlowElement
		fontWeight : * TextLayoutFormat : épaisseur du texte.	FlowElement
		format : flashx.textLayout.formats:ITextLayoutFormat Propriétés TextLayoutFormat appliquées directement à cet élément.	FlowElement
		id : String Attribue un identifiant à l’élément. De fait, il est possible de définir le style de l’élément, vous pouvez donc référencer l’identifiant.	FlowElement
		justificationRule : * TextLayoutFormat : règle utilisée pour justifier le texte dans un paragraphe.	FlowElement
		justificationStyle : * TextLayoutFormat : style utilisé pour la justification du paragraphe.	FlowElement
		kerning : * TextLayoutFormat : le crénage ajuste les pixels entre certaines paires de caractères pour améliorer la lisibilité.	FlowElement
		leadingModel : * TextLayoutFormat : spécifie le modèle d’interlignage, qui est une combinaison de la base et de la direction de l’interlignage.	FlowElement
		ligatureLevel : * TextLayoutFormat : contrôle laquelle des ligatures qui sont définies dans la police peut être utilisée dans le texte.	FlowElement
		lineBreak : * TextLayoutFormat : contrôle le retour à la ligne dans le conteneur (adopte la valeur par défaut si undefined pendant cascade).	FlowElement
		lineHeight : * TextLayoutFormat : contrôles d’interlignage pour le texte.	FlowElement
		lineThrough : * TextLayoutFormat : si la valeur est true, applique le style de formatage barré, une ligne au milieu du texte.	FlowElement
		linkActiveFormat : * TextLayoutFormat : définit les attributs de mise en forme utilisés pour les liens à l’état normal.	FlowElement
		linkHoverFormat : * TextLayoutFormat : définit les attributs de mise en forme utilisés pour les liens à l’état pointé, c’est-à-dire lorsque l’utilisateur survole un lien avec la souris.	FlowElement
		linkNormalFormat : * TextLayoutFormat : définit les attributs de mise en forme utilisés pour les liens à l’état normal.	FlowElement
		listAutoPadding : * TextLayoutFormat : spécifie un retrait automatique pour le bord de début des listes, lorsque la valeur d’espacement de la liste de ce côté est auto.	FlowElement
		listMarkerFormat : * TextLayoutFormat : définit les marqueurs de liste d’attributs de mise en forme.	FlowElement
		listStylePosition : * TextLayoutFormat : les valeurs valides sont ListStylePosition.INSIDE, ListStylePosition.OUTSIDE et FormatValue.INHERIT. La valeur par défaut est undefined, ce qui indique qu’elle n’est pas définie. Si lors de la propagation en cascade, la valeur est undefined, cette propriété héritera ses valeurs d’un ancêtre.	FlowElement
		listStyleType : * TextLayoutFormat : les valeurs valides sont ListStyleType.UPPER_ALPHA, ListStyleType.LOWER_ALPHA, ListStyleType.UPPER_ROMAN, ListStyleType.LOWER_ROMAN, ListStyleType.NONE, ListStyleType.DISC, ListStyleType.CIRCLE, ListStyleType.SQUARE, ListStyleType.BOX, ListStyleType.CHECK, ListStyleType.DIAMOND, ListStyleType.HYPHEN, ListStyleType.ARABIC_INDIC, ListStyleType.BENGALI, ListStyleType.DECIMAL, ListStyleType.DECIMAL_LEADING_ZERO, ListStyleType.DEVANAGARI, ListStyleType.GUJARATI, ListStyleType.GURMUKHI, ListStyleType.KANNADA, ListStyleType.PERSIAN, ListStyleType.THAI, ListStyleType.URDU, ListStyleType.CJK_EARTHLY_BRANCH, ListStyleType.CJK_HEAVENLY_STEM, ListStyleType.HANGUL, ListStyleType.HANGUL_CONSTANT, ListStyleType.HIRAGANA, ListStyleType.HIRAGANA_IROHA, ListStyleType.KATAKANA, ListStyleType.KATAKANA_IROHA, ListStyleType.LOWER_ALPHA, ListStyleType.LOWER_GREEK, ListStyleType.LOWER_LATIN, ListStyleType.UPPER_ALPHA, ListStyleType.UPPER_GREEK, ListStyleType.UPPER_LATIN et FormatValue.INHERIT. La valeur par défaut est undefined, ce qui indique qu’elle n’est pas définie. Si lors de la propagation en cascade, la valeur est undefined, cette propriété héritera ses valeurs d’un ancêtre.	FlowElement
		locale : * TextLayoutFormat : paramètres régionaux du texte.	FlowElement
		mxmlChildren : Array Ajoute un tableau d’enfants à cet objet.	FlowGroupElement
		numChildren : int [lecture seule] Renvoie le nombre d’enfants FlowElement que possède cet objet FlowGroupElement.	FlowGroupElement
		paddingBottom : * TextLayoutFormat : encart inférieur en pixels.	FlowElement
		paddingLeft : * TextLayoutFormat : encart à gauche en pixels.	FlowElement
		paddingRight : * TextLayoutFormat : encart à droite en pixels.	FlowElement
		paddingTop : * TextLayoutFormat : encart supérieur en pixels.	FlowElement
		paragraphEndIndent : * TextLayoutFormat : nombre qui indique, en pixels, la valeur de retrait du bord de la fin du paragraphe.	FlowElement
		paragraphSpaceAfter : * TextLayoutFormat : un nombre qui spécifie la quantité d’espace, en pixels, à laisser après le paragraphe.	FlowElement
		paragraphSpaceBefore : * TextLayoutFormat : nombre qui spécifie la quantité d’espace, en pixels, à conserver avant le paragraphe.	FlowElement
		paragraphStartIndent : * TextLayoutFormat : nombre qui indique, en pixels, la valeur de retrait du bord du début du paragraphe.	FlowElement
		parent : FlowGroupElement [lecture seule] Renvoie le parent de ce objet FlowElement.	FlowElement
		parentRelativeEnd : int [lecture seule] Renvoie la fin relative de cet objet FlowElement dans le parent.	FlowElement
		parentRelativeStart : int [lecture seule] Renvoie le début relatif de cet objet FlowElement dans le parent.	FlowElement
		renderingMode : * TextLayoutFormat : mode de rendu utilisé pour ce texte.	FlowElement
		styleName : * TextLayoutFormat : attribue une classe d’identification à l’élément, ce qui permet de définir le style de l’élément en référençant la propriété styleName.	FlowElement
		styles : Object [lecture seule] Renvoie les styles sur cet objet FlowElement.	FlowElement
		tabStops : * TextLayoutFormat : spécifie les taquets de tabulation associés au paragraphe.	FlowElement
		textAlign : * TextLayoutFormat : alignement des lignes du paragraphe par rapport au conteneur.	FlowElement
		textAlignLast : * TextLayoutFormat : alignement de la dernière (ou unique) ligne dans le paragraphe par rapport au conteneur dans un texte justifié.	FlowElement
		textAlpha : * TextLayoutFormat : valeur alpha (transparence) du texte.	FlowElement
		textDecoration : * TextLayoutFormat : décoration du texte.	FlowElement
		textIndent : * TextLayoutFormat : nombre qui indique la quantité, en pixels, pour mettre en retrait la première ligne du paragraphe.	FlowElement
		textJustify : * TextLayoutFormat : spécifie des options de justification de texte.	FlowElement
		textLength : int [lecture seule] Renvoie la longueur totale de texte administrée par cet objet FlowElement et ses enfants.	FlowElement
		textRotation : * TextLayoutFormat : détermine le nombre de degrés de rotation de ce texte.	FlowElement
		tracking : Object [écriture seule] Définit le suivi et est synonyme de la propriété trackingRight.	FlowElement
		trackingLeft : * TextLayoutFormat : nombre de pixels (ou pourcentage de taille fontSize, comme 120 %) indiquant la quantité de l’approche (crénage manuel) à appliquer à gauche de chaque caractère.	FlowElement
		trackingRight : * TextLayoutFormat : nombre de pixels (ou pourcentage de taille fontSize, comme 120 %) indiquant la quantité de l’approche (crénage manuel) à appliquer à droite de chaque caractère.	FlowElement
		typeName : String Chaque objet FlowElement a une propriété typeName.	FlowElement
		typographicCase : * TextLayoutFormat : le type de casse typographique utilisée pour ce texte.	FlowElement
		userStyles : Object Permet de lire les styles d’écriture de l’utilisateur sur un objet FlowElement.	FlowElement
		verticalAlign : * TextLayoutFormat : alignement vertical ou justification (adopte la valeur par défaut si undefined pendant la propagation en cascade).	FlowElement
		whiteSpaceCollapse : * TextLayoutFormat : réduit ou conserve les espaces lors de l’importation de texte dans un TextFlow.	FlowElement
		wordSpacing : * TextLayoutFormat : spécifie les espacements optimal, minimal et maximal (comme multiplicateur de la largeur d’un espace normal) entres les mots à utiliser lors de la justification.	FlowElement

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		FlowGroupElement() Classe de base : appeler un nouvel objet FlowGroupElement() renvoie une exception d’erreur.	FlowGroupElement
		addChild(child:FlowElement):FlowElement Ajoute un objet FlowElement objet.	FlowGroupElement
		addChildAt(index:uint, child:FlowElement):FlowElement Ajoute un objet FlowElement enfant à la position d’index spécifiée.	FlowGroupElement
		clearStyle(styleProp:String):void Supprime le style spécifié par le paramètre styleProp à partir de cet objet FlowElement.	FlowElement
		deepCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement Effectue une copie en profondeur de cette objet FlowElement, y compris tout enfant, copiant le contenu entre les deux emplacements de caractère et renvoyant la copie en tant qu’objet FlowElement.	FlowElement
		equalUserStyles(otherElement:FlowElement):Boolean Comparez ces styles utilisateur avec les styles utilisateur d’autres éléments.	FlowElement
		findChildIndexAtPosition(relativePosition:int):int En fonction d’une position de texte relative, recherchez l’index du premier objet FlowElement enfant qui contient la position relative.	FlowGroupElement
		findLeaf(relativePosition:int):FlowLeafElement En fonction d’une position du texte relative, recherchez l’élément de nœud terminal qui contient la position.	FlowGroupElement
		getAbsoluteStart():int Renvoie l’emplacement de départ de l’élément dans l’enchaînement de texte avec un index absolu.	FlowElement
		getCharAtPosition(relativePosition:int):String Renvoie le caractère à la position spécifiée, par rapport à cet objet FlowElement.	FlowElement
		getCharCodeAtPosition(relativePosition:int):int Renvoie le code de caractère à la position spécifiée, par rapport à cet objet FlowElement.	FlowElement
		getChildAt(index:int):FlowElement Renvoie l’enfant de l’objet FlowElement à l’index spécifié.	FlowGroupElement
		getChildIndex(child:FlowElement):int Recherche dans les enfants pour l’objet FLowElement et renvoie sa position d’index.	FlowGroupElement
		getElementRelativeStart(ancestorElement:FlowElement):int Renvoie la valeur de début de cet élément par rapport à l’élément ancêtre.	FlowElement
		getFirstLeaf():FlowLeafElement Renvoie le premier objet FlowLeafElement descendant de ce groupe.	FlowGroupElement
		getLastLeaf():FlowLeafElement Renvoie le dernier objet FlowLeafElement descendant de ce groupe.	FlowGroupElement
		getNextSibling():FlowElement Renvoie le prochain objet FlowElement frère dans la hiérarchie de l’enchaînement de texte.	FlowElement
		getParagraph():ParagraphElement Renvoie l’objet ParagraphElement associé à cet élément.	FlowElement
		getPreviousSibling():FlowElement Renvoie l’objet FlowElement frère précédent dans la hiérarchie de l’enchaînement de texte.	FlowElement
		getStyle(styleProp:String):* Renvoie la valeur du style spécifié par le paramètre styleProp, qui spécifie le nom du style et peut être n’importe quel nom de style d’utilisateur.	FlowElement
		getText(relativeStart:int = 0, relativeEnd:int = -1, paragraphSeparator:String = " "):String [override]	FlowGroupElement
		getTextFlow():flashx.textLayout.elements:TextFlow Gravit la hiérarchie de l’enchaînement de texte pour renvoyer l’objet TextFlow racine pour l’élément.	FlowElement
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		initialized(document:Object, id:String):void Appelé pour des objets MXML une fois que l’objet d’implémentation a été créé et que toutes les propriétés de composants spécifiées sur la balise MXML ont été initialisées.	FlowElement
		isPrototypeOf(theClass:Object):Boolean 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
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		removeChild(child:FlowElement):FlowElement Supprime l’objet FlowElement enfant spécifié du groupe.	FlowGroupElement
		removeChildAt(index:uint):FlowElement Supprime l’objet FlowElement enfant de la position d’index spécifiée.	FlowGroupElement
		replaceChildren(beginChildIndex:int, endChildIndex:int, ... rest):void Remplace les éléments enfant dans le groupe avec les nouveaux éléments spécifiés.	FlowGroupElement
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		setStyle(styleProp:String, newValue:*):void Définit le style spécifié par le paramètre styleProp à la valeur spécifiée par le paramètre newValue.	FlowElement
		shallowCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement Effectue une copie de cet objet FlowElement, copie le contenu entre deux positions de caractères spécifiées.	FlowElement
		splitAtIndex(childIndex:int):FlowGroupElement Divise cet objet à la position spécifiée par le paramètre childIndex.	FlowGroupElement
		splitAtPosition(relativePosition:int):FlowElement Divise cet objet FlowElement à la position spécifiée par le paramètre relativePosition, qui est une position relative dans le texte pour cet élément.	FlowElement
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object

Détails de la propriété

mxmlChildren

propriété

mxmlChildren:Array

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Ajoute un tableau d’enfants à cet objet. Utilise la méthode replaceChildren() pour ajouter chaque élément du tableau. Conçu pour être utilisé au cours d’une importation compilée mxml.

Implémentation
public function get mxmlChildren():Array
public function set mxmlChildren(value:Array):void

Valeur émise

TypeError — si l’élément array n’est pas un objet FlowElement ou String

Eléments de l’API associés

FlowGroupElement.replaceChildren()

numChildren

propriété

numChildren:int [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie le nombre d’enfants FlowElement que possède cet objet FlowGroupElement.

Implémentation
public function get numChildren():int

Détails du constructeur

()

Constructeur

public function FlowGroupElement()

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Classe de base : appeler une nouvelle classe FlowGroupElement() renvoie une exception d’erreur.

Détails de la méthode

addChild

()

méthode

public function addChild(child:FlowElement):FlowElement

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Ajoute un objet FlowElement enfant. Le nouvel enfant est ajouté à la fin de la liste des enfants.

Paramètres

child:FlowElement — L’élément enfant à ajouter.

Valeur renvoyée

FlowElement — L’enfant FlowElement ajouté

Exemple ( Comment utiliser cet exemple )

Cet exemple appelle la méthode addChild() pour ajouter une plage à un paragraphe et le paragraphe à l’enchaînement de texte.

package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_addChildExample extends Sprite
    {        
        public function FlowGroupElement_addChildExample()
        {
            // create string for text flow
            var simpleText:String = "It was a dark and stormy night.";        
                    
            // define TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();            
            var paragraph:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement;
            span.text = simpleText;
            // add span to paragraph and add paragraph to text flow
            paragraph.addChild(span);
            textFlow.addChild(paragraph);
            // assign composer and controller and update controller to display text
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

addChildAt

()

méthode

public function addChildAt(index:uint, child:FlowElement):FlowElement

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Ajoute un objet FlowElement enfant à la position d’index spécifiée.

Paramètres

	`index:uint` — L’index de la position à laquelle ajouter l’élément enfant, la première position étant 0.

	`child:FlowElement` — L’élément enfant à ajouter.

Valeur renvoyée

FlowElement — L’enfant FlowElement ajouté

Valeur émise

RangeError — L’index est hors limite.

Exemple ( Comment utiliser cet exemple )

Cet exemple appelle addChildAt pour ajouter trois plages à un paragraphe.

package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_addChildAtExample extends Sprite
    {        
        public function FlowGroupElement_addChildAtExample()
        {
            // define text strings for the contents of the text flow
            var textA:String = "It was a dark and stormy night. ";
            var textB:String = "The quick red fox jumped over the lazy brown dog. ";
            var textC:String = "Mary had a little lamb. ";
            // define TextFlow, ParagraphElement and SpanElement objects
            var textFlow:TextFlow = new TextFlow();            
            var paragraph:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            var span3:SpanElement = new SpanElement();
            span1.text = textA;
            span2.text = textB;
            span3.text = textC;
            // add spans at specified positions
            paragraph.addChildAt(0, span2);
            paragraph.addChildAt(0, span1);
            paragraph.addChildAt(1, span3);
            textFlow.addChild(paragraph);
            // assign composer, controller, and update to display text
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

findChildIndexAtPosition

()

méthode

public function findChildIndexAtPosition(relativePosition:int):int

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

En fonction d’une position de texte relative, recherchez l’index du premier objet FlowElement enfant qui contient la position relative. Plusieurs enfants peuvent contenir la position relative en raison de la longueur zéro des objets FlowElement.

Examinez les enfants pour trouver l’objet FlowElement qui contient la position relative. La position relative fournie est relative à cet objet FlowElement.

Paramètres

relativePosition:int — la position relative à cet élément.

Valeur renvoyée

int — index du premier élément enfant contenant relativePosition

Exemple ( Comment utiliser cet exemple )

Cet exemple recherche l’index de l’enfant à une position relative dans le texte et définit sa couleur sur rouge.

    
package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_findChildIndexAtPositionExample extends Sprite
    {        
        public function FlowGroupElement_findChildIndexAtPositionExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p>"+
                        "<flow:span id='span1'>It was a dark and stormy night.</flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Peter Piper picked a </flow:span>"+
                        "<flow:span fontStyle=\"italic\"> peck </flow:span>"+
                        "<flow:span>of pickle peppers.</flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // add composer and controller
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            // find the index of the child containing relative offset 21; set color to red
            var index:int = textFlow.findChildIndexAtPosition(21);
            textFlow.getChildAt(index).color = 0xFF0000;
            // display text
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

findLeaf

()

méthode

public function findLeaf(relativePosition:int):FlowLeafElement

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

En fonction d’une position du texte relative, recherchez l’élément de nœud terminal qui contient la position.

Recherche vers le bas dans la hiérarchie pour trouver la classe FlowLeafElement qui contient la position spécifiée. La position spécifiée est relative à cet objet FlowElement.

Paramètres

relativePosition:int — index de texte relatif à rechercher.

Valeur renvoyée

FlowLeafElement — l’élément de nœud terminal contenant la position relative.

Exemple ( Comment utiliser cet exemple )

Cet exemple crée deux paragraphes, localise FlowLeafElement à la position relative 55 et définit sa couleur sur rouge.

package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_findLeafExample extends Sprite
    {        
        public function FlowGroupElement_findLeafExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p>"+
                        "<flow:span>It was a dark and stormy night</flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Peter Piper picked a </flow:span>"+
                        "<flow:span fontStyle=\"italic\"> peck </flow:span>"+
                        "<flow:span>of pickle peppers.</flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // add composer and controller
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            // find the FlowLeafElement object containing relative offset 55; set color to red
            var leaf:SpanElement = textFlow.findLeaf(55) as SpanElement;
            leaf.color = 0xFF0000;
            // display text
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

getChildAt

()

méthode

public function getChildAt(index:int):FlowElement

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie l’enfant de l’objet FlowElement à l’index spécifié.

Paramètres

index:int — la position à laquelle rechercher l’objet FlowElement.

Valeur renvoyée

FlowElement — l’objet FlowElement enfant à la position spécifiée.

Exemple ( Comment utiliser cet exemple )

Cet exemple utilise la méthode getChildAt() pour accéder à un paragraphe de l’enchaînement de texte et modifier la couleur de l’une de ses plages en rouge.

    
package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_getChildAtExample extends Sprite
    {        
        public function FlowGroupElement_getChildAtExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p>"+
                        "<flow:span id='span1'>It was a dark and stormy night.</flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Peter Piper picked a </flow:span>"+
                        "<flow:span fontStyle=\"italic\"> peck </flow:span>"+
                        "<flow:span>of pickle peppers.</flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // add composer and controller
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            // find the paragraph at index position 1
            var para:ParagraphElement = textFlow.getChildAt(1) as ParagraphElement;
            // find the span at index position 1 of the paragraph and color it red
            para.getChildAt(1).color = 0xFF0000;
            // display text
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

getChildIndex

()

méthode

public function getChildIndex(child:FlowElement):int

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Recherche dans les enfants pour l’objet FLowElement et renvoie sa position d’index.

Paramètres

child:FlowElement — L’élément de l’objet FlowElement à localiser parmi les enfants.

Valeur renvoyée

int — La position d’index de l’enfant spécifié. Si l’enfant est introuvable, renvoie -1.

getFirstLeaf

()

méthode

public function getFirstLeaf():FlowLeafElement

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie le premier objet FlowLeafElement descendant de ce groupe.

Valeur renvoyée

FlowLeafElement — le premier objet FlowLeafElement.

Exemple ( Comment utiliser cet exemple )

Cet exemple crée deux paragraphes, recherche le premier objet FlowLeafElement et définit sa couleur sur rouge.

        
package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_getFirstLeafExample extends Sprite
    {        
        public function FlowGroupElement_getFirstLeafExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p>"+
                        "<flow:span>It was a </flow:span>"+
                        "<flow:span fontStyle=\"italic\">dark and stormy</flow:span>"+
                        "<flow:span> night.</flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Peter Piper picked a peck of pickle peppers. </flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // get first FlowLeafElement object and set its color to red
            var leaf:SpanElement = textFlow.getFirstLeaf() as SpanElement;
            leaf.color = 0xFF0000;
            // add composer and controller and update controller to display text
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

getLastLeaf

()

méthode

public function getLastLeaf():FlowLeafElement

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie le dernier objet FlowLeafElement descendant de ce groupe.

Valeur renvoyée

FlowLeafElement — le dernier objet FlowLeafElement.

Exemple ( Comment utiliser cet exemple )

Cet exemple crée deux paragraphes, recherche le dernier objet FlowLeafElement et définit sa couleur sur rouge.

    
package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_getLastLeafExample extends Sprite
    {        
        public function FlowGroupElement_getLastLeafExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p>"+
                        "<flow:span>It was a dark and stormy night</flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Peter Piper picked a </flow:span>"+
                        "<flow:span fontStyle=\"italic\"> peck </flow:span>"+
                        "<flow:span>of pickle peppers.</flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // add composer and controller
            textFlow.flowComposer.addController(new ContainerController(this,600,600));
            //find last leaf, set its color to red and display text
            var leaf:SpanElement = textFlow.getLastLeaf() as SpanElement;
            leaf.color = 0xFF0000;
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

getText

()

méthode

override public function getText(relativeStart:int = 0, relativeEnd:int = -1, paragraphSeparator:String = " "):String

Paramètres

	`relativeStart:int` (default = `0`)

	`relativeEnd:int` (default = `-1`)

	`paragraphSeparator:String` (default = " ")

Valeur renvoyée

String

removeChild

()

méthode

public function removeChild(child:FlowElement):FlowElement

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Supprime l’objet FlowElement enfant spécifié du groupe.

Paramètres

child:FlowElement — L’élément enfant à supprimer

Valeur renvoyée

FlowElement — L’objet FlowElement enfant supprimé

Valeur émise

ArgumentError — L’enfant est introuvable.

Exemple ( Comment utiliser cet exemple )

Cet exemple supprime la troisième plage du deuxième paragraphe de l’enchaînement de texte.

        
package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_removeChildExample extends Sprite
    {        
        public function FlowGroupElement_removeChildExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p id='para1'>"+
                        "<flow:span id='span1'>It was a dark and stormy night.</flow:span>"+
                    "</flow:p>"+
                    "<flow:p id='para2'>"+
                        "<flow:span id='span2'>Peter Piper picked a </flow:span>"+
                        "<flow:span id='span3' fontStyle=\"italic\"> peck </flow:span>"+
                        "<flow:span id='span4'>of pickle peppers.</flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // add composer and controller
            textFlow.flowComposer.addController(new ContainerController(this,600,600));
            // get paragraph with ID = 'para2' and remove its child with name = 'span4'
            var parent:ParagraphElement = textFlow.getElementByID("para2") as ParagraphElement;
            parent.removeChild(textFlow.getElementByID("span4"));
            // update controller to display text
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

removeChildAt

()

méthode

public function removeChildAt(index:uint):FlowElement

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Supprime l’objet FlowElement enfant de la position d’index spécifiée.

Paramètres

index:uint — position à partir de laquelle supprimer l’élément enfant.

Valeur renvoyée

FlowElement — l’objet FlowElement enfant supprimé de la position spécifiée.

Valeur émise

RangeError — L’index est hors limite.

Exemple ( Comment utiliser cet exemple )

Cet exemple appelle la méthode removeChildAt() pour supprimer le deuxième des trois paragraphes.

package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_removeChildAtExample extends Sprite
    {        
        public function FlowGroupElement_removeChildAtExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p>"+
                        "<flow:span>It was a dark and stormy night. </flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Peter Piper picked a peck of pickle peppers. </flow:span>"+
                    "</flow:p>"+
                    "<flow:p>"+
                        "<flow:span>Mary had a little lamb. </flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
                    
            // define TextFlow, import text, add composer and controller 
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            textFlow.flowComposer.addController(new ContainerController(this,200,200));
            // remove child at index position 1 (with first position = 0); display text
            textFlow.removeChildAt(1);
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

replaceChildren

()

méthode

public function replaceChildren(beginChildIndex:int, endChildIndex:int, ... rest):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Remplace les éléments enfant dans le groupe avec les nouveaux éléments spécifiés. Utilisez les paramètres beginChildIndex et endChildIndex pour diriger l’opération comme suit :

Pour supprimer des éléments, ne transmettez pas d’éléments de remplacement.
Pour insérer des éléments, transmettez les mêmes valeurs pour beginChildIndex et endChildIndex. Les nouveaux éléments sont insérés avant l’index spécifié.
Pour annexer des éléments, transmettez le paramètre numChildren pour les paramètres beginChildIndex et endChildIndex.

Dans le cas contraire, cette méthode remplace les éléments spécifiés, en commençant par l’élément à beginChildIndex et jusqu’à endChildIndex mais sans l’inclure.

Paramètres

	`beginChildIndex:int` — La valeur d’index pour la position de début de la plage de remplacement dans le tableau des enfants.

	`endChildIndex:int` — La valeur d’index pour la position de fin de la plage de remplacement dans le tableau des enfants.

	`... rest` — Les éléments à utiliser pour remplacer la plage d’éléments spécifiés. Peut être une séquence contenant des éléments d’enchaînement ou des tableaux ou des vecteurs qui y sont associés.

Valeur émise

RangeError — L’index beginChildIndex ou endChildIndex spécifié est hors limite.

Exemple ( Comment utiliser cet exemple )

Cet exemple remplace les trois plages dans le deuxième paragraphe par deux nouvelles.

package flashx.textLayout.elements.examples {    
    import flash.display.Sprite;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowGroupElement_replaceChildrenExample extends Sprite
    {        
        public function FlowGroupElement_replaceChildrenExample()
        {
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
                "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" editingMode=\"readWrite\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                    "<flow:p id='para1'>"+
                        "<flow:span id='span1'>It was a dark and stormy night.</flow:span>"+
                    "</flow:p>"+
                    "<flow:p id='para2'>"+
                        "<flow:span id='span2'>Peter Piper picked a </flow:span>"+
                        "<flow:span id='span3' fontStyle=\"italic\"> peck </flow:span>"+
                        "<flow:span id='span4'>of pickle peppers.</flow:span>"+
                    "</flow:p>"+
                "</flow:TextFlow>";
            
            // define TextFlow object and import xml markup
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // define two new SpanElement objects
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            span1.text = "Mary had a little lamb. ";
            span2.text = "And this little pig stayed home. ";
            // add composer and controller
            textFlow.flowComposer.addController(new ContainerController(this,200,600));
            // get paragraph with ID = 'para2' and replace its children with span1 and span2
            var parent:ParagraphElement = textFlow.getElementByID("para2") as ParagraphElement;
            parent.replaceChildren(0, 3, [span1, span2]);
            // update controller to display text
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

splitAtIndex

()

méthode

public function splitAtIndex(childIndex:int):FlowGroupElement

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Divise cet objet à la position spécifiée par le paramètre childIndex. Si cet élément de groupe a un parent, il crée une copie simple de cet objet et remplace ses enfants par les éléments jusqu’à l’index. Déplace les éléments suivant le paramètre childIndex dans la copie.

Paramètres

childIndex:int

Valeur renvoyée

FlowGroupElement — le nouvel objet FlowGroupElement.

Valeur émise

RangeError — si childIndex est supérieur à la longueur des enfants.

Informations juridiques | Politique de confidentialité en ligne

FlowGroupElement - AS3

Packagesx

Eléments du langage

Annexes

Package flashx.textLayout.elements

mxmlChildren

numChildren