Packageflashx.textLayout.operations
Classpublic class FlowOperation
InheritanceFlowOperation Inheritance Object
Implements IOperation
Subclasses CompositeOperation, FlowTextOperation, RedoOperation, TextInputOperation, UndoOperation

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.

See also

flashx.textLayout.events.FlowOperationEvent
flashx.textLayout.edit.EditManager

Public Properties
 PropertyDefined By
  beginGeneration : uint
[read-only] The text flow generation before the operation.
FlowOperation
  endGeneration : uint
[read-only] The text flow generation after the operation.
FlowOperation
  textFlow : TextFlow
The TextFlow object to which this operation is applied.
FlowOperation
  userData : *
Arbitrary data associated with an element.
FlowOperation
Public Methods
 MethodDefined By
  
FlowOperation(textFlow:TextFlow)
Creates the FlowOperation object.
FlowOperation
  
canUndo():Boolean
Test if this operation be placed on the undo stack.
FlowOperation
  
doOperation():Boolean
Executes the operation.
FlowOperation
  
redo():SelectionState
Re-executes the operation.
FlowOperation
  
undo():SelectionState
Reverses the operation.
FlowOperation
Property Detail
beginGenerationproperty
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
endGenerationproperty 
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
textFlowproperty 
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
userDataproperty 
public var userData:*

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Arbitrary data associated with an element.

Constructor Detail
FlowOperation()Constructor
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.
Method Detail
canUndo()method
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.
doOperation()method 
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.
redo()method 
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.
undo()method 
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.



The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00