TextContainerManager

Package	flashx.textLayout.container
Classe	public class TextContainerManager
Héritage	TextContainerManager EventDispatcher Object
Implémente	ISWFContext, IInteractionEventHandler, ISandboxSupport

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Gère le texte dans un conteneur. Suppose qu’il gère tous les enfants du conteneur. Pensez à utiliser TextContainerManager pour améliorer les performances dans les cas où il existe un conteneur par TextFlow et le TextFlow n’est pas le focus principal, est un texte statique ou est rarement sélectionné. Utile pour le texte des champs de formulaire, par exemple.

Eléments de l’API associés

ContainerController

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
		compositionHeight : Number Renvoie l’étendue verticale autorisée pour du texte à l’intérieur du conteneur.	TextContainerManager
		compositionWidth : Number Renvoie l’étendue horizontale autorisée pour le texte à l’intérieur du conteneur.	TextContainerManager
		configuration : IConfiguration [lecture seule] L’objet Configuration pour cette occurrence TextContainerManager.	TextContainerManager
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		container : Sprite [lecture seule] Renvoie le conteneur (DisplayObjectContainer) qui contient le texte géré par l’occurrence TextContainerManager.	TextContainerManager
		defaultConfiguration : IConfiguration [statique] [lecture seule] La configuration par défaut pour cette occurrence TextContainerManager.	TextContainerManager
		editingMode : String Mode d’édition de cette occurrence TextContainerManager.	TextContainerManager
		horizontalScrollPolicy : String Contrôle si la fabrique génère toutes les lignes de texte ou s’arrête lorsque les limites du conteneur sont atteintes. Spécifie les règles de défilement horizontal, que vous pouvez définir en affectant l’une des constantes de la classe ScrollPolicy : ON, OFF ou AUTO.	TextContainerManager
		horizontalScrollPosition : Number Spécifie l’emplacement de défilement horizontal actuel sur la scène.	TextContainerManager
		hostFormat : flashx.textLayout.formats:ITextLayoutFormat Définit le format lorsque l’affichage se limite à une chaîne.	TextContainerManager
		numLines : int [lecture seule] Nombre total de lignes composées dans le flux.	TextContainerManager
		swfContext : ISWFContext Occurrence ISWFContext facultative utilisée pour effectuer des appels FTE, si nécessaire, dans le contexte swf approprié.	TextContainerManager
		verticalScrollPolicy : String Contrôle si la fabrique génère toutes les lignes de texte ou s’arrête lorsque les limites du conteneur sont atteintes. Spécifie les règles de défilement vertical que vous pouvez définir en affectant l’une des constantes de la classe ScrollPolicy : ON, OFF ou AUTO.	TextContainerManager
		verticalScrollPosition : Number Indique l’emplacement du défilement vertical sur la scène.	TextContainerManager

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		TextContainerManager(container:Sprite, configuration:IConfiguration = null) Fonction constructeur : crée une occurrence TextContainerManager.	TextContainerManager
		activateHandler(event:Event):void Traite l’événement Event.ACTIVATE lorsque le client gère les événements.	TextContainerManager
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement.	EventDispatcher
		beginInteraction():ISelectionManager Renvoie l’occurrence ISelectionManager en cours.	TextContainerManager
		beginMouseCapture():void Appelée pour demander aux clients de commencer l’avance rapide des événements mouseup et mousemove de l’extérieur d’un sandbox de sécurité.	TextContainerManager
		compose():void Compose le texte du conteneur ; appelle la fabrique ou updateAllControllers().	TextContainerManager
		deactivateHandler(event:Event):void Traite l’événement Event.DEACTIVATE lorsque le client gère les événements.	TextContainerManager
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	EventDispatcher
		drawBackgroundAndSetScrollRect(scrollX:Number, scrollY:Number):Boolean Renvoie true s’il a rempli la propriété scrollRect du conteneur.	TextContainerManager
		editHandler(event:Event):void Traite un événement de modification (CUT, COPY, PASTE, SELECT_ALL) lorsque le client gère les événements.	TextContainerManager
		endInteraction():void Met fin à l’interaction.	TextContainerManager
		endMouseCapture():void Appelée pour informer les clients que l’avance rapide des événements mouseup et mousemove de l’extérieur d’un sandbox de sécurité n’est plus nécessaire.	TextContainerManager
		focusChangeHandler(event:FocusEvent):void Traite les événements FocusEvent.KEY_FOCUS_CHANGE et FocusEvent.MOUSE_FOCUS_CHANGE lorsque le client gère les événements.	TextContainerManager
		focusInHandler(event:FocusEvent):void Traite un événement focusIn.	TextContainerManager
		focusOutHandler(event:FocusEvent):void Traite l’événement FocusEvent.FOCUS_OUT lorsque le client gère les événements.	TextContainerManager
		getContentBounds():Rectangle Crée un rectangle qui indique où le dernier appel de la méthode compose() ou de la méthode updateContainer() a placé le texte.	TextContainerManager
		getLineAt(index:int):flash.text.engine:TextLine Renvoie le TextLine à l’index depuis le tableau de lignes composées.	TextContainerManager
		getScrollDelta(numLines:int):Number La distance de défilement nécessaire pour faire défiler vers le haut ou vers le bas par le nombre de lignes spécifié.	TextContainerManager
		getText(separator:String = " "):String Renvoie le texte actuel en insérant un séparateur entre les paragraphes.	TextContainerManager
		getTextFlow():flashx.textLayout.elements:TextFlow L’objet TextFlow en cours.	TextContainerManager
		hasEventListener(type:String):Boolean Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		imeStartCompositionHandler(event:IMEEvent):void Traite l’événement IME_START_COMPOSITION lorsque le client gère les événements.	TextContainerManager
		invalidateSelectionFormats():void Appelez cette méthode si vous modifiez les formats de sélection (SelectionFormat) et que vous souhaitez que l’occurrence interactionManager soit mise à jour.	TextContainerManager
		invalidateUndoManager():void Appelez cette méthode si vous éditez et que vous souhaitez rétablir le gestionnaire d’annulation utilisé pour l’édition.	TextContainerManager
		isDamaged():Boolean Renvoie true si le contenu doit être composé.	TextContainerManager
		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
		keyDownHandler(event:KeyboardEvent):void Traite l’événement KeyboardEvent.KEY_DOWN lorsque le client gère les événements.	TextContainerManager
		keyFocusChangeHandler(event:FocusEvent):void Traite l’événement FocusEvent.KEY_FOCUS_CHANGE lorsque le client gère les événements.	TextContainerManager
		keyUpHandler(event:KeyboardEvent):void Traite l’événement keyboard.KEY_UP lorsque le client gère les événements.	TextContainerManager
		menuSelectHandler(event:ContextMenuEvent):void Traite l’événement MENU_SELECT ContextMenuEvent. lorsque le client gère les événements.	TextContainerManager
		mouseDoubleClickHandler(event:MouseEvent):void Traite l’événement MouseEvent.DOUBLE_CLICK lorsque le client gère les événements.	TextContainerManager
		mouseDownHandler(event:MouseEvent):void Traite l’événement MouseEvent.MOUSE_DOWN lorsque le client gère les événements.	TextContainerManager
		mouseMoveHandler(event:MouseEvent):void Traite l’événement MouseEvent.MOUSE_MOVE lorsque le client gère les événements.	TextContainerManager
		mouseMoveSomewhere(e:Event):void Appel du client pour transférer un événement mouseMove de l’extérieur d’un sandbox de sécurité.	TextContainerManager
		mouseOutHandler(event:MouseEvent):void Traite l’événement MouseEvent.MOUSE_OUT lorsque le client gère les événements.	TextContainerManager
		mouseOverHandler(event:MouseEvent):void Traite un événement mouseOver.	TextContainerManager
		mouseUpHandler(event:MouseEvent):void Traite l’événement MouseEvent.MOUSE_UP lorsque le client gère les événements.	TextContainerManager
		mouseUpSomewhere(e:Event):void Appel du client pour transférer un événement mouseUp de l’extérieur d’un sandbox de sécurité.	TextContainerManager
		mouseWheelHandler(event:MouseEvent):void Traite l’événement MouseEvent.MOUSE_WHEEL lorsque le client gère les événements.	TextContainerManager
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	EventDispatcher
		resetLine(textLine:flash.text.engine:TextLine):void	TextContainerManager
		scrollToRange(activePosition:int, anchorPosition:int):void Fait défiler afin que la plage du texte soit visible dans le conteneur.	TextContainerManager
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		setText(text:String):void Définit la propriété text sur la chaîne spécifiée.	TextContainerManager
		setTextFlow(textFlow:flashx.textLayout.elements:TextFlow):void Définit un objet textFlow dans cette occurrence TextContainerManager en remplaçant tout TextFlow existant et en supprimant le texte actif.	TextContainerManager
		softKeyboardActivatingHandler(event:Event):void Traite l’événement SOFT_KEYBOARD_ACTIVATING lorsque le client gère les événements.	TextContainerManager
		textInputHandler(event:flash.events:TextEvent):void Traite l’événement TextEvent.TEXT_INPUT lorsque le client gère les événements.	TextContainerManager
		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
		updateContainer():Boolean Met à jour l’affichage ; appelle la fabrique ou updateAllControllers().	TextContainerManager
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object
		willTrigger(type:String):Boolean Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié.	EventDispatcher

