Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flashx.textLayout.operations 
UndoOperation 
Packageflashx.textLayout.operations
Classpublic class UndoOperation
InheritanceUndoOperation Inheritance FlowOperation Inheritance Object

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

The UndoOperation class encapsulates an undo operation.

View the examples

See also



Public Properties
 PropertyDefined By
 InheritedbeginGeneration : uint
[read-only] The text flow generation before the operation.
FlowOperation
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedendGeneration : uint
[read-only] The text flow generation after the operation.
FlowOperation
  operation : FlowOperation
The operation to undo.
UndoOperation
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedtextFlow : flashx.textLayout.elements:TextFlow
The TextFlow object to which this operation is applied.
FlowOperation
 InheriteduserData : *
Arbitrary data associated with an element.
FlowOperation
Public Methods
 MethodDefined By
  
Creates an UndoOperation object.
UndoOperation
 Inherited
Test if this operation be placed on the undo stack.
FlowOperation
 Inherited
Executes the operation.
FlowOperation
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Re-executes the operation.
FlowOperation
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Reverses the operation.
FlowOperation
 Inherited
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.

Parameters
op:FlowOperation — The operation to undo.
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;
        }
    }
}