TextFlowLine

Package	flashx.textLayout.compose
Classe	public final class TextFlowLine
Héritage	TextFlowLine Object
Implémente	IVerticalJustificationLine

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La classe TextFlowLine représente une seule ligne de texte dans un enchaînement de texte.

Utilisez cette classe pour accéder à des informations sur la façon dont une ligne de texte a été composée : position, hauteur, largeur et ainsi de suite. Lorsque l’enchaînement de texte (TextFlow) est modifié, les lignes immédiatement avant et sur le site de la modification sont marquées comme non valides car elles doivent être recomposées. Les lignes après le site de la modification peuvent ne pas être endommagées immédiatement, mais elles pourraient être régénérées lorsque le texte est composé. Vous pouvez accéder à une classe TextFlowLine endommagée, mais les valeurs auxquelles vous accédez reflétent l’ancien état de l’objet TextFlow. Lorsque l’objet TextFlow est recomposé, il génère de nouvelles lignes et vous pouvez extraire la nouvelle ligne pour une position donnée en appelant TextFlow.flowComposer.findLineAtPosition().

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
		absoluteStart : int [lecture seule] L’emplacement de la ligne comme une position de caractère absolu dans l’objet TextFlow.	TextFlowLine
		ascent : Number [lecture seule] Spécifie le nombre de pixels séparant la ligne de base du haut des plus grands caractères de la ligne.	TextFlowLine
		columnIndex : int [lecture seule] Le numéro de la colonne dans laquelle la ligne a été importée, la première colonne étant 0.	TextFlowLine
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		controller : ContainerController [lecture seule] Le contrôleur (objet ContainerController) pour le conteneur dans lequel la ligne a été importée.	TextFlowLine
		descent : Number [lecture seule] Spécifie le nombre de pixels séparant la ligne de base du bas des caractères descendants les plus bas de la ligne.	TextFlowLine
		height : Number [lecture seule] Largeur de la ligne, en pixels.	TextFlowLine
		lineOffset : Number [lecture seule] Le décalage de la ligne en pixels dans l’encart du conteneur approprié (conforme au sens du paragraphe et à la progression du bloc de conteneur), avant l’alignement des lignes du paragraphe.	TextFlowLine
		location : int [lecture seule] L’une des valeurs de l’objet TextFlowLineLocation pour spécifier l’emplacement d’une ligne au sein d’un paragraphe.	TextFlowLine
		paragraph : ParagraphElement [lecture seule] Le paragraphe (ParagraphElement) dans lequel la ligne réside.	TextFlowLine
		spaceAfter : Number [lecture seule] La quantité d’espace à laisser après la ligne.	TextFlowLine
		spaceBefore : Number [lecture seule] La quantité d’espace à laisser avant la ligne.	TextFlowLine
		textHeight : Number [lecture seule] Hauteur de la ligne de texte, qui est égale à monter plus descendre.	TextFlowLine
		textLength : int [lecture seule] Nombre de caractères jusqu’à la ligne suivante, y compris les espaces.	TextFlowLine
		textLineExists : Boolean [lecture seule] Indique si l’objet flash.text.engine.TextLine pour cet objet TextFlowLine existe.	TextFlowLine
		unjustifiedTextWidth : Number [lecture seule] Largeur de la ligne si elle n’était pas justifiée.	TextFlowLine
		validity : String [lecture seule] Validité de la ligne.	TextFlowLine
		x : Number La position horizontale de la ligne par rapport à son conteneur, exprimée sous la forme du décalage en pixels à partir de la gauche du conteneur.	TextFlowLine
		y : Number La position verticale de la ligne par rapport à son conteneur, exprimée sous la forme du décalage en pixels à partir du haut du conteneur.	TextFlowLine

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		TextFlowLine(textLine:flash.text.engine:TextLine, paragraph:ParagraphElement, outerTargetWidth:Number = 0, lineOffset:Number = 0, absoluteStart:int = 0, numChars:int = 0) Constructeur : crée une nouvelle occurrence TextFlowLine.	TextFlowLine
		getBounds():Rectangle Renvoie les limites de la ligne sous forme de rectangle.	TextFlowLine
		getTextLine(forceValid:Boolean = false):flash.text.engine:TextLine Renvoie l’objet flash.text.engine.TextLine pour cette ligne, qui est peut-être recréée si elle n’existe pas en raison du nettoyage.	TextFlowLine
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		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
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		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é

absoluteStart

propriété

