Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The FlowOperation class is the base class for all Text Layout Framework operations.
Operations are transformations of a text flow. An Operation class defines the
logic for performing and undoing the transformation. Operations are executed by an
edit manager. Most applications do not need to create or manage operations directly
(unless implementing a custom edit manager).
When an operation is performed, the edit manager dispatches an Operation object
within the FlowOperationEvent object. You can query
this Operation object to decide whether or not to allow the operation, to decide whether
to perform some other operation as well, or to update related user-interface elements.
beginGeneration:uint
[read-only]
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The text flow generation before the operation.
A generation of 0 indicates that the operation did not complete.
Implementation public function get beginGeneration():uint
endGeneration:uint
[read-only]
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The text flow generation after the operation.
A generation of 0 indicates that the operation did not complete.
Implementation public function get endGeneration():uint
textFlow:TextFlow
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The TextFlow object to which this operation is applied.
Implementation public function get textFlow():TextFlow
public function set textFlow(value:TextFlow):void
public var userData:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Arbitrary data associated with an element.
public function FlowOperation(textFlow:TextFlow)
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Creates the FlowOperation object.
Parameters | textFlow:TextFlow — The text flow to which this operation is applied.
|
public function canUndo():Boolean
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Test if this operation be placed on the undo stack.
Returns | Boolean — true means to push the operation onto the undo stack. false means do not push this operation.
|
public function doOperation():Boolean
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Executes the operation.
This method must be overridden in derived classes. The base class method does nothing.
You should not call doOperation()
directly. The edit manager
calls the method when it executes the operation.
Returns | Boolean — Boolean true , if the operation succeeded. Otherwise, false .
|
public function redo():SelectionState
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Re-executes the operation.
This method must be overridden in derived classes. The base class method does nothing.
You should not call redo()
directly. The edit manager
calls the method when it re-executes the operation.
Returns | SelectionState — The SelectionState object passed to the operation when it was performed. This
SelectionState object can be the current selection or a selection created specifically
for the operation.
|
public function undo():SelectionState
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Reverses the operation.
This method must be overridden in derived classes. The base class method does nothing.
You should not call undo()
directly. The edit manager
calls the method when it reverses the operation.
Returns | SelectionState — The SelectionState object passed to the operation when it was performed. This
SelectionState object can be the current selection or a selection created specifically
for the operation.
|
Mon Feb 18 2013, 01:33 PM +11:00