flashx.undo

# IUndoManager - AS3

Package | flashx.undo
Interface | public interface IUndoManager
Implementors | UndoManager

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

IUndoManager defines the interface for managing the undo and redo stacks.

An undo manager maintains a stack of operations that can be undone and redone.

Public Properties

| Property | Defined By
--- | --- | ---
|  | undoAndRedoItemLimit : int The maximum number of undoable or redoable operations to track. | IUndoManager

Public Methods

| Method | Defined By
--- | --- | ---
|  | canRedo():Boolean Indicates whether there is currently an operation that can be redone. | IUndoManager
|  | canUndo():Boolean Indicates whether there is currently an operation that can be undone. | IUndoManager
|  | clearAll():void Clears both the undo and the redo histories. | IUndoManager
|  | clearRedo():void Clears the redo stack. | IUndoManager
|  | peekRedo():IOperation Returns the next operation to be redone. | IUndoManager
|  | peekUndo():IOperation Returns the next operation to be undone. | IUndoManager
|  | popRedo():IOperation Removes the next operation to be redone from the redo stack, and returns it. | IUndoManager
|  | popUndo():IOperation Removes the next operation to be undone from the undo stack, and returns it. | IUndoManager
|  | pushRedo(operation:IOperation):void Adds a redoable operation to the redo stack. | IUndoManager
|  | pushUndo(operation:IOperation):void Adds an undoable operation to the undo stack. | IUndoManager
|  | redo():void Removes the next IOperation object from the redo stack and calls the performRedo() function of that object. | IUndoManager
|  | undo():void Removes the next IOperation object from the undo stack and calls the performUndo() function of that object. | IUndoManager

Property Detail

### undoAndRedoItemLimit

property

`undoAndRedoItemLimit:int`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The maximum number of undoable or redoable operations to track.

To disable the undo function, set this value to 0.

Implementation
`public function get undoAndRedoItemLimit():int`
`public function set undoAndRedoItemLimit(value:int):void`
Method Detail

### canRedo

()
method

`public function canRedo():Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Indicates whether there is currently an operation that can be redone.

Returns

| `Boolean` — Boolean `true`, if there is an operation on the redo stack that can be redone. Otherwise, `false`.

### canUndo

()
method

`public function canUndo():Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Indicates whether there is currently an operation that can be undone.

Returns

| `Boolean` — Boolean `true`, if there is an operation on the undo stack that can be reversed. Otherwise, `false`.

### clearAll

()
method

`public function clearAll():void`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Clears both the undo and the redo histories.

### clearRedo

()
method

`public function clearRedo():void`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Clears the redo stack.

### peekRedo

()
method

`public function peekRedo():IOperation`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the next operation to be redone.

Returns

| `IOperation` — The redoable IOperation object, or `null`, if no redoable operation is on the stack.

### peekUndo

()
method

`public function peekUndo():IOperation`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the next operation to be undone.

Returns

| `IOperation` — The undoable IOperation object, or `null`, if no undoable operation is on the stack.

### popRedo

()
method

`public function popRedo():IOperation`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Removes the next operation to be redone from the redo stack, and returns it.

Returns

| `IOperation` — The redoable IOperation object, or `null`, if no redoable operation is on the stack.

### popUndo

()
method

`public function popUndo():IOperation`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Removes the next operation to be undone from the undo stack, and returns it.

Returns

| `IOperation` — The undoable IOperation object, or `null`, if no undoable operation is on the stack.

### pushRedo

()
method

`public function pushRedo(operation:IOperation):void`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Adds a redoable operation to the redo stack.

Parameters

| `operation:IOperation`

### pushUndo

()
method

`public function pushUndo(operation:IOperation):void`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Adds an undoable operation to the undo stack.

Parameters

| `operation:IOperation`

### redo

()
method

`public function redo():void`

Removes the next IOperation object from the redo stack and calls the performRedo() function of that object.

Related API Elements

flashx.textLayout.edit.IEditManager.redo()
flashx.undo.IUndoManager.canRedo()
flashx.undo.IUndoManager.clearRedo()
flashx.undo.IUndoManager.peekRedo()
flashx.undo.IUndoManager.pushRedo()
flashx.undo.IUndoManager.popRedo()

### undo

()
method

`public function undo():void`

Removes the next IOperation object from the undo stack and calls the performUndo() function of that object.

Related API Elements

flashx.textLayout.edit.IEditManager.undo()
flashx.undo.IUndoManager.canUndo()
flashx.undo.IUndoManager.clearUndo()
flashx.undo.IUndoManager.peekUndo()
flashx.undo.IUndoManager.pushUndo()
flashx.undo.IUndoManager.popUndo()

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00