absoluteStart:int [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

L’emplacement de la ligne comme une position de caractère absolu dans l’objet TextFlow.

Implémentation
public function get absoluteStart():int

Eléments de l’API associés

flashx.textLayout.elements.TextFlow

ascent

propriété

ascent:Number [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Spécifie le nombre de pixels séparant la ligne de base du haut des plus grands caractères de la ligne. Dans le cas d’un TextLine contenant uniquement un élément graphique, ascent est défini sur 0.

Implémentation
public function get ascent():Number

columnIndex

propriété

columnIndex:int [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Le numéro de la colonne dans laquelle la ligne a été importée, la première colonne étant 0.

Implémentation
public function get columnIndex():int

controller

propriété

controller:ContainerController [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Le contrôleur (objet ContainerController) pour le conteneur dans lequel la ligne a été importée.

Implémentation
public function get controller():ContainerController

Eléments de l’API associés

flashx.textLayout.container.ContainerController

descent

propriété

descent:Number [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Spécifie le nombre de pixels séparant la ligne de base du bas des caractères descendants les plus bas de la ligne. Dans le cas d’un TextLine contenant uniquement un élément graphique, descent est défini sur 0.

Implémentation
public function get descent():Number

height

propriété

height:Number [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Largeur de la ligne, en pixels.

Implémentation
public function get height():Number

lineOffset

propriété

lineOffset:Number [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Le décalage de la ligne en pixels dans l’encart du conteneur approprié (conforme au sens du paragraphe et à la progression du bloc de conteneur), avant l’alignement des lignes du paragraphe.

Implémentation
public function get lineOffset():Number

location

propriété

location:int [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

L’une des valeurs de l’objet TextFlowLineLocation pour spécifier l’emplacement d’une ligne au sein d’un paragraphe.

Implémentation
public function get location():int

Eléments de l’API associés

flashx.textLayout.elements.ParagraphElement
TextFlowLineLocation

paragraph

propriété

paragraph:ParagraphElement [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Le paragraphe (ParagraphElement) dans lequel la ligne réside.

Implémentation
public function get paragraph():ParagraphElement

Eléments de l’API associés

flashx.textLayout.elements.ParagraphElement

spaceAfter

propriété

spaceAfter:Number [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La quantité d’espace à laisser après la ligne.

Si la ligne est la dernière ligne d’un paragraphe qui possède une marge inférieure, la ligne a une valeur spaceAfter. Si la ligne est au bas d’une colonne, alors la valeur spaceAfter est ignorée. Dans le cas contraire, la ligne vient devant une autre ligne de la colonne et la ligne suivante doit être positionnée verticalement pour s’assurer qu’il y a au moins cette quantité d’espace entre la dernière ligne du paragraphe et la première ligne du paragraphe suivant.

Implémentation
public function get spaceAfter():Number

Eléments de l’API associés

TextLayoutFormat.paragraphSpaceAfter

spaceBefore

propriété

spaceBefore:Number [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La quantité d’espace à laisser avant la ligne.

Si la ligne est la première ligne d’un paragraphe qui possède une marge supérieure, la ligne a une valeur spaceBefore. Si la ligne est en haut d’une colonne, alors la valeur spaceBefore est ignorée. Dans le cas contraire, la ligne suit une autre ligne dans la colonne et elle est placée verticalement pour s’assurer qu’il y a au moins cette quantité d’espace entre la ligne et la dernière ligne du paragraphe précédent.

Implémentation
public function get spaceBefore():Number

Eléments de l’API associés

TextLayoutFormat.paragraphSpaceBefore

textHeight

propriété

textHeight:Number [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Hauteur de la ligne, qui est égale à monter plus descendre. La valeur est calculée à partir de la différence entre les lignes de base qui limitent la ligne, soit sur base idéographique en haut et en bas ou monter et descendre, selon si la ligne de base au niveau y=0 est idéographique (par exemple, TextBaseline.IDEOGRAPHIC_TOP) ou non.

Implémentation
public function get textHeight():Number

Eléments de l’API associés

TextBaseline

textLength

propriété

textLength:int [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Nombre de caractères jusqu’à la ligne suivante, y compris les espaces.

Implémentation
public function get textLength():int

textLineExists

propriété

textLineExists:Boolean [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Indique si l’objet flash.text.engine.TextLine pour cet objet TextFlowLine existe. La valeur est true si l’objet TextLine n’a pas été nettoyé et false s’il l’a été.

Implémentation
public function get textLineExists():Boolean

Eléments de l’API associés

TextLine

unjustifiedTextWidth

propriété

unjustifiedTextWidth:Number [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Largeur de la ligne si elle n’était pas justifiée. Pour du texte non justifié, cette valeur est la même que la valeur textLength. Pour du texte justifié, cette valeur est ce que la longueur aurait été sans justification et la valeur textLength représente la largeur réelle de la ligne. Par exemple, lorsque la chaîne suivante est justifiée et qu’une largeur de 500 lui est affectée, sa largeur réelle est de 500, mais d’une largeur non justifiée de 268,9921875.

Implémentation
public function get unjustifiedTextWidth():Number

validity

propriété

validity:String [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Validité de la ligne.

Une ligne peut être non valide si le texte, les attributs qui lui sont appliqués ou les paramètres du contrôleur ont été modifiés depuis la création de la ligne. Une ligne peut cependant être affichée et vous pouvez l’utiliser, mais les valeurs utilisées seront les valeurs de l’heure de création. La ligne renvoyée par l’objet getTextLine() sera également dans un état non valide.

Implémentation
public function get validity():String

Eléments de l’API associés

getTextLine()
TextLine.validity
FlowDamageType.GEOMETRY

x

propriété

x:Number

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La position horizontale de la ligne par rapport à son conteneur, exprimée sous la forme du décalage en pixels à partir de la gauche du conteneur.

Remarque : bien que cette propriété soit techniquement de type lecture-écriture, vous devez la traiter comme une propriété en lecture seule. L’accesseur Set existe uniquement pour satisfaire aux exigences de l’interface IVerticalJustificationLine qui définit les accesseurs Get et Set pour cette propriété. L’utilisation de l’accesseur Set, bien que possible, entraîne des résultats imprévisibles.

Implémentation
public function get x():Number
public function set x(value:Number):void

Eléments de l’API associés

y

propriété

y:Number

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La position verticale de la ligne par rapport à son conteneur, exprimée sous la forme du décalage en pixels à partir du haut du conteneur.

Implémentation
public function get y():Number
public function set y(value:Number):void

Eléments de l’API associés

Détails du constructeur

()

Constructeur

public function TextFlowLine(textLine:flash.text.engine:TextLine, paragraph:ParagraphElement, outerTargetWidth:Number = 0, lineOffset:Number = 0, absoluteStart:int = 0, numChars:int = 0)

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Constructeur : crée une nouvelle occurrence TextFlowLine.

Remarque : aucun client ne devrait l’appeler. Il est exposé pour l’écriture de votre propre compositeur.

Paramètres

	`textLine:flash.text.engine:TextLine` — L’objet d’affichage TextLine à utiliser pour cette ligne.

	`paragraph:ParagraphElement` — Le paragraphe (ParagraphElement) dans lequel placer la ligne.

	`outerTargetWidth:Number` (default = `0`) — La largeur sur laquelle la ligne est composée, à l’exception des marges et des retraits.

	`lineOffset:Number` (default = `0`) — Le décalage de la ligne en pixels dans l’encart du conteneur approprié (conforme au sens du paragraphe et à la progression du bloc de conteneur), avant l’alignement des lignes du paragraphe.

	`absoluteStart:int` (default = `0`) — La position des caractères dans l’enchaînement de texte à laquelle la ligne commence.

	`numChars:int` (default = `0`) — Nombre de caractères dans la ligne.

Eléments de l’API associés

flash.text.engine.TextLine
flashx.textLayout.elements.ParagraphElement
absoluteStart

Détails de la méthode

getBounds

()

méthode

public function getBounds():Rectangle

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie les limites de la ligne sous forme de rectangle.

Valeur renvoyée

Rectangle — un rectangle qui représente les limites de la ligne.

getTextLine

()

méthode

public function getTextLine(forceValid:Boolean = false):flash.text.engine:TextLine

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie l’objet flash.text.engine.TextLine pour cette ligne, qui est peut-être recréée si elle n’existe pas en raison du nettoyage. Définissez forceValid sur true pour entraîner la recréation de la classe TextLine. Renvoie la valeur null si la classe TextLine ne peut pas être recréée.

Paramètres

forceValid:Boolean (default = false) — Si la valeur est true, la classe TextLine est recréée, si elle existe mais n’est pas valide.

Valeur renvoyée

flash.text.engine:TextLine — objet pour cette ligne ou null si l’objet TextLine ne peut pas être recréé.

Eléments de l’API associés

TextLine

Informations juridiques | Politique de confidentialité en ligne

TextFlowLine - AS3

Packagesx

Eléments du langage

Annexes

Package flashx.textLayout.compose

absoluteStart

ascent

columnIndex

controller

descent

height

lineOffset

location

paragraph

spaceAfter

spaceBefore

textHeight

textLength

textLineExists

unjustifiedTextWidth

validity

x

y

TextFlowLine

getBounds

getTextLine