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.
*
type property of a flowOperationBegin event object.
* Dispatched before an operation is executed. Cancelling this event blocks the operation.
* @playerversion Flash 10
* @playerversion AIR 1.5
* @langversion 3.0
*/
public static const FLOW_OPERATION_BEGIN:String = "flowOperationBegin";
/**
* 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.
* @playerversion Flash 10 * @playerversion AIR 1.5 * @langversion 3.0 */ public static const FLOW_OPERATION_END:String = "flowOperationEnd"; /** * Defines the value of thetype 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.
* @playerversion Flash 10
* @playerversion AIR 1.5
* @langversion 3.0
*/
public static const FLOW_OPERATION_COMPLETE:String = "flowOperationComplete";
private var _op:FlowOperation;
private var _e:Error;
private var _level:int;
/**
* The operation that is about to begin or has just ended.
*
* @playerversion Flash 10
* @playerversion AIR 1.5
* @langversion 3.0
* @see flashx.textLayout.operations.FlowOperation
*/
public function get operation():FlowOperation
{ return _op; }
public function set operation(value:FlowOperation):void
{ _op = value; }
/**
* 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.
* @playerversion Flash 10
* @playerversion AIR 1.5
* @langversion 3.0
*/
public function get error():Error
{ return _e; }
public function set error(value:Error):void
{ _e = value; }
/**
* Operations may be merged into composite operations through nesting. This flag describes the nesting level of the operation.
* @playerversion Flash 10
* @playerversion AIR 1.5
* @langversion 3.0
*/
public function get level():int
{ return _level; }
public function set level(value:int):void
{ _level = value; }
/** Creates an event object that contains information about a flow operation.
* @param type 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.
* @param bubbles Indicates whether an event is a bubbling event.This event does not bubble.
* @param cancelable 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.
* @param operation The FlowOperation that is about to commence or that has just ended.
* @param error Any Error generating during the operation.
* @playerversion Flash 10
* @playerversion AIR 1.5
* @langversion 3.0
*/
public function FlowOperationEvent(type:String, bubbles:Boolean=false, cancelable:Boolean=false, operation:FlowOperation = null, level:int = 0, error:Error = null)
{
_op = operation;
_e = error;
_level = level;
super(type, bubbles, cancelable);
}
/** @private */
override public function clone():Event
{
return new FlowOperationEvent(type, bubbles, cancelable, _op, _level, _e);
}
}
}