ISelectionManager - Guide de référence de l’API Adobe ActionScript® 3 (AS3 )

Package	flashx.textLayout.edit
Interface	public interface ISelectionManager extends IInteractionEventHandler
Implémenteurs	SelectionManager

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

L’interface ISelectionManager définit l’interface pour la gestion des sélections de texte.

Un objet SelectionManager garde la trace de la plage de texte sélectionnée et gère les événements pour un objet TextFlow.

Une sélection peut être un point de sélection ou une plage de sélection. Une sélection de point est le point d’insertion et est représentée visuellement par le tracé d’un curseur. Une sélection de plage inclut le texte entre un point d’ancrage et un point actif.

Eléments de l’API associés

flashx.textLayout.edit.SelectionManager
flashx.textLayout.edit.TextScrap
flashx.textLayout.elements.TextFlow

Propriétés publiques

	Propriété		Défini par
		absoluteEnd : int [lecture seule] La position du texte de la fin de la sélection, sous la forme d’un décalage à partir du début de l’enchaînement de texte.	ISelectionManager
		absoluteStart : int [lecture seule] La position du texte du début de la sélection, sous la forme d’un décalage à partir du début de l’enchaînement de texte.	ISelectionManager
		activePosition : int [lecture seule] Le point actif de la sélection.	ISelectionManager
		anchorPosition : int [lecture seule] Le point d’ancrage de la sélection.	ISelectionManager
		currentSelectionFormat : SelectionFormat [lecture seule] L’objet SelectionFormat en cours.	ISelectionManager
		editingMode : String [lecture seule] Le mode de modification.	ISelectionManager
		focused : Boolean [lecture seule] Indique si un conteneur dans l’enchaînement de texte a le focus.	ISelectionManager
		focusedSelectionFormat : SelectionFormat L’objet SelectionFormat utilisé pour tracer la sélection dans un conteneur concentré.	ISelectionManager
		inactiveSelectionFormat : SelectionFormat L’objet SelectionFormat utilisé pour tracer la sélection si elle n’est pas dans la fenêtre active.	ISelectionManager
		textFlow : flashx.textLayout.elements:TextFlow L’objet TextFlow géré par ce gestionnaire de sélection.	ISelectionManager
		unfocusedSelectionFormat : SelectionFormat L’objet SelectionFormat utilisé pour tracer la sélection si elle n’est pas dans un conteneur concentré mais dans la fenêtre active.	ISelectionManager
		windowActive : Boolean [lecture seule] Indique si la fenêtre associée à l’enchaînement de texte est active.	ISelectionManager

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		activateHandler(event:Event):void Traite un événement Activer.	IInteractionEventHandler
		deactivateHandler(event:Event):void Traite un événement Désactiver.	IInteractionEventHandler
		editHandler(event:Event):void Traite un événement Modifier.	IInteractionEventHandler
		flushPendingOperations():void Exécute toutes les classes FlowOperation en attente.	ISelectionManager
		focusChangeHandler(event:FocusEvent):void Traite un événement focusChange.	IInteractionEventHandler
		focusInHandler(event:FocusEvent):void Traite un événement focusIn.	IInteractionEventHandler
		focusOutHandler(event:FocusEvent):void Traite un événement focusOut.	IInteractionEventHandler
		getCommonCharacterFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat Récupère les attributs de format de caractère qui sont communs à tous les caractères de la plage de texte spécifiée ou de la sélection actuelle.	ISelectionManager
		getCommonContainerFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat Récupère les attributs de format de conteneur qui sont communs à tous les conteneurs de la plage de texte spécifiée ou de la sélection actuelle.	ISelectionManager
		getCommonParagraphFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat Récupère les attributs de format de paragraphe qui sont communs à tous les paragraphes de la plage de texte spécifiée ou de la sélection actuelle.	ISelectionManager
		getSelectionState():SelectionState Récupère l’objet SelectionState de la sélection actuelle.	ISelectionManager
		hasSelection():Boolean Indique s’il existe une sélection.	ISelectionManager
		imeStartCompositionHandler(event:IMEEvent):void Traite un événement imeStartComposition	IInteractionEventHandler
		isRangeSelection():Boolean Indique si la sélection couvre une plage de texte.	ISelectionManager
		keyDownHandler(event:KeyboardEvent):void Traite un événement keyDown.	IInteractionEventHandler
		keyFocusChangeHandler(event:FocusEvent):void Traite un événement keyFocusChange.	IInteractionEventHandler
		keyUpHandler(event:KeyboardEvent):void Traite un événement keyUp.	IInteractionEventHandler
		menuSelectHandler(event:ContextMenuEvent):void Traite un événement menuSelect.	IInteractionEventHandler
		mouseDoubleClickHandler(event:MouseEvent):void Traite un événement mouseDoubleClick.	IInteractionEventHandler
		mouseDownHandler(event:MouseEvent):void Traite un événement mouseDown.	IInteractionEventHandler
		mouseMoveHandler(event:MouseEvent):void Traite un événement mouseMove.	IInteractionEventHandler
		mouseOutHandler(event:MouseEvent):void Traite un événement mouseOut.	IInteractionEventHandler
		mouseOverHandler(event:MouseEvent):void Traite un événement mouseOver.	IInteractionEventHandler
		mouseUpHandler(event:MouseEvent):void Traite un événement mouseUp.	IInteractionEventHandler
		mouseWheelHandler(event:MouseEvent):void Traite un événement mouseWheel.	IInteractionEventHandler
		notifyInsertOrDelete(absolutePosition:int, length:int):void Met à jour le gestionnaire de sélection lorsque du texte est inséré ou supprimé.	ISelectionManager
		refreshSelection():void Affiche à nouveau les formes de sélection.	ISelectionManager
		selectAll():void Sélectionne tout l’enchaînement .	ISelectionManager
		selectRange(anchorPosition:int, activePosition:int):void Sélectionne une plage de texte.	ISelectionManager
		setFocus():void Donne le focus sur le premier conteneur de la sélection.	ISelectionManager
		setSelectionState(state:SelectionState):void Définit l’objet SelectionState de la sélection actuelle.	ISelectionManager
		softKeyboardActivatingHandler(event:Event):void Traite un événement softKeyboardActivating.	IInteractionEventHandler
		textInputHandler(event:flash.events:TextEvent):void Traite un événement TextEvent.	IInteractionEventHandler