Méthodes protégées

	Méthode		Défini par
		createContextMenu():ContextMenu Crée un objet ContextMenu pour l’occurrence TextContainerManager.	TextContainerManager
		createEditManager(undoManager:IUndoManager):IEditManager Créez un gestionnaire d’édition à utiliser pour effectuer des modifications.	TextContainerManager
		createSelectionManager():ISelectionManager Créez un gestionnaire de sélection à utiliser pour la sélection.	TextContainerManager
		getFocusedSelectionFormat():SelectionFormat Renvoie l’occurrence focusedSelectionFormat : obtenez-la par défaut par la configuration.	TextContainerManager
		getInactiveSelectionFormat():SelectionFormat Renvoie l’occurrence inactiveSelectioFormat : obtenez-la par défaut par la configuration. Elle peut être remplacée dans la sous-classe pour fournir un autre SelectionFormat.	TextContainerManager
		getUndoManager():IUndoManager Renvoie le gestionnaire d’annulation à utiliser.	TextContainerManager
		getUnfocusedSelectionFormat():SelectionFormat Renvoie l’occurrence unfocusedSelectionFormat : obtenez-la par défaut de la configuration. Vous pouvez ignorer cette méthode dans la sous-classe pour fournir un autre SelectionFormat.	TextContainerManager

