FlowComposerBase

Package	flashx.textLayout.compose
Classe	public class FlowComposerBase
Héritage	FlowComposerBase Object
Sous-classes	StandardFlowComposer

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La classe FlowComposerBase est la classe de base des classes du compositeur d’enchaînements Text Layout Framework, qui contrôlent la composition des lignes de texte dans les objets ContainerController.

FlowComposerBase est une classe d’utilitaires qui implémente des méthodes et des propriétés communes à plusieurs types de compositeur de flux. Le code de l’application n’instancie ou n’utilise généralement pas cette classe (sauf s’il l’étend pour créer un compositeur de flux personnalisé).

Eléments de l’API associés

flashx.textLayout.elements.TextFlow.flowComposer

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
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		damageAbsoluteStart : int [lecture seule] Position absolue qui précède immédiatement le premier élément du flux de texte devant être composé et mis à jour.	FlowComposerBase
		numLines : int [lecture seule] Nombre total de lignes composées dans le flux.	FlowComposerBase
		swfContext : ISWFContext L’occurrence ISWFContext utilisée pour effectuer des appels FTE le cas échéant.	FlowComposerBase
		textFlow : flashx.textLayout.elements:TextFlow [lecture seule] Objet TextFlow auquel le compositeur de flux est associé.	FlowComposerBase

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		FlowComposerBase() Constructeur.	FlowComposerBase
		damage(startPosition:int, damageLength:int, damageType:String):void Marquer des lignes comme endommagées et nécessitant une recomposition.	FlowComposerBase
		findLineAtPosition(absolutePosition:int, preferPrevious:Boolean = false):flashx.textLayout.compose:TextFlowLine Renvoie l’objet TextFlowLine renfermant le contenu à la position spécifiée.	FlowComposerBase
		findLineIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int Renvoie le numéro de ligne séquentiel de l’objet TextFlowLine renfermant le contenu à la position spécifiée.	FlowComposerBase
		getLineAt(index:int):flashx.textLayout.compose:TextFlowLine Renvoie la ligne avec le numéro de ligne spécifié.	FlowComposerBase
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		isDamaged(absolutePosition:int):Boolean Indique si des objets TextFlowLine entre le début du flux et la ligne renfermant le contenu à la position spécifiée sont signalés comme étant endommagés.	FlowComposerBase
		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
		updateLengths(startPosition:int, deltaLength:int):void Mettez à jour les longueurs dans les lignes pour conserver la correspondance de l’objet TextFlow.	FlowComposerBase
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object

Détails de la propriété

damageAbsoluteStart

propriété

