Package | flashx.textLayout.operations |
Class | public class UndoOperation |
Inheritance | UndoOperation FlowOperation Object |
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Related API Elements
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 | ||
operation : FlowOperation
The operation to undo. | UndoOperation | ||
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 |
Public Methods
Method | Defined By | ||
---|---|---|---|
Creates an UndoOperation object. | UndoOperation | ||
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 |
Property Detail
operation | property |
operation:FlowOperation
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The operation to undo.
Implementation
public function get operation():FlowOperation
public function set operation(value:FlowOperation):void
Constructor Detail
UndoOperation | () | Constructor |
public function UndoOperation(op:FlowOperation)
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Creates an UndoOperation object.
Parametersop:FlowOperation — The operation to undo.
|
Examples How to use this example
UndoOperation_example.as
This code snippet shows a use of the UndoOperation
class.
In this example, an event handler captures the beginning of a flow operation.
Undo operations can be verified or canceled.
package flashx.textLayout.operations.examples { import flashx.textLayout.elements.TextFlow; import flashx.textLayout.events.FlowOperationEvent; import flashx.textLayout.operations.FlowOperation; import flashx.textLayout.operations.UndoOperation; public class UndoOperation_example { public function attach(textFlow:TextFlow):void { textFlow.addEventListener(FlowOperationEvent.FLOW_OPERATION_BEGIN, opBeginHandler); } public function opBeginHandler(evt:FlowOperationEvent):void { var flowOp:FlowOperation = evt.operation; if(flowOp is UndoOperation) { //user has the option to cancel undo operation if(!verifyUndo(flowOp.textFlow) && evt.cancelable) { evt.preventDefault(); } } } private function verifyUndo(tf:TextFlow):Boolean { //verify whether user wants to undo this operation return false; } } }
Mon Nov 28 2011, 06:48 AM -08:00