Evénements

Cliquez pour plus d’informations sur les événements

Masquer les événements hérités

Afficher les événements hérités

	Synthèse	Défini par
activate	[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.	EventDispatcher
click	Distribué lorsqu’un lien est activé.	TextContainerManager
compositionComplete	Distribué à chaque recomposition.	TextContainerManager
damage	Distribué par un objet TextFlow chaque fois qu’il est endommagé	TextContainerManager
deactivate	[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.	EventDispatcher
flowOperationBegin	Définit la valeur de la propriété type d’un objet d’événement flowOperationBegin.	TextContainerManager
flowOperationComplete	Définit la valeur de la propriété type d’un objet d’événement flowOperationComplete.	TextContainerManager
flowOperationEnd	Définit la valeur de la propriété type d’un objet d’événement flowOperationEnd.	TextContainerManager
inlineGraphicStatusChanged	Distribué lorsqu’une classe InlineGraphicElement est redimensionnée en raison de la largeur ou hauteur automatique ou en pourcentage et après chargement du graphique.	TextContainerManager
mouseDown	Distribué lorsque l’utilisateur clique sur le bouton de la souris sur un lien.	TextContainerManager
mouseMove	Distribué lorsque la souris survole un lien.	TextContainerManager
mouseUp	Distribué lorsque le bouton de la souris est relâché au-dessus d’un lien.	TextContainerManager
rollOut	Distribué lorsque la souris sort de n’importe quel lien.	TextContainerManager
rollOver	Distribué lorsque la souris entre pour la première fois dans un lien.	TextContainerManager
scroll	Distribué par un objet TextFlow après que le texte est déroulé dans un conteneur contrôleur.	TextContainerManager
selectionChange	Distribué chaque fois que la sélection est modifiée.	TextContainerManager
updateComplete	Distribué par un objet TextFlow à chaque fois qu’un conteneur a reçu de nouvelles classes DisplayObjets ou que ces classes ont été mises à jour consécutivement à la composition.	TextContainerManager

Détails de la propriété

compositionHeight

propriété

compositionHeight:Number

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie l’étendue verticale autorisée pour du texte à l’intérieur du conteneur. La valeur est spécifiée en pixels.

Après la définition de cette propriété, le texte dans le conteneur est endommagé et doit être composé.

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

compositionWidth

propriété

compositionWidth:Number

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie l’étendue horizontale autorisée pour le texte à l’intérieur du conteneur. La valeur est spécifiée en pixels.

Après la définition de cette propriété, le texte dans le conteneur est endommagé et doit être composé.

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

configuration

propriété

configuration:IConfiguration [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

L’objet Configuration pour cette occurrence TextContainerManager.

Implémentation
public function get configuration():IConfiguration

Eléments de l’API associés

IConfiguration

container

propriété

container:Sprite [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie le conteneur (DisplayObjectContainer) qui contient le texte géré par l’occurrence TextContainerManager.

Implémentation
public function get container():Sprite

Eléments de l’API associés

ContainerController.container

defaultConfiguration

propriété

defaultConfiguration:IConfiguration [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La configuration par défaut pour cette occurrence TextContainerManager. Les attributs de colonne et de marge sont définis sur la valeur FormatValue.INHERIT.

Implémentation
public static function get defaultConfiguration():IConfiguration

Eléments de l’API associés

IConfiguration
FormatValue.INHERIT

editingMode

propriété

editingMode:String

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Mode d’édition de cette occurrence TextContainerManager. Les modes sont : lecture seule, lecture et sélection autorisées et édition (lecture, sélection et écriture) autorisée. Utilisez les valeurs constantes de la classe EditingMode pour définir cette propriété.

La valeur par défaut est READ_WRITE.

Implémentation
public function get editingMode():String
public function set editingMode(value:String):void

Eléments de l’API associés

EditingMode

horizontalScrollPolicy

propriété

horizontalScrollPolicy:String

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Contrôle si la fabrique génère toutes les lignes de texte ou s’arrête lorsque les limites du conteneur sont atteintes.

Spécifie les règles de défilement horizontal, que vous pouvez définir en affectant l’une des constantes de la classe ScrollPolicy : ON, OFF ou AUTO.

Implémentation
public function get horizontalScrollPolicy():String
public function set horizontalScrollPolicy(value:String):void

horizontalScrollPosition

propriété

horizontalScrollPosition:Number

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Spécifie l’emplacement de défilement horizontal actuel sur la scène. La valeur spécifie le nombre de pixels à partir de la gauche.

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

hostFormat

propriété

hostFormat:flashx.textLayout.formats:ITextLayoutFormat

Définit le format lorsque l’affichage se limite à une chaîne. Si un objet TextFlow est affiché, cela n’a aucun effet immédiat. Le paramètre ITextLayoutFormat fourni n’est pas copié. La modification sans appel de ce setter entraîne des effets inconnus.

Implémentation
public function get hostFormat():flashx.textLayout.formats:ITextLayoutFormat
public function set hostFormat(value:flashx.textLayout.formats:ITextLayoutFormat):void

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

Occurrence ISWFContext facultative utilisée pour effectuer des appels FTE, si nécessaire, dans le contexte swf approprié.

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

verticalScrollPolicy

propriété

verticalScrollPolicy:String

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Contrôle si la fabrique génère toutes les lignes de texte ou s’arrête lorsque les limites du conteneur sont atteintes.

Spécifie les règles de défilement vertical que vous pouvez définir en affectant l’une des constantes de la classe ScrollPolicy : ON, OFF ou AUTO.

Implémentation
public function get verticalScrollPolicy():String
public function set verticalScrollPolicy(value:String):void

verticalScrollPosition

propriété

verticalScrollPosition:Number

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Indique l’emplacement du défilement vertical sur la scène. La valeur spécifie le nombre de pixels à partir du haut.

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

Détails du constructeur

()

Constructeur

public function TextContainerManager(container:Sprite, configuration:IConfiguration = null)

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Fonction constructeur : crée une occurrence TextContainerManager. Pour obtenir de meilleurs résultats :

Démarrez avec TextContainerManager.defaultConfiguration et modifiez-le.
Partagez la même configuration avec de nombreux gestionnaires InputManager.

Paramètres

	`container:Sprite` — La classe DisplayObjectContainer dans laquelle les lignes de texte sont gérées.

	`configuration:IConfiguration` (default = `null`) — L’occurrence IConfiguration à utiliser avec cette occurrence TextContainerManager.

Détails de la méthode

activateHandler

()

méthode

public function activateHandler(event:Event):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement Event.ACTIVATE lorsque le client gère les événements.

Paramètres

event:Event — L’objet Event.

Eléments de l’API associés

Event.ACTIVATE

beginInteraction

()

méthode

public function beginInteraction():ISelectionManager

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie l’occurrence ISelectionManager en cours. Convertit en occurrence TextFlow et en crée une si nécessaire.

Valeur renvoyée

ISelectionManager — Le gestionnaire d’interaction pour cette occurrence TextContainerManager.

Eléments de l’API associés

ISelectionManager

beginMouseCapture

()

méthode

public function beginMouseCapture():void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Appelée pour demander aux clients de commencer l’avance rapide des événements mouseup et mousemove de l’extérieur d’un sandbox de sécurité.

compose

()

méthode

public function compose():void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Compose le texte du conteneur ; appelle la fabrique ou updateAllControllers().

createContextMenu

()

méthode

protected function createContextMenu():ContextMenu

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Crée un objet ContextMenu pour l’occurrence TextContainerManager. Utilisez les méthodes de la classe ContextMenu pour ajouter des éléments au menu.

Vous pouvez annuler cette méthode pour définir un menu contextuel personnalisé.

Valeur renvoyée

ContextMenu — Le menu contextuel créé.

Eléments de l’API associés

ContextMenu

createEditManager

()

méthode

protected function createEditManager(undoManager:IUndoManager):IEditManager

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Créez un gestionnaire d’édition à utiliser pour effectuer des modifications. Annulez cette méthode si vous préférez utiliser un objet EditManager personnalisé à la place de la valeur par défaut.

Paramètres

undoManager:IUndoManager — L’occurrence IUndoManager de l’objet EditManager en cours de création.

Valeur renvoyée

IEditManager — Le gestionnaire d’édition pour cette occurrence TextContainerManager .

createSelectionManager

()

méthode

protected function createSelectionManager():ISelectionManager

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Créez un gestionnaire de sélection à utiliser pour la sélection. Annulez cette méthode si vous préférez utiliser un objet SelectionManager personnalisé à la place de la valeur par défaut.

Valeur renvoyée

ISelectionManager — Une nouvelle occurrence SelectionManager.

deactivateHandler

()

méthode

public function deactivateHandler(event:Event):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement Event.DEACTIVATE lorsque le client gère les événements.

Paramètres

event:Event — L’objet Event.

Eléments de l’API associés

Event.DEACTIVATE

drawBackgroundAndSetScrollRect

()

méthode

public function drawBackgroundAndSetScrollRect(scrollX:Number, scrollY:Number):Boolean

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie true s’il a rempli la propriété scrollRect du conteneur. Cette méthode vous permet de déterminer si scrollRect est défini sans réellement accéder à la propriété scrollRect, ce qui peut éventuellement engendrer un problème de performance.

Annulez cette méthode pour dessiner un arrière-plan ou une bordure. L’annulation de cette méthode est une opération délicate, puisque le rectangle scrollRect doit être défini comme spécifié.

Paramètres

	`scrollX:Number` — La position de départ horizontale du rectangle déroulant.

	`scrollY:Number` — La position de départ verticale du rectangle déroulant.

Valeur renvoyée

Boolean — true si elle a créé l’objet scrollRect.

editHandler

()

méthode

public function editHandler(event:Event):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite un événement de modification (CUT, COPY, PASTE, SELECT_ALL) lorsque le client gère les événements.

Paramètres

event:Event — Objet événement.

Eléments de l’API associés

Evénement

endInteraction

()

méthode

public function endInteraction():void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Met fin à l’interaction.

Eléments de l’API associés

ISelectionManager

endMouseCapture

()

méthode

public function endMouseCapture():void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Appelée pour informer les clients que l’avance rapide des événements mouseup et mousemove de l’extérieur d’un sandbox de sécurité n’est plus nécessaire.

focusChangeHandler

()

méthode

public function focusChangeHandler(event:FocusEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite les événements FocusEvent.KEY_FOCUS_CHANGE et FocusEvent.MOUSE_FOCUS_CHANGE lorsque le client gère les événements.

Paramètres

event:FocusEvent — L’objet FocusEvent.

Eléments de l’API associés

FocusEvent.KEY_FOCUS_CHANGE
FocusEvent.MOUSE_FOCUS_CHANGE

focusInHandler

()

méthode

public function focusInHandler(event:FocusEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite un événement focusIn.

Paramètres

event:FocusEvent

focusOutHandler

()

méthode

public function focusOutHandler(event:FocusEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement FocusEvent.FOCUS_OUT lorsque le client gère les événements.

Paramètres

event:FocusEvent — L’objet FocusEvent.

Eléments de l’API associés

FocusEvent.FOCUS_OUT

getContentBounds

()

méthode

public function getContentBounds():Rectangle

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Crée un rectangle qui indique où le dernier appel de la méthode compose() ou de la méthode updateContainer() a placé le texte.

Valeur renvoyée

Rectangle — Les limites du contenu.

Eléments de l’API associés

compose()
updateContainer()

getFocusedSelectionFormat

()

méthode

protected function getFocusedSelectionFormat():SelectionFormat

Renvoie l’occurrence focusedSelectionFormat : obtenez-la par défaut par la configuration. Elle peut être remplacée dans la sous-classe pour fournir un autre SelectionFormat.

Valeur renvoyée

SelectionFormat

getInactiveSelectionFormat

()

méthode

protected function getInactiveSelectionFormat():SelectionFormat

Renvoie l’occurrence inactiveSelectioFormat : obtenez-la par défaut par la configuration. Elle peut être remplacée dans la sous-classe pour fournir un autre SelectionFormat.

Valeur renvoyée

SelectionFormat

getLineAt

()

méthode

public function getLineAt(index:int):flash.text.engine:TextLine

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie le TextLine à l’index depuis le tableau de lignes composées.

Paramètres

index:int — Recherche la ligne à cette position d’index dans le texte.

Valeur renvoyée

flash.text.engine:TextLine — Le TextLine qui se produit à l’index spécifié.

getScrollDelta

()

méthode

public function getScrollDelta(numLines:int):Number

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La distance de défilement nécessaire pour faire défiler vers le haut ou vers le bas par le nombre de lignes spécifié. Les nombres négatifs font défiler vers le haut, affichant la partie supérieure de l’objet TextFlow. Les nombres positifs font défiler vers le bas, affichant complètement la ligne suivante à partir du bas.

Lors d’un défilement vers le haut, par exemple, la méthode rend la ligne suivante entièrement visible. Si la ligne suivante est partiellement masquée et que le nombre de lignes spécifié est de 1, la ligne partiellement masquée devient complètement visible.

Paramètres

numLines:int — Le nombre de lignes à faire défiler.

Valeur renvoyée

Number — La quantité d’espace delta à faire défiler.

getText

()

méthode

public function getText(separator:String = " "):String

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie le texte actuel en insérant un séparateur entre les paragraphes. Le séparateur peut être spécifié avec l’argument separator. La valeur par défaut de l’argument separator est le caractère Unicode ’PARAGRAPH SEPARATOR’ (U+2029).

L’appel du setter écarte tout objet TextFlow attaché. Toute sélection est perdue.

Paramètres

separator:String (default = " ") — Chaîne à définir entre les paragraphes.

Valeur renvoyée

String

getTextFlow

()

méthode

public function getTextFlow():flashx.textLayout.elements:TextFlow

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

L’objet TextFlow en cours. Le convertit en une représentation d’objet TextFlow complète si ça n’en est pas déjà une.

Valeur renvoyée

flashx.textLayout.elements:TextFlow — L’objet TextFlow en cours.

getUndoManager

()

méthode

protected function getUndoManager():IUndoManager

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie le gestionnaire d’annulation à utiliser. Par défaut, crée un gestionnaire d’annulation unique. Vous pouvez annuler cette méthode dans la sous-classe si vous voulez personnaliser le gestionnaire d’annulation (par exemple, pour utiliser un gestionnaire d’annulation partagé pour plusieurs occurrences TextContainerManager).

Valeur renvoyée

IUndoManager — Nouvelle occurrence IUndoManager.

getUnfocusedSelectionFormat

()

méthode

protected function getUnfocusedSelectionFormat():SelectionFormat

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie l’occurrence unfocusedSelectionFormat : obtenez-la par défaut de la configuration. Vous pouvez ignorer cette méthode dans la sous-classe pour fournir un autre SelectionFormat.

Valeur renvoyée

SelectionFormat

imeStartCompositionHandler

()

méthode

public function imeStartCompositionHandler(event:IMEEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10.1, AIR 1.5

Traite l’événement IME_START_COMPOSITION lorsque le client gère les événements.

Paramètres

event:IMEEvent — L’objet IMEEvent.

Eléments de l’API associés

IMEEvent.IME_START_COMPOSITION

invalidateSelectionFormats

()

méthode

public function invalidateSelectionFormats():void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Appelez cette méthode si vous modifiez les formats de sélection (SelectionFormat) et que vous souhaitez que l’occurrence interactionManager soit mise à jour.

invalidateUndoManager

()

méthode

public function invalidateUndoManager():void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Appelez cette méthode si vous éditez et que vous souhaitez rétablir le gestionnaire d’annulation utilisé pour l’édition.

isDamaged

()

méthode

public function isDamaged():Boolean

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie true si le contenu doit être composé.

Valeur renvoyée

Boolean — true si le contenu doit être composé ; sinon false.

keyDownHandler

()

méthode

public function keyDownHandler(event:KeyboardEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement KeyboardEvent.KEY_DOWN lorsque le client gère les événements.

Paramètres

event:KeyboardEvent — Objet KeyboardEvent.

Eléments de l’API associés

KeyboardEvent.KEY_DOWN

keyFocusChangeHandler

()

méthode

public function keyFocusChangeHandler(event:FocusEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement FocusEvent.KEY_FOCUS_CHANGE lorsque le client gère les événements.

Paramètres

event:FocusEvent — L’objet FocusEvent.

keyUpHandler

()

méthode

public function keyUpHandler(event:KeyboardEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement Keyboard.KEY_UP lorsque le client gère les événements.

Paramètres

event:KeyboardEvent — L’objet KeyboardEvent.

Eléments de l’API associés

KeyboardEvent.KEY_UP

menuSelectHandler

()

méthode

public function menuSelectHandler(event:ContextMenuEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement ContextMenuEvent.MENU_SELECT lorsque le client gère les événements.

Paramètres

event:ContextMenuEvent — Objet ContextMenuEvent.

Eléments de l’API associés

ContextMenuEvent.MENU_SELECT

mouseDoubleClickHandler

()

méthode

public function mouseDoubleClickHandler(event:MouseEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement MouseEvent.DOUBLE_CLICK lorsque le client gère les événements.

Paramètres

event:MouseEvent — L’objet MouseEvent.

Eléments de l’API associés

MouseEvent.DOUBLE_CLICK

mouseDownHandler

()

méthode

public function mouseDownHandler(event:MouseEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement MouseEvent.MOUSE_DOWN lorsque le client gère les événements.

Paramètres

event:MouseEvent — L’objet MouseEvent.

Eléments de l’API associés

MouseEvent.MOUSE_DOWN

mouseMoveHandler

()

méthode

public function mouseMoveHandler(event:MouseEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement MouseEvent.MOUSE_MOVE lorsque le client gère les événements.

Paramètres

event:MouseEvent — L’objet MouseEvent.

Eléments de l’API associés

MouseEvent.MOUSE_MOVE

mouseMoveSomewhere

()

méthode

public function mouseMoveSomewhere(e:Event):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Appel du client pour transférer un événement mouseMove de l’extérieur d’un sandbox de sécurité. Les coordonnées du déplacement de la souris ne sont pas nécessaires.

Paramètres

e:Event

mouseOutHandler

()

méthode

public function mouseOutHandler(event:MouseEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement MouseEvent.MOUSE_OUT lorsque le client gère les événements.

Paramètres

event:MouseEvent — L’objet MouseEvent.

Eléments de l’API associés

MouseEvent.MOUSE_OUT

mouseOverHandler

()

méthode

public function mouseOverHandler(event:MouseEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite un événement mouseOver.

Paramètres

event:MouseEvent

Eléments de l’API associés

MouseEvent.MOUSE_OVER

mouseUpHandler

()

méthode

public function mouseUpHandler(event:MouseEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement MouseEvent.MOUSE_UP lorsque le client gère les événements.

Paramètres

event:MouseEvent — L’objet MouseEvent.

Eléments de l’API associés

MouseEvent.MOUSE_UP

mouseUpSomewhere

()

méthode

public function mouseUpSomewhere(e:Event):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Appel du client pour transférer un événement mouseUp de l’extérieur d’un sandbox de sécurité. Les coordonnées du déplacement de la souris vers le haut ne sont pas nécessaires.

Paramètres

e:Event

mouseWheelHandler

()

méthode

public function mouseWheelHandler(event:MouseEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement MouseEvent.MOUSE_WHEEL lorsque le client gère les événements.

Paramètres

event:MouseEvent — L’objet MouseEvent.

Eléments de l’API associés

MouseEvent.MOUSE_WHEEL

resetLine

()

méthode

public function resetLine(textLine:flash.text.engine:TextLine):void

Paramètres

textLine:flash.text.engine:TextLine

scrollToRange

()

méthode

public function scrollToRange(activePosition:int, anchorPosition:int):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Fait défiler afin que la plage du texte soit visible dans le conteneur.

Paramètres

	`activePosition:int` — L’extrémité de la sélection est modifiée lorsque vous développez la sélection. Il peut s’agir du début ou de la fin de la sélection, exprimé sous la forme d’un décalage à partir du début de l’enchaînement de texte.

	`anchorPosition:int` — La fin stable de la sélection lorsque vous développez la sélection. Il peut s’agir du début ou de la fin de la sélection.

setText

()

méthode

public function setText(text:String):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Définit la propriété text sur la chaîne spécifiée. Ignore les objets TextFlow associés. Toute sélection est perdue.

Paramètres

text:String — La chaîne à définir.

setTextFlow

()

méthode

public function setTextFlow(textFlow:flashx.textLayout.elements:TextFlow):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Définit un objet textFlow dans cette occurrence TextContainerManager en remplaçant tout TextFlow existant et en supprimant le texte actif.

Paramètres

textFlow:flashx.textLayout.elements:TextFlow

softKeyboardActivatingHandler

()

méthode

public function softKeyboardActivatingHandler(event:Event):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10.2, AIR 1.5

Traite l’événement SOFT_KEYBOARD_ACTIVATING lorsque le client gère les événements.

Paramètres

event:Event — Objet SoftKeyboardEvent.

Eléments de l’API associés

SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING

textInputHandler

()

méthode

public function textInputHandler(event:flash.events:TextEvent):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Traite l’événement TextEvent.TEXT_INPUT lorsque le client gère les événements.

Paramètres

event:flash.events:TextEvent — L’objet TextEvent.

Eléments de l’API associés

TextEvent.TEXT_INPUT

updateContainer

()

méthode

public function updateContainer():Boolean

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Met à jour l’affichage ; appelle la fabrique ou updateAllControllers().

Valeur renvoyée

Boolean — La valeur est true si des modifications ont eu lieu.

Détails de l’événement

click

Evénement

Type d’objet d’événement: flashx.textLayout.events.FlowElementMouseEvent

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué lorsqu’un lien est activé.

compositionComplete

Evénement

Type d’objet d’événement: flashx.textLayout.events.CompositionCompleteEvent

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué à chaque recomposition.

damage

Evénement

Type d’objet d’événement: flashx.textLayout.events.DamageEvent

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué par un objet TextFlow chaque fois qu’il est endommagé

flowOperationBegin

Evénement

Type d’objet d’événement: flashx.textLayout.events.FlowOperationEvent
propriété FlowOperationEvent.type = flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_BEGIN

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Définit la valeur de la propriété type d’un objet d’événement flowOperationBegin distribué avant le début d’une opération. L’annulation de cet événement bloque l’opération.

flowOperationComplete

Evénement

Type d’objet d’événement: flashx.textLayout.events.FlowOperationEvent
propriété FlowOperationEvent.type = flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_COMPLETE

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Définit la valeur de la propriété type d’un objet d’événement flowOperationComplete. Distribué lorsque toutes les opérations sont terminées, y compris les opérations en attente et les opérations composites, lorsque la composition est terminée et lorsque l’affichage est en train de défiler.

flowOperationEnd

Evénement

Type d’objet d’événement: flashx.textLayout.events.FlowOperationEvent
propriété FlowOperationEvent.type = flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_END

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Définit la valeur de la propriété type d’un objet d’événement flowOperationEnd distribué avant le début d’une opération. Les erreurs sont stockées dans OperationEvent.error. En cas d’erreur, l’annulation de cet événement empêche une nouvelle génération de l’erreur. De façon générale, toutes les erreurs sont susceptibles d’être fatales.

Modifier une opération à ce stade (après son exécution) risque d’échouer.

inlineGraphicStatusChanged

Evénement

Type d’objet d’événement: flashx.textLayout.events.StatusChangeEvent

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué lorsqu’une classe InlineGraphicElement est redimensionnée en raison de la largeur ou hauteur automatique ou en pourcentage et après chargement du graphique.

mouseDown

Evénement

Type d’objet d’événement: flashx.textLayout.events.FlowElementMouseEvent

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué lorsque l’utilisateur clique sur le bouton de la souris sur un lien.

mouseMove

Evénement

Type d’objet d’événement: flashx.textLayout.events.FlowElementMouseEvent

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué lorsque la souris survole un lien.

mouseUp

Evénement

Type d’objet d’événement: flashx.textLayout.events.FlowElementMouseEvent

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué lorsque le bouton de la souris est relâché au-dessus d’un lien.

rollOut

Evénement

Type d’objet d’événement: flashx.textLayout.events.FlowElementMouseEvent

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué lorsque la souris sort de n’importe quel lien.

rollOver

Evénement

Type d’objet d’événement: flashx.textLayout.events.FlowElementMouseEvent

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué lorsque la souris entre pour la première fois dans un lien.

scroll

Evénement

Type d’objet d’événement: flashx.textLayout.events.TextLayoutEvent

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué par un objet TextFlow après que le texte est déroulé dans un conteneur contrôleur.

selectionChange

Evénement

Type d’objet d’événement: flashx.textLayout.events.SelectionEvent

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué chaque fois que la sélection est modifiée. Principalement utilisé pour mettre à jour l’interface utilisateur qui dépend de la sélection.

updateComplete

Evénement

Type d’objet d’événement: flashx.textLayout.events.UpdateCompleteEvent

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué par un objet TextFlow à chaque fois qu’un conteneur a reçu de nouvelles classes DisplayObjets ou que ces classes ont été mises à jour consécutivement à la composition.

Informations juridiques | Politique de confidentialité en ligne

TextContainerManager - AS3

Packagesx

Eléments du langage

Annexes

Package flashx.textLayout.container

compositionHeight

compositionWidth

configuration

container

defaultConfiguration

editingMode

horizontalScrollPolicy

horizontalScrollPosition

hostFormat

numLines

swfContext

verticalScrollPolicy

verticalScrollPosition