damageAbsoluteStart:int [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Position absolue qui précède immédiatement le premier élément du flux de texte devant être composé et mis à jour.

Implémentation
public function get damageAbsoluteStart():int

numLines

propriété

numLines:int [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Nombre total de lignes composées dans le flux. Par défaut, TLF ne compose pas l’ensemble du flux et cette valeur peut être inexacte. Utilisez composeToPosition pour composer toutes les lignes.

Implémentation
public function get numLines():int

swfContext

propriété

swfContext:ISWFContext

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

L’occurrence ISWFContext utilisée pour effectuer des appels FTE le cas échéant.

Par défaut, l’implémentation ISWFContext est cet objet FlowComposerBase. Les applications peuvent fournir une implémentation personnalisée pour utiliser des polices intégrées dans un autre fichier SWF ou pour mettre en mémoire cache et réutiliser des lignes de texte.

Implémentation
public function get swfContext():ISWFContext
public function set swfContext(value:ISWFContext):void

Eléments de l’API associés

flashx.textLayout.compose.ISWFContext

textFlow

propriété

textFlow:flashx.textLayout.elements:TextFlow [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Objet TextFlow auquel le compositeur de flux est associé.

Implémentation
public function get textFlow():flashx.textLayout.elements:TextFlow

Eléments de l’API associés

flashx.textLayout.elements.TextFlow

Détails du constructeur

()

Constructeur

public function FlowComposerBase()

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Constructeur.

Détails de la méthode

damage

()

méthode

public function damage(startPosition:int, damageLength:int, damageType:String):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Marquer des lignes comme endommagées et nécessitant une recomposition.

Paramètres

	`startPosition:int` — début de la plage à endommager

	`damageLength:int` — nombre de caractères à endommager

	`damageType:String` — type de dommage. Une des classes flashx.textLayout.compose.FlowDamageType

findLineAtPosition

()

méthode

 public function findLineAtPosition(absolutePosition:int, preferPrevious:Boolean = false):flashx.textLayout.compose:TextFlowLine

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie l’objet TextFlowLine renfermant le contenu à la position spécifiée.

Une position peut être considérée comme étant la division entre deux caractères ou d’autres éléments d’un flux de texte. Si la valeur dans absolutePosition correspond à une position située entre le dernier élément d’une ligne et le premier élément de la ligne suivante, alors la ligne précédente est renvoyée si le paramètre preferPrevious est défini sur true et la dernière ligne est renvoyée si le paramètre preferPrevious est défini sur false.

Paramètres

	`absolutePosition:int` — Position du contenu pour lequel vous voulez obtenir l’objet TextFlowLine.

	`preferPrevious:Boolean` (default = `false`) — Spécifie la ligne à renvoyer lorsque la position se situe entre le dernier élément d’une ligne et le premier élément de la ligne suivante.

Valeur renvoyée

flashx.textLayout.compose:TextFlowLine — Objet TextFlowLine renfermant le contenu à la position spécifiée ou valeur null s’il est introuvable.

findLineIndexAtPosition

()

méthode

public function findLineIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie le numéro de ligne séquentiel de l’objet TextFlowLine renfermant le contenu à la position spécifiée.

Le numéro de la première ligne est 0 et celui de la dernière ligne est égal au nombre de lignes moins un. Si la position spécifiée dans absolutePosition se trouve au-delà de la fin de l’enchaînement de texte, cette méthode doit renvoyer le numéro qui sera affecté à la prochaine nouvelle ligne ajoutée à l’enchaînement de texte (qui est égal au nombre de lignes).

Une position peut être considérée comme étant la division entre deux caractères ou d’autres éléments d’un flux de texte. Si la valeur dans absolutePosition correspond à une position située entre la dernière ligne d’un conteneur et la première ligne du suivant, alors le conteneur précédent est renvoyé si le paramètre preferPrevious est défini sur true et le dernier conteneur est renvoyé si le paramètre preferPrevious est défini sur false.

Paramètres

	`absolutePosition:int` — Position du contenu pour lequel vous voulez obtenir la ligne de texte.

	`preferPrevious:Boolean` (default = `false`) — Spécifie l’index du conteneur à renvoyer lorsque la position se situe entre la dernière ligne d’un conteneur et la première ligne du conteneur suivant.

Valeur renvoyée

int — Index de la ligne de texte à la position spécifiée. S’il est introuvable, le considère comme au-delà de la fin et renvoie le nombre de lignes.

getLineAt

()

méthode

public function getLineAt(index:int):flashx.textLayout.compose:TextFlowLine

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie la ligne avec le numéro de ligne spécifié.

La liste des lignes est numérotée de zéro au nombre de lignes moins un. Si la valeur dans index n’est pas dans les limites de la liste des lignes, cette fonction renvoie la valeur null.

Paramètres

index:int — Numéro de ligne de l’objet TextFlowLine à renvoyer.

Valeur renvoyée

flashx.textLayout.compose:TextFlowLine — Objet TextFlowLine doté du numéro de ligne spécifié ou valeur null s’il est introuvable.

isDamaged

()

méthode

public function isDamaged(absolutePosition:int):Boolean

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Indique si des objets TextFlowLine entre le début du flux et la ligne renfermant le contenu à la position spécifiée sont signalés comme étant endommagés.

Paramètres

absolutePosition:int — Dernière position dans la zone ciblée

Valeur renvoyée

Boolean — La valeur est true si un des objets TextFlowLine entre le début de l’enchaînement jusqu’à la ligne renfermant le contenu à la position absolutePosition sont signalés comme étant endommagés.

updateLengths

()

méthode

public function updateLengths(startPosition:int, deltaLength:int):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Mettez à jour les longueurs dans les lignes pour conserver la correspondance de l’objet TextFlow.

Paramètres

	`startPosition:int` — Début de modification en longueur.

	`deltaLength:int` — Changement du nombre de caractères.

Informations juridiques | Politique de confidentialité en ligne

FlowComposerBase - AS3

Packagesx

Eléments du langage

Annexes

Package flashx.textLayout.compose

damageAbsoluteStart

numLines

swfContext

textFlow