Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
FlowOperationEvent

Package | flashx.textLayout.events
Class | public class FlowOperationEvent
Inheritance | FlowOperationEvent flash.events.Event

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

A TextFlow instance dispatches this event just before an operation commences and again just after an operation completes. Although the event object dispatched in both cases is an instance of FlowOperationEvent, the events dispatched before and after an operation differ in significant ways.

Before any operation is carried out, a TextFlow object dispatches a FlowOperationEvent with its `type` property set to `FlowOperationEvent.FLOW_OPERATION_BEGIN.` You can determine what type of operation is about to commence by checking the `operation` property. Events of type FLOW_OPERATION_BEGIN are cancellable, which means that if you decide that the operation should not proceed, you can call `Event.PreventDefault()` to cancel the operation. If you cancel the operation, the operation is not performed and the FLOW_OPERATION_END event is not dispatched. You may also choose to call back into the EditManager to do another operation before the operation that triggered the event is done. If you do this, the operations you initiate in your event handler will be undone as a single operation with the operation that triggered the event.

If you allow the operation to proceed, TextFlow will dispatch a FlowOperationEvent upon completion of the operation with its `type` property set to `FlowOperationEvent.FLOW_OPERATION_END`. This event is dispatched before Flash Player throws any errors that may have occurred as a result of the operation. This gives you an opportunity to process the error before Flash Player throws the error. You can access the error through the event's `error` property. If you choose to handle the error in your event handler, you can prevent Flash Player from throwing the error by cancelling the FLOW_OPERATION_END event by calling `Event.preventDefault()`. You may also choose to call back into the EditManager to do some additional operations. If you do this, the operations that result will be undone as a unit with the operation that triggered the event.

See also

flashx.textLayout.operations.FlowOperation

Public Properties

| Property | Defined By
--- | --- | ---
|  | error : Error The error thrown, if any, during an operation. | FlowOperationEvent
|  | level : int Operations may be merged into composite operations through nesting. | FlowOperationEvent
|  | operation : FlowOperation The operation that is about to begin or has just ended. | FlowOperationEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | FlowOperationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, operation:FlowOperation = null, level:int = 0, error:Error = null) Creates an event object that contains information about a flow operation. | FlowOperationEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | FLOW_OPERATION_BEGIN : String = flowOperationBegin [static] Defines the value of the type property of a flowOperationBegin event object. | FlowOperationEvent
|  | FLOW_OPERATION_COMPLETE : String = flowOperationComplete [static] Defines the value of the type property of a flowOperationComplete event object. | FlowOperationEvent
|  | FLOW_OPERATION_END : String = flowOperationEnd [static] Defines the value of the type property of a flowOperationEnd event object. | FlowOperationEvent

Property Detail

error | property

`error:Error`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The error thrown, if any, during an operation. If an error occurs during an operation, a reference to the error object is attached to the FLOW_OPERATION_END event. This give you the opportunity to deal with the error before Flash Player throws the error. If you cancel the event, Flash Player will not throw the error.

Implementation
`public function get error():Error`
`public function set error(value:Error):void`

level | property |

`level:int`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Operations may be merged into composite operations through nesting. This flag describes the nesting level of the operation.

Implementation
`public function get level():int`
`public function set level(value:int):void`

operation | property |

`operation:FlowOperation`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The operation that is about to begin or has just ended.

Implementation
`public function get operation():FlowOperation`
`public function set operation(value:FlowOperation):void`

See also

flashx.textLayout.operations.FlowOperation
Constructor Detail

FlowOperationEvent | () | Constructor

`public function FlowOperationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, operation:FlowOperation = null, level:int = 0, error:Error = null)`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Creates an event object that contains information about a flow operation.

Parameters

| `type:String` — The type of the event. Event listeners can access this information through the inherited `type` property. There are two types: `FlowOperationEvent.FLOW_OPERATION_BEGIN`; `FlowOperationEvent.FLOW_OPERATION_END`.
| `bubbles:Boolean` (default = `false`)`` — Indicates whether an event is a bubbling event.This event does not bubble.
| `cancelable:Boolean` (default = `false`)`` — Indicates whether the behavior associated with the event can be prevented. This event can be cancelled by calling the `Event.preventDefault()` method in your event handler function.
| `operation:FlowOperation` (default = `null`)`` — The FlowOperation that is about to commence or that has just ended.
| `level:int` (default = `0`)`` — Any Error generating during the operation.
| `error:Error` (default = `null`)``

Constant Detail

FLOW_OPERATION_BEGIN | Constant

`public static const FLOW_OPERATION_BEGIN:String = flowOperationBegin`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Defines the value of the `type` property of a `flowOperationBegin` event object. Dispatched before an operation is executed. Cancelling this event blocks the operation.

FLOW_OPERATION_COMPLETE | Constant |

`public static const FLOW_OPERATION_COMPLETE:String = flowOperationComplete`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Defines the value of the `type` property of a `flowOperationComplete` event object. Dispatched after all operations including pending and composite operations are completed, composition is finished and the display is scrolled.

FLOW_OPERATION_END | Constant |

`public static const FLOW_OPERATION_END:String = flowOperationEnd`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Defines the value of the `type` property of a `flowOperationEnd` event object. Dispatched after an operation completes. Any errors are stored in `OperationEvent.error`. If there is an error, cancelling this event blocks the rethrow of the error. Generally speaking all errors are likely to be fatal.

Changing an operation at this time (after it has been executed) may fail.

Sun Mar 5 2017, 03:42 PM +11:00