| Package | flashx.textLayout.operations |
| Class | public class FlowOperation |
| Inheritance | FlowOperation  Object |
| Implements | IOperation |
| Subclasses | CompositeOperation, FlowTextOperation, RedoOperation, TextInputOperation, UndoOperation |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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.
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| beginGeneration : uint [read-only]
The text flow generation before the operation. | FlowOperation | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| endGeneration : uint [read-only]
The text flow generation after the operation. | FlowOperation | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| textFlow : flashx.textLayout.elements:TextFlow
The TextFlow object to which this operation is applied. | FlowOperation | ||
| userData : *
Arbitrary data associated with an element. | FlowOperation | ||
| Method | Defined By | ||
|---|---|---|---|
Creates the FlowOperation object. | FlowOperation | ||
Test if this operation be placed on the undo stack. | FlowOperation | ||
Executes the operation. | FlowOperation | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
Re-executes the operation. | FlowOperation | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
Reverses the operation. | FlowOperation | ||
|
Returns the primitive value of the specified object. | Object | |
beginGeneration | property |
endGeneration | property |
textFlow | property |
textFlow:flashx.textLayout.elements: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():flashx.textLayout.elements:TextFlow public function set textFlow(value:flashx.textLayout.elements:TextFlow):voiduserData | property |
public var userData:*| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Arbitrary data associated with an element.
FlowOperation | () | Constructor |
public function FlowOperation(textFlow:flashx.textLayout.elements:TextFlow)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Creates the FlowOperation object.
ParameterstextFlow:flashx.textLayout.elements:TextFlow — The text flow to which this operation is applied.
|
canUndo | () | method |
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.
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.
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.
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 Nov 28 2011, 06:48 AM -08:00