Paquete | flashx.textLayout.events |
Clase | public class FlowOperationEvent |
Herencia | FlowOperationEvent Event Object |
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Antes de que se realice ninguna operación, el objeto TextFlow distribuye un evento FlowOperationEvent con su propiedad type
establecida como FlowOperationEvent.FLOW_OPERATION_BEGIN.
Puede determinar qué tipo de operación va a comenzar a comprobar verificando la propiedad operation
. Los eventos de tipo FLOW_OPERATION_BEGIN son cancelables, es decir, que si el usuario decide que la operación debe detenerse, puede llamar al método Event.PreventDefault()
para cancelar la operación. Si cancela la operación, ésta no se lleva a cabo y el evento FLOW_OPERATION_END no se distribuye. También puede decidir volver a llamar a EditManager para realizar algunas operaciones antes de que se lleve a cabo la operación que desencadenó el evento. Si lo hace, podrá deshacer las operaciones del detector de evento como si fuera una sola operación con la operación que desencadenó el evento.
Si permite que la operación continúe, TextFlow distribuirá un evento FlowOperationEvent cuando termine la operación con su propiedad type
establecida como FlowOperationEvent.FLOW_OPERATION_END
. Este evento se distribuye antes de que Flash Player emita cualquier error que pueda haberse producido como resultado de la operación. Esto permite procesar el error antes de que Flash Player lo emita. Puede acceder al error desde la propiedad error
del evento. Si decide gestionar el error con su gestor de eventos, puede evitar que Flash Player emita el error si cancela el evento FLOW_OPERATION_END llamando a Event.preventDefault()
. También puede decidir volver a llamar a EditManager para realizar más operaciones. Si lo hace, las operaciones resultantes se podrán deshacer como una sola desde el evento.
Elementos de API relacionados
Propiedad | Definido por | ||
---|---|---|---|
bubbles : Boolean [solo lectura]
Indica si un evento es un evento de propagación. | Event | ||
cancelable : Boolean [solo lectura]
Indica si se puede evitar el comportamiento asociado al evento. | Event | ||
constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | Object | ||
currentTarget : Object [solo lectura]
Objeto que procesa de forma activa el objeto de evento con un detector de eventos. | Event | ||
error : Error
El error generado, si existe, durante una operación. | FlowOperationEvent | ||
eventPhase : uint [solo lectura]
La fase actual en el flujo del evento. | Event | ||
level : int
Las operaciones pueden combinarse en operaciones compuestas mediante anidación. | FlowOperationEvent | ||
operation : FlowOperation
La operación que va a comenzar o acaba de terminar. | FlowOperationEvent | ||
target : Object [solo lectura]
El destino del evento. | Event | ||
type : String [solo lectura]
El tipo de evento. | Event |
Método | Definido por | ||
---|---|---|---|
FlowOperationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, operation:FlowOperation = null, level:int = 0, error:Error = null) Crea un objeto de evento que contiene información sobre una operación de flujo. | FlowOperationEvent | ||
Duplica una instancia de la subclase Event. | Event | ||
Una función de utilidad para implementar el método toString() en las clases Event personalizadas de ActionScript 3.0. | Event | ||
Indica si un objeto tiene definida una propiedad especificada. | Object | ||
Comprueba si se ha llamado a preventDefault() en el evento. | Event | ||
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | ||
Cancela el comportamiento predeterminado de un evento si es posible cancelarlo. | Event | ||
Indica si existe la propiedad especificada y si es enumerable. | Object | ||
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | ||
Impide el proceso de cualquier detector de eventos en el nodo actual y los nodos siguientes en el flujo del evento. | Event | ||
Impide el proceso de cualquier detector de eventos en nodos siguientes al nodo actual. | Event | ||
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | ||
Devuelve una cadena que contiene todas las propiedades del objeto de evento. | Event | ||
Devuelve el valor simple del objeto especificado. | Object |
Constante | Definido por | ||
---|---|---|---|
FLOW_OPERATION_BEGIN : String = "flowOperationBegin" [estática]
Define el valor de la propiedad type de un objeto de evento flowOperationBegin. | FlowOperationEvent | ||
FLOW_OPERATION_COMPLETE : String = "flowOperationComplete" [estática]
Define el valor de la propiedad type de un objeto de evento flowOperationComplete. | FlowOperationEvent | ||
FLOW_OPERATION_END : String = "flowOperationEnd" [estática]
Define el valor de la propiedad type de un objeto de evento flowOperationEnd. | FlowOperationEvent |
error | propiedad |
error:Error
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
El error generado, si existe, durante una operación. Si se produce un error durante una operación, se asocia una referencia al objeto de error en el evento FLOW_OPERATION_END. Esto permite gestionar el error antes de que Flash Player lo emita. Si cancela este evento, Flash Player no emite el error.
Implementación
public function get error():Error
public function set error(value:Error):void
level | propiedad |
level:int
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Las operaciones pueden combinarse en operaciones compuestas mediante anidación. Este indicador describe el nivel de anidación de la operación.
Implementación
public function get level():int
public function set level(value:int):void
operation | propiedad |
operation:FlowOperation
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
La operación que va a comenzar o acaba de terminar.
Implementación
public function get operation():FlowOperation
public function set operation(value:FlowOperation):void
Elementos de API relacionados
FlowOperationEvent | () | Información sobre |
public function FlowOperationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, operation:FlowOperation = null, level:int = 0, error:Error = null)
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Crea un objeto de evento que contiene información sobre una operación de flujo.
Parámetrostype:String — El tipo de evento. Los detectores de eventos pueden acceder a esta información a través de la propiedad type heredada. Hay dos tipos: FlowOperationEvent.FLOW_OPERATION_BEGIN ; FlowOperationEvent.FLOW_OPERATION_END .
| |
bubbles:Boolean (default = false ) — Indica si un evento es de propagación. Este evento no es de propagación.
| |
cancelable:Boolean (default = false ) — Indica si se puede evitar el comportamiento asociado al evento. Este evento se puede cancelar llamando al método Event.preventDefault() de su función de controlador de eventos.
| |
operation:FlowOperation (default = null ) — La operación FlowOperation que va a comenzar o acaba de terminar.
| |
level:int (default = 0 ) — Cualquier error generado durante la operación.
| |
error:Error (default = null )
|
FLOW_OPERATION_BEGIN | Constante |
public static const FLOW_OPERATION_BEGIN:String = "flowOperationBegin"
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Define el valor de la propiedad type
de un objeto de evento flowOperationBegin
. Se distribuye antes de que se ejecute ninguna operación. Si se cancela este evento, se bloquea la operación.
FLOW_OPERATION_COMPLETE | Constante |
public static const FLOW_OPERATION_COMPLETE:String = "flowOperationComplete"
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Define el valor de la propiedad type
para un objeto de evento flowOperationComplete
Se distribuye una vez que todas las operaciones pendientes de composición han finalizado, la composición ha terminado y la visualización se ha desplazado.
FLOW_OPERATION_END | Constante |
public static const FLOW_OPERATION_END:String = "flowOperationEnd"
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Define el valor de la propiedad type
de un objeto de evento flowOperationEnd
. Se distribuye antes de que se ejecute ninguna operación. Todos los errores se guardan en OperationEvent.error
. Si se produce un error, cancelar este evento bloqueará la redifusión del mismo. Por norma general, todos los errores son graves.
Cambiar una operación en este momento (una vez ejecutada) es probable que falle.
Este ejemplo muestra cómo crear un controlador de eventos que detecte el principio y el final de una operación de flujo de texto. Los dos pasos principales son llamar al método addEventListener()
en el flujo de texto y crear una función de controlador de eventos.
La llamada a addEventListener()
se realiza en la instancia de TextFlow. Puede utilizar la simple cadena "flowOperationBegin"
o "flowOperationEnd"
, pero es más seguro utilizar la constante estática FlowOperationEvent.FLOW_OPERATION_BEGIN
o FlowOperationEvent.FLOW_OPERATION_END
, respectivamente.
Las funciones del controlador de eventos en este ejemplo se denominan opBeginHandler()
y opEndHandler()
. El método opBeginHandler()
utiliza la función trace()
para producir una sentencia trace que indica que una operación Pegar ha comenzado. El método opEndHandler()
también utiliza la función trace()
, pero produce una sentencia trace sólo si se produce un error.
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, 02:12 PM Z