Détails de la propriété

absoluteEnd

propriété

absoluteEnd:int [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La position du texte de la fin de la sélection, sous la forme d’un décalage à partir du début de l’enchaînement de texte.

La fin absolue est la même que le point actif ou le point d’ancrage de la sélection, en fonction de celui qui vient en dernier dans l’enchaînement de texte.

Implémentation
public function get absoluteEnd():int

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

La position du texte du début de la sélection, sous la forme d’un décalage à partir du début de l’enchaînement de texte.

Le début absolu est le même que le point actif ou le point d’ancrage de la sélection, en fonction de celui qui vient en premier dans l’enchaînement de texte.

Implémentation
public function get absoluteStart():int

activePosition

propriété

activePosition:int [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Le point actif de la sélection.

Le point actif est la fin instable de la sélection. Le point actif est modifié lorsque la sélection est modifiée. Le point actif peut être au début ou à la fin de la sélection.

Implémentation
public function get activePosition():int

anchorPosition

propriété

anchorPosition:int [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Le point d’ancrage de la sélection.

Un point d’ancrage est la fin stable de la sélection. Lorsque la sélection est étendue, le point d’ancrage ne change pas. Le point actif peut être au début ou à la fin de la sélection.

Implémentation
public function get anchorPosition():int

currentSelectionFormat

propriété

currentSelectionFormat:SelectionFormat [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

L’objet SelectionFormat en cours.

L’objet SelectionFormat en cours est choisi parmi les objets SelectionFormat affectés aux propriétés unfocusedSelectionFormat, inactiveSelectionFormat et focusedSelectionFormat sur la base de l’état actuel des propriétés windowActive et focused.

Implémentation
public function get currentSelectionFormat():SelectionFormat

editingMode

propriété

editingMode:String [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Le mode de modification.

Le mode de modification indique si l’enchaînement de texte prend en charge la sélection, la modification ou uniquement la lecture. Un enchaînement de texte est rendu sélectionnable par affectation d’un gestionnaire de sélection et modifiable par affectation d’un gestionnaire de modification. Les constantes représentant les modes de modification sont définies dans la classe EditingMode.

Implémentation
public function get editingMode():String

Eléments de l’API associés

flashx.textLayout.EditingMode

focused

propriété

focused:Boolean [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Indique si un conteneur dans l’enchaînement de texte a le focus.

La propriété focused est truesi l’un des conteneurs dans l’enchaînement de texte a le focus principal.

Implémentation
public function get focused():Boolean

focusedSelectionFormat

propriété

focusedSelectionFormat:SelectionFormat

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

L’objet SelectionFormat utilisé pour tracer la sélection dans un conteneur concentré.

Implémentation
public function get focusedSelectionFormat():SelectionFormat
public function set focusedSelectionFormat(value:SelectionFormat):void

inactiveSelectionFormat

propriété

inactiveSelectionFormat:SelectionFormat

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

L’objet SelectionFormat utilisé pour tracer la sélection si elle n’est pas dans la fenêtre active.

Implémentation
public function get inactiveSelectionFormat():SelectionFormat
public function set inactiveSelectionFormat(value:SelectionFormat):void

textFlow

propriété

textFlow: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 géré par ce gestionnaire de sélection.

Un gestionnaire de sélection gère un seul enchaînement de texte. Un gestionnaire de sélection peut également être affecté à un enchaînement de texte par la définition du gestionnaire interactionManager de la propriété de l’objet TextFlow.

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

Eléments de l’API associés

flashx.textLayout.elements.TextFlow.interactionManager

unfocusedSelectionFormat

propriété

unfocusedSelectionFormat:SelectionFormat

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

L’objet SelectionFormat utilisé pour tracer la sélection si elle n’est pas dans un conteneur concentré mais dans la fenêtre active.

Implémentation
public function get unfocusedSelectionFormat():SelectionFormat
public function set unfocusedSelectionFormat(value:SelectionFormat):void

windowActive

propriété

windowActive:Boolean [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Indique si la fenêtre associée à l’enchaînement de texte est active.

La propriété windowActive est true si la fenêtre qui affiche le texte est la fenêtre active

Implémentation
public function get windowActive():Boolean

Détails de la méthode

flushPendingOperations

()

méthode

public function flushPendingOperations():void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Exécute toutes les classes FlowOperation en attente.

L’exécution de certaines opérations de modification, d’insertion de texte, par exemple, est légèrement retardée jusqu’au prochain événement enterFrame. Appeler l’opération flushPendingOperations() entraîne les opérations à exécuter immédiatement.

getCommonCharacterFormat

()

méthode

 public function getCommonCharacterFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Récupère les attributs de format de caractère qui sont communs à tous les caractères de la plage de texte spécifiée ou de la sélection actuelle.

Les attributs de format qui n’ont pas la même valeur pour tous les caractères de la plage d’éléments spécifiée ou de la sélection sont définis sur null dans l’occurrence de TextLayoutFormat renvoyée.

Paramètres

range:flashx.textLayout.elements:TextRange (default = null) — Plage de texte facultative pour laquelle les attributs communs sont requis. Si la valeur définie est null, la sélection en cours est utilisée.

Valeur renvoyée

flashx.textLayout.formats:TextLayoutFormat — Paramètres de style de caractère communs

Exemple ( Comment utiliser cet exemple )

L’exemple suivant illustre comment obtenir un objet ITextLayoutFormat contenant les paramètres de style de caractère communs à tous les éléments de la sélection. (La variable textFlow de cet exemple correspond à un objet TextFlow.)

 var common:ITextLayoutFormat = textFlow.interactionManager.getCommonCharacterFormat();

getCommonContainerFormat

()

méthode

 public function getCommonContainerFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Récupère les attributs de format de conteneur qui sont communs à tous les conteneurs de la plage de texte spécifiée ou de la sélection actuelle.

Les attributs de format qui n’ont pas la même valeur pour tous les conteneurs de la plage d’éléments spécifiée ou de la sélection sont définis sur null dans l’occurrence de TextLayoutFormat renvoyée.

Paramètres

Valeur renvoyée

flashx.textLayout.formats:TextLayoutFormat — Paramètres de style de conteneur communs

Exemple ( Comment utiliser cet exemple )

L’exemple suivant illustre comment obtenir un objet ITextLayoutFormat contenant les paramètres de style de conteneur communs à tous les éléments de la sélection. (La variable textFlow de cet exemple correspond à un objet TextFlow.)

 var common:ITextLayoutFormat = textFlow.interactionManager.getCommonContainerFormat();

getCommonParagraphFormat

()

méthode

 public function getCommonParagraphFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Récupère les attributs de format de paragraphe qui sont communs à tous les paragraphes de la plage de texte spécifiée ou de la sélection actuelle.

Les attributs de format qui n’ont pas la même valeur pour tous les paragraphes de la plage d’éléments spécifiée ou de la sélection sont définis sur null dans l’occurrence de TextLayoutFormat renvoyée.

Paramètres

Valeur renvoyée

flashx.textLayout.formats:TextLayoutFormat — Paramètres de style de paragraphe communs

Exemple ( Comment utiliser cet exemple )

L’exemple suivant illustre comment obtenir un objet ITextLayoutFormat contenant les paramètres de style de paragraphe communs à tous les éléments de la sélection. (La variable textFlow de cet exemple correspond à un objet TextFlow.)

 var common:ITextLayoutFormat = textFlow.interactionManager.getCommonParagraphFormat();

getSelectionState

()

méthode

public function getSelectionState():SelectionState

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Récupère l’objet SelectionState de la sélection actuelle.

Valeur renvoyée

SelectionState

Eléments de l’API associés

flashx.textLayout.edit.SelectionState

Exemple ( Comment utiliser cet exemple )

L’exemple suivant récupère un objet SelectionState de la sélection actuelle dans un enchaînement de texte. (La variable textFlow de cet exemple correspond à un objet TextFlow.)

 var selection:SelectionState = textFlow.interactionManager.getSelectionState();

hasSelection

()

méthode

public function hasSelection():Boolean

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Indique s’il existe une sélection.

Renvoie true s’il existe une sélection de plage ou un point de sélection. Par défaut, lorsqu’un gestionnaire de sélection est configuré pour la première fois, il n’existe pas de sélection (le début et la fin sont -1).

Valeur renvoyée

Boolean

Exemple ( Comment utiliser cet exemple )

L’exemple suivant illustre la façon de déterminer si un enchaînement de texte possède une sélection. (La variable textFlow de cet exemple correspond à un objet TextFlow.)

 var selection:SelectionState = textFlow.interactionManager.hasSelection();

isRangeSelection

()

méthode

public function isRangeSelection():Boolean

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Indique si la sélection couvre une plage de texte.

Renvoie true s’il existe une sélection qui s’étend au-delà d’une position unique

Valeur renvoyée

Boolean

Exemple ( Comment utiliser cet exemple )

L’exemple suivant illustre comment déterminer si la sélection actuelle dans un enchaînement de texte s’étend sur une plage de texte. (La variable textFlow de cet exemple correspond à un objet TextFlow.)

 var selection:SelectionState = textFlow.interactionManager.isRangeSelection();

notifyInsertOrDelete

()

méthode

public function notifyInsertOrDelete(absolutePosition:int, length:int):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Met à jour le gestionnaire de sélection lorsque du texte est inséré ou supprimé.

Les opérations doivent appeler notifyInsertOrDelete lors de la modification de texte dans l’enchaînement. Le gestionnaire de sélection ajuste les indicateurs de position basés sur l’index en conséquence. Si vous créez une nouvelle classe d’opération qui modifie le texte dans un enchaînement de texte directement (sans utiliser une autre opération) votre opération doit appeler cette fonction pour maintenir la sélection à jour.

Paramètres

	`absolutePosition:int` — L’endroit dans le texte où le changement effectué.

	`length:int` — Une valeur positive ou négative indiquant le nombre de caractères ayant été insérés ou supprimés.

Exemple ( Comment utiliser cet exemple )

L’exemple suivant illustre comment une fonction dans une classe Operation personnalisée appelle la méthode notifyInsertOrDelete().

Cette fonction remplace une plage de texte dans un élément SpanElement comme faisant partie d’une opération hypothétique.

 import flashx.textLayout.elements.SpanElement;
 

function doReplace( span:SpanElement, newText:String, relativeStart:int, relativeEnd:int ):void
{
    span.replaceText(  relativeStart, relativeEnd, newText );
    var parentFlow:TextFlow = span.getTextFlow();
    var lengthDifference:int = newText.length - (relativeEnd - relativeStart);

    parentFlow.interactionManager.notifyInsertOrDelete(    span.getAbsoluteStart() + relativeStart, lengthDifference );
}

refreshSelection

()

méthode

public function refreshSelection():void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Affiche à nouveau les formes de sélection.

Remarque : vous n’avez pas besoin d’appeler directement cette méthode. Elle est appelée automatiquement.

selectAll

()

méthode

public function selectAll():void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Sélectionne tout l’enchaînement.

selectRange

()

méthode

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

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Sélectionne une plage de texte.

Si un nombre négatif est transmis en tant que l’un des paramètres, alors une sélection existante est supprimée.

Paramètres

	`anchorPosition:int` — Le point d’ancrage de la nouvelle sélection, comme une position absolue dans l’objet TextFlow

	`activePosition:int` — Active la fin de la nouvelle sélection, comme une position absolue dans l’objet TextFlow

Exemple ( Comment utiliser cet exemple )

L’exemple suivant crée un enchaînement de texte et effectue une sélection :

 var textFlow:TextFlow = TextConverter.importToFlow( "Let me not to the marriage of true minds", TextConverter.PLAIN_TEXT_FORMAT );
 textFlow.interactionManager = new SelectionManager();
 
 textFlow.interactionManager.selectRange( 18, 26 ); // Selects the word 'marriage'

setFocus

()

méthode

public function setFocus():void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Donne le focus sur le premier conteneur de la sélection.

Exemple ( Comment utiliser cet exemple )

L’exemple suivant définit le focus sur le premier conteneur dans la sélection actuelle d’un enchaînement de texte. (La variable textFlow de cet exemple correspond à un objet TextFlow.)

 textFlow.interactionManager.setFocus();

setSelectionState

()

méthode

public function setSelectionState(state:SelectionState):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Définit l’objet SelectionState de la sélection actuelle.

Paramètres

state:SelectionState

Eléments de l’API associés

flashx.textLayout.edit.SelectionState

Informations juridiques | Politique de confidentialité en ligne

ISelectionManager - AS3

Classes x

absoluteEnd

absoluteStart

activePosition

anchorPosition

currentSelectionFormat

editingMode

focused

focusedSelectionFormat

inactiveSelectionFormat

textFlow

unfocusedSelectionFormat

windowActive

flushPendingOperations

getCommonCharacterFormat

getCommonContainerFormat

getCommonParagraphFormat

getSelectionState

hasSelection

isRangeSelection

notifyInsertOrDelete

refreshSelection

selectAll

selectRange

setFocus

setSelectionState