| Package | flashx.textLayout.events |
| Classe | public class FlowOperationEvent |
| Héritage | FlowOperationEvent  Event Object |
| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Avant une opération, l’objet TextFlow distribue un événement FlowOperationEvent avec sa propriété type définie sur FlowOperationEvent.FLOW_OPERATION_BEGIN. Vous pouvez déterminer le type d’opération qui est sur le point de commencer en consultant la propriété operation. Les événements de type FLOW_OPERATION_BEGIN peuvent être annulés, ce qui signifie que si vous décidez que l’opération ne doit pas se poursuivre, vous pouvez appeler la méthode Event.PreventDefault() pour l’annuler. Si vous annulez l’opération, cette dernière n’est pas réalisée et l’événement FLOW_OPERATION_END n’est pas distribué. Vous pouvez également choisir de revenir dans l’objet EditManager pour effectuer une autre opération avant que l’opération ayant déclenché l’événement ne soit terminée. Si vous procédez ainsi, les opérations que vous réalisez dans votre gestionnaire d’événement seront annulées en une seule opération avec l’opération ayant déclenché l’événement.
Si vous autorisez l’opération à continuer, l’objet TextFlow distribue un événement FlowOperationEvent à la fin de l’opération avec sa propriété type définie sur FlowOperationEvent.FLOW_OPERATION_END. Cet événement est distribué avant que Flash Player ne génère les erreurs susceptibles de résulter de l’opération. Ceci vous donne la possibilité de traiter l’erreur avant que Flash Player ne génère l’erreur. Vous pouvez accéder à l’erreur par l’intermédiaire de la propriété error de l’événement. Si vous choisissez de gérer l’erreur dans votre gestionnaire d’événement, vous pouvez empêcher Flash Player de générer l’erreur en annulant l’événement FLOW_OPERATION_END par l’appel de la méthode Event.preventDefault(). Vous pouvez également choisir de revenir dans l’objet EditManager pour effectuer des opérations supplémentaires. Si vous procédez ainsi, les opérations résultantes seront annulées avec l’opération ayant déclenché l’événement.
Eléments de l’API associés
Masquer les propriétés publiques héritées
Afficher les propriétés publiques héritées| Propriété | Défini par | ||
|---|---|---|---|
 | bubbles : Boolean [lecture seule]
Indique si un événement peut se propager vers le haut (bubbling). | Event | |
| cancelable : Boolean [lecture seule]
Indique si le comportement associé à l’événement peut être évité. | Event | |
| constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| currentTarget : Object [lecture seule]
L’objet qui traite activement l’objet Event avec un écouteur d’événements. | Event | |
| error : Error
Erreur générée, le cas échéant, pendant une opération. | FlowOperationEvent | ||
| eventPhase : uint [lecture seule]
Phase actuelle du flux d’événements. | Event | |
| level : int
Les opérations peuvent être fusionnées par imbrication dans les opérations composites. | FlowOperationEvent | ||
| operation : FlowOperation
L’opération est sur le point de commencer ou vient de se terminer. | FlowOperationEvent | ||
| target : Object [lecture seule]
Cible de l’événement. | Event | |
| type : String [lecture seule]
Type d’événement. | Event | |
| Méthode | Défini par | ||
|---|---|---|---|
FlowOperationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, operation:FlowOperation = null, level:int = 0, error:Error = null) Crée un objet d’événement contenant des informations sur l’enchaînement. | FlowOperationEvent | ||
|
Duplique une occurrence d’une sous-classe Event. | Event | |
|
Fonction d’un utilitaire permettant d’implémenter la méthode toString() dans des classes Event ActionScript 3.0 personnalisées. | Event | |
|
Indique si la propriété spécifiée d’un objet est définie. | Object | |
|
Vérifie si la méthode preventDefault() a été appelée pour l’événement. | Event | |
|
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 | |
|
Annule le comportement par défaut d’un événement si cette opération est possible. | Event | |
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
|
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | |
|
Bloque le traitement des écouteurs d’événement dans le nœud actuel et les suivants dans le flux d’événements. | Event | |
|
Bloque le traitement des écouteurs d’événement dans les nœuds qui suivent le nœud actuel dans le flux d’événements. | Event | |
|
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | |
|
Renvoie une chaîne répertoriant toutes les propriétés de l’objet Event. | Event | |
|
Renvoie la valeur primitive de l’objet spécifié. | Object | |
| Constante | Défini par | ||
|---|---|---|---|
| FLOW_OPERATION_BEGIN : String = "flowOperationBegin" [statique]
Définit la valeur de la propriété type d’un objet d’événement flowOperationBegin. | FlowOperationEvent | ||
| FLOW_OPERATION_COMPLETE : String = "flowOperationComplete" [statique]
Définit la valeur de la propriété type d’un objet d’événement flowOperationComplete. | FlowOperationEvent | ||
| FLOW_OPERATION_END : String = "flowOperationEnd" [statique]
Définit la valeur de la propriété type d’un objet d’événement flowOperationEnd. | FlowOperationEvent | ||
error | propriété |
error:Error| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Erreur générée, le cas échéant, pendant une opération. Si une erreur se produit au cours d’une opération, une référence à l’objet erreur est associée à l’événement FLOW_OPERATION_END. Ceci vous donne la possibilité de gérer l’erreur avant que Flash Player ne génère l’erreur. Si vous annulez l’événement, Flash Player ne génère pas l’erreur.
Implémentation
public function get error():Error public function set error(value:Error):voidlevel | propriété |
level:int| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Les opérations peuvent être fusionnées par imbrication dans les opérations composites. Cet indicateur décrit le niveau d’imbrication de l’opération.
Implémentation
public function get level():int public function set level(value:int):voidoperation | propriété |
operation:FlowOperation| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
L’opération est sur le point de commencer ou vient de se terminer.
Implémentation
public function get operation():FlowOperation public function set operation(value:FlowOperation):voidEléments de l’API associés
FlowOperationEvent | () | Constructeur |
public function FlowOperationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, operation:FlowOperation = null, level:int = 0, error:Error = null)| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Crée un objet d’événement contenant des informations sur l’enchaînement.
Paramètrestype:String — Type de l’événement. Les écouteurs d’événement peuvent accéder à cette information par le biais de la propriété type héritée. Il existe deux types : FlowOperationEvent.FLOW_OPERATION_BEGIN ; FlowOperationEvent.FLOW_OPERATION_END.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false)Event.preventDefault() dans votre fonction de gestionnaire d’événement.
| |
operation:FlowOperation (default = null) | |
level:int (default = 0) | |
error:Error (default = null) |
FLOW_OPERATION_BEGIN | Constante |
public static const FLOW_OPERATION_BEGIN:String = "flowOperationBegin"| 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.
FLOW_OPERATION_COMPLETE | Constante |
public static const FLOW_OPERATION_COMPLETE:String = "flowOperationComplete"| 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.
FLOW_OPERATION_END | Constante |
public static const FLOW_OPERATION_END:String = "flowOperationEnd"| 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.
Cet exemple indique comment créer un gestionnaire d’événement qui écoute le début et la fin d’une opération d’enchaînement de texte. Les deux principales étapes consistent à appeler la méthode addEventListener() sur le flux de texte et à créer une fonction de gestionnaire d’événement.
L’appel de la méthode addEventListener() s’effectue sur l’occurrence TextFlow. Vous pouvez utiliser la chaîne simple "flowOperationBegin" ou "flowOperationEnd", mais il est plus sûr d’utiliser la constante statique FlowOperationEvent.FLOW_OPERATION_BEGIN ou FlowOperationEvent.FLOW_OPERATION_END, respectivement.
Les fonctions du gestionnaire d’événement de cet exemple sont nommées opBeginHandler() et opEndHandler(). La méthode opBeginHandler() utilise la fonction trace() pour produire une instruction trace qui indique qu’une opération de collage a commencé. La méthode opEndHandler() utilise également la fonction trace(), mais produit une instruction trace uniquement si une erreur se produit.
package flashx.textLayout.events.examples
{
import flash.display.Sprite;
import flashx.textLayout.compose.StandardFlowComposer;
import flashx.textLayout.container.ContainerController;
import flashx.textLayout.conversion.TextConverter;
import flashx.textLayout.edit.EditManager;
import flashx.textLayout.elements.TextFlow;
import flashx.textLayout.events.FlowOperationEvent;
import flashx.textLayout.operations.FlowOperation;
import flashx.textLayout.operations.PasteOperation;
import flashx.undo.UndoManager;
public class FlowOperationEvent_example extends Sprite
{
private var inputContainer:Sprite;
private var inputTextFlow:TextFlow;
private var inputController:ContainerController;
private var inputEditManager:EditManager;
private var inputUndoManager:UndoManager;
public function FlowOperationEvent_example()
{
var replaceText:String = "paste text here";
inputTextFlow = new TextFlow();
inputContainer = new Sprite();
inputContainer.x = 30;
inputContainer.y = 100;
this.stage.addChild( inputContainer );
inputController = new ContainerController(inputContainer, 225, 20);
inputController.verticalScrollPolicy = flashx.textLayout.container.ScrollPolicy.OFF;
inputTextFlow = TextConverter.importToFlow(replaceText, TextConverter.PLAIN_TEXT_FORMAT);
inputTextFlow.flowComposer = new StandardFlowComposer();
inputTextFlow.flowComposer.addController(inputController);
inputUndoManager = new UndoManager();
inputEditManager = new EditManager(inputUndoManager);
inputTextFlow.interactionManager = inputEditManager;
inputTextFlow.addEventListener(FlowOperationEvent.FLOW_OPERATION_BEGIN, opBeginHandler);
inputTextFlow.addEventListener(FlowOperationEvent.FLOW_OPERATION_END, opEndHandler);
inputTextFlow.flowComposer.updateAllControllers();
}
private function opBeginHandler(evt:FlowOperationEvent):void {
var flowOp:FlowOperation = evt.operation;
if(flowOp is PasteOperation) {
trace("You can cancel or modify the paste operation in this event handler.");
}
}
private function opEndHandler(evt:FlowOperationEvent):void {
var flowOp:FlowOperation = evt.operation;
if(evt.error) {
trace("You can handle the error here and call preventDefault().");
}
}
}
}
Tue Jun 12 2018, 09:30 AM Z