UndoRedo V1.2
by Matthew Ford
2005/06/27
A B C D E F G H I P R S T U V

A

addEdit(UndoableEdit) - Method in class au.com.forward.undoRedo.UndoRedo
Does nothing, always returns false.
ALL_REDONE_PREFIX - Static variable in class au.com.forward.undoRedo.UndoRedo
Prefix for all nodes redone.
au.com.forward.undoRedo - package au.com.forward.undoRedo
The UndoRedoManager class is the main class for this package, TestUndoRedo is a test application.
Run the jar file to start the test application.

B

BRANCH_UNDOABLE_EDIT - Static variable in class au.com.forward.undoRedo.BranchUndoRedo
 
BranchDefaultMutableTreeNode - Class in au.com.forward.undoRedo
A mutable tree node to hold Redo branches.
BranchDefaultMutableTreeNode(BranchUndoRedo) - Constructor for class au.com.forward.undoRedo.BranchDefaultMutableTreeNode
BranchDefaultMutableTreeNode constructor
BranchUndoRedo - Class in au.com.forward.undoRedo
An UndoRedo node that starts a Redo Branch.
BranchUndoRedo() - Constructor for class au.com.forward.undoRedo.BranchUndoRedo
Creates a new instance of BranchUndoRedo.
BranchUndoRedo.BranchUndoableEdit - Class in au.com.forward.undoRedo
A dummy UndoableEdit for the BranchUndoRedo node to wrap.

C

cancel(Long) - Method in class au.com.forward.undoRedo.UndoRedoManager
Rolls back undo/redo to the last command that failed.
cancel() - Method in class au.com.forward.undoRedo.UndoRedoManager.TextAreaWrapper
 
cancelGetDescription() - Method in class au.com.forward.undoRedo.BranchDefaultMutableTreeNode
Cancels getDescription Forwards request to the deepest node
cancelGetDescription() - Method in interface au.com.forward.undoRedo.IHaveDescription
Cancels IHaveDescription.getDescription(au.com.forward.undoRedo.IDisplayText, au.com.forward.undoRedo.UndoRedoTreeNode).
cancelGetDescription() - Method in class au.com.forward.undoRedo.UndoRedoEdit
Cancels getDescription
This is called when the undo/redo tree selection changes to cancel the previous getDescription.
canRedo() - Method in class au.com.forward.undoRedo.UndoRedo
True if it is still possible to redo this operation.
canRedo() - Method in class au.com.forward.undoRedo.UndoRedoManager
Is there a redo branch at the top that can be redone, does not check for dead nodes.
canUndo() - Method in class au.com.forward.undoRedo.UndoRedo
True if it is still possible to undo this operation.
canUndo() - Method in class au.com.forward.undoRedo.UndoRedoManager
Is there an undo node in the main trunk that can be undone, does not check for dead nodes.
clone() - Method in class au.com.forward.undoRedo.UndoRedo
Returns the clone of this UndoRedo.
clone() - Method in class au.com.forward.undoRedo.UndoRedoTreeNode
Clone the undo/redo tree structure.
compressFullPath(Vector<UndoRedoTreeNode>) - Method in class au.com.forward.undoRedo.UndoRedoManager
Go through the vector and cancel (remove) redo/undo adjacent pairs
Input arg is unchanged.

D

DEAD_FORMAT - Static variable in class au.com.forward.undoRedo.UndoRedo
Prefix for dead nodes
description - Variable in class au.com.forward.undoRedo.UndoRedoEdit
 
die() - Method in class au.com.forward.undoRedo.UndoRedo
May be sent to inform an edit that it should no longer be used.
disposeOfRollBack(Long) - Method in class au.com.forward.undoRedo.UndoRedoManager
Frees the resources associated with a frameMarker.

E

edit - Variable in class au.com.forward.undoRedo.UndoRedo
the wrapped edit
equalsComplement(UndoRedo) - Method in class au.com.forward.undoRedo.BranchUndoRedo
Returns true if the obj is the complement of this BranchUndoRedo.
equalsComplement(Object) - Method in class au.com.forward.undoRedo.UndoRedo
Returns true if the obj is the complement of this UndoRedo.
equalsComplement(UndoRedoTreeNode, UndoRedoTreeNode) - Static method in class au.com.forward.undoRedo.UndoRedoManager
Compare two DefaultMutableTreeNodes for UndoRedo complements.
escapeHTML(String) - Static method in class au.com.forward.undoRedo.UndoRedo
 

F

frameMarkerMap - Variable in class au.com.forward.undoRedo.UndoRedoManager
A map holding weak keys to the tree frames.

G

getBranchSuffix() - Method in class au.com.forward.undoRedo.BranchUndoRedo
Returns the current suffix.
getComplement() - Method in class au.com.forward.undoRedo.BranchUndoRedo
Get the complement of this object, keep reference to edit.
getComplement() - Method in class au.com.forward.undoRedo.UndoRedo
Returns the UndoRedo complement of this object.
getDeepestNode() - Method in class au.com.forward.undoRedo.BranchDefaultMutableTreeNode
 
getDescription(IDisplayText, UndoRedoTreeNode) - Method in class au.com.forward.undoRedo.BranchDefaultMutableTreeNode
Gets the Description of the UndoableEdit.
getDescription(IDisplayText, UndoRedoTreeNode) - Method in interface au.com.forward.undoRedo.IHaveDescription
Gets the Description of the UndoableEdit.
getDescription(IDisplayText) - Method in class au.com.forward.undoRedo.UndoRedoEdit
Gets the Description of the UndoableEdit.
getFrameMarker() - Method in interface au.com.forward.undoRedo.ICanBeRolledBack
Returns the last frameMarker set.
getFrameMarker() - Method in class au.com.forward.undoRedo.UndoRedoEdit
Returns the last frameMarker set
Because the frameMarker is set for the original edit and every subsequent undo/redo of it, the frameMarker needs to be saved with the task preforming the operation.
getMaxDepth() - Method in class au.com.forward.undoRedo.BranchDefaultMutableTreeNode
Get the maximum depth of this branch.
getPostTreeRootNode() - Method in class au.com.forward.undoRedo.UndoRedoManager.Frame
 
getPreferredSize() - Method in class au.com.forward.undoRedo.UndoRedoManager.WidthEnabledCellRenderer
Overrides JComponent.getPreferredSize to return slightly wider preferred size value.
getPresentationName() - Method in class au.com.forward.undoRedo.BranchUndoRedo.BranchUndoableEdit
 
getPresentationName() - Method in class au.com.forward.undoRedo.UndoRedo
Provides a localized, human readable description of this edit , should be detailed enough to provide a the basis of a meaningful node lable.
getPreTreeRootNode() - Method in class au.com.forward.undoRedo.UndoRedoManager.Frame
Reconstucts the original tree from the rootTree and the tail
It also resets the undo flag on each cloned node.
getRedoPresentationName() - Method in class au.com.forward.undoRedo.BranchUndoRedo.BranchUndoableEdit
 
getRedoPresentationName() - Method in class au.com.forward.undoRedo.UndoRedo
Provides a localized, human readable description of the redoable form of this edit.
getRoot() - Method in class au.com.forward.undoRedo.UndoRedoManager
Returns the root node of the tree
getTextDisplayComponent() - Method in class au.com.forward.undoRedo.UndoRedoManager
Get the Component used to display extended descriptions
getTree() - Method in class au.com.forward.undoRedo.UndoRedoManager
Get the JTree to display
getUndoableEdit() - Method in class au.com.forward.undoRedo.UndoRedo
Returns the UndoableEdit wrapped by this UndoRedo
getUndoableEdit() - Method in class au.com.forward.undoRedo.UndoRedoTreeNode
Get the undoableEdit held by this node
getUndoPresentationName() - Method in class au.com.forward.undoRedo.BranchUndoRedo.BranchUndoableEdit
 
getUndoPresentationName() - Method in class au.com.forward.undoRedo.UndoRedo
Provides a localized, human readable description of the undoable form of this edit.

H

HTML_START - Static variable in class au.com.forward.undoRedo.UndoRedo
Prefix for HTML

I

ICanBeRolledBack - Interface in au.com.forward.undoRedo
This interface marks an UndoableEdit as being able to roll back the undo/redo tree in the event that it fails or is cancelled.
IDisplayText - Interface in au.com.forward.undoRedo
This interface marks a class as being able to display text using setText(str).
IHaveDescription - Interface in au.com.forward.undoRedo
This interface indicates that the UndoableEdit has a long description that gives more information then the getPresentationName()
INSIGNIFICANT_FORMAT - Static variable in class au.com.forward.undoRedo.UndoRedo
Prefix for insignificant nodes
isBlocked() - Method in class au.com.forward.undoRedo.UndoRedoManager
Is UndoRedoManager currently blocked from accepting undo,redo or processUndoRedoCommand commands
Note: isBlocked() == true does not prevent undoableEditHappened() from processing new undoable events.
isBusy() - Method in class au.com.forward.undoRedo.UndoRedoManager
Is the manager busy doing something.
isBusyOrBlocked() - Method in class au.com.forward.undoRedo.UndoRedoManager
Is UndoRedoManager busy or blocked?
isDead() - Method in class au.com.forward.undoRedo.UndoRedo
Is the wrapped UndoableEdit dead
isFirstChildReDone(BranchDefaultMutableTreeNode) - Static method in class au.com.forward.undoRedo.BranchDefaultMutableTreeNode
Checks the first child of this branch to see if it has been redone.
isSignificant() - Method in class au.com.forward.undoRedo.UndoRedo
Returns false if this edit is insignificant--for example one that maintains the user's selection, but does not change any model state.
isUndo() - Method in class au.com.forward.undoRedo.UndoRedo
Returns true if this is the undo version.
isUnreachable() - Method in class au.com.forward.undoRedo.UndoRedo
Returns true if thie undo/redo cannot be reached.

P

preferredWidth - Variable in class au.com.forward.undoRedo.UndoRedoManager
The preferred width of the tree node text displays.
PresentationName - Static variable in class au.com.forward.undoRedo.BranchUndoRedo.BranchUndoableEdit
 
processUndoRedoCommand() - Method in class au.com.forward.undoRedo.UndoRedoManager
Undo/redo to the selected tree node.

R

redo() - Method in class au.com.forward.undoRedo.UndoRedo
Re-apply the edit, assuming that it has been undone.
redo() - Method in class au.com.forward.undoRedo.UndoRedoManager
Find the top redo and redo it.
REDONE_PREFIX - Static variable in class au.com.forward.undoRedo.UndoRedo
Prefix for redone nodes
replaceEdit(UndoableEdit) - Method in class au.com.forward.undoRedo.UndoRedo
Does nothing, always returns false.
rootNode - Variable in class au.com.forward.undoRedo.UndoRedoManager
The rootNode of the tree model.

S

setBlocked(boolean) - Method in class au.com.forward.undoRedo.UndoRedoManager
SetBlocked state in UndoRedoManager.
setBranchSuffix(String) - Method in class au.com.forward.undoRedo.BranchUndoRedo
Sets the string suffix used for Branch Node lables.
setDeepestNode(UndoRedoTreeNode) - Method in class au.com.forward.undoRedo.BranchDefaultMutableTreeNode
 
setFrameMarker(Long) - Method in interface au.com.forward.undoRedo.ICanBeRolledBack
Called by the UndoRedoManager to set the frame marker for future roll back.
setFrameMarker(Long) - Method in class au.com.forward.undoRedo.UndoRedoEdit
Called by the UndoRedoManager to set the frame marker for future roll back.
setKeyboardMappings(Action) - Method in class au.com.forward.undoRedo.UndoRedoManager
Set the Enter keyboard mapping for the tree to the given Action.
setMaxDepth(int) - Method in class au.com.forward.undoRedo.BranchDefaultMutableTreeNode
Set the maximum depth of this branch
setPreferredDisplayWidth(int) - Method in class au.com.forward.undoRedo.UndoRedoManager
Sets the preferred width of the node display.
setText(String) - Method in interface au.com.forward.undoRedo.IDisplayText
Displays the string argument
setText(String) - Method in class au.com.forward.undoRedo.UndoRedoManager.TextAreaWrapper
 
setTextDisplayComponent(IDisplayText) - Method in class au.com.forward.undoRedo.UndoRedoManager
Sets the Component used to display extended descriptions.
setUndoState(boolean) - Method in interface au.com.forward.undoRedo.ICanBeRolledBack
Sets the undo or redo state.
setUndoState(boolean) - Method in class au.com.forward.undoRedo.UndoRedoEdit
Sets the undo or redo state.
setUnreachable() - Method in class au.com.forward.undoRedo.UndoRedo
Sets this undo/redo as being un-reached.
supportsRollBack() - Method in class au.com.forward.undoRedo.UndoRedoManager
Returns the rollback setting for the UndoRedoManager.
syncToLastSuccessfull(Long) - Method in class au.com.forward.undoRedo.UndoRedoManager
Rolls back undo/redo to the last sucessfull command.

T

textScrollPane - Variable in class au.com.forward.undoRedo.UndoRedoManager
The scrollPane holding the extended description text component.
toFullString() - Method in class au.com.forward.undoRedo.UndoRedoTreeNode
The string representation of this node and the tree rooted on it.
toString() - Method in class au.com.forward.undoRedo.BranchDefaultMutableTreeNode
Override toString() to indicate if any nodes in this branch have been redone
toString() - Method in class au.com.forward.undoRedo.BranchUndoRedo
Returns the string represenation of this BranchNode, includes the suffix.
toString() - Method in class au.com.forward.undoRedo.UndoRedo
Returns a string representation of this UndoRedo object.
toString() - Method in class au.com.forward.undoRedo.UndoRedoManager.Frame
String representation of the postTree for this Frame
tree - Variable in class au.com.forward.undoRedo.UndoRedoManager
The undoRedo JTree
treeModel - Variable in class au.com.forward.undoRedo.UndoRedoManager
The undo/redo tree model
treeScrollPane - Variable in class au.com.forward.undoRedo.UndoRedoManager
The scrollPane holding the undo/redo Tree.

U

undo() - Method in class au.com.forward.undoRedo.UndoRedo
Undo the edit that was made.
undo() - Method in class au.com.forward.undoRedo.UndoRedoManager
Find the top undo and undo it.
undoableEditHappened(UndoableEditEvent) - Method in class au.com.forward.undoRedo.UndoRedoManager
An undoable edit happened, handle it.
UndoRedo - Class in au.com.forward.undoRedo
Wrapps an UndoableEdit for adding to the UndoRedoManager tree.
UndoRedo(UndoableEdit) - Constructor for class au.com.forward.undoRedo.UndoRedo
Creates a new instance of UndoRedo wrapping an UndoableEdit.
UndoRedoEdit - Class in au.com.forward.undoRedo
 
UndoRedoEdit() - Constructor for class au.com.forward.undoRedo.UndoRedoEdit
Creates a new instance of UndoRedoEdit
UndoRedoManager - Class in au.com.forward.undoRedo
This is the main class, it handles a tree of undo/redos.
UndoRedoManager() - Constructor for class au.com.forward.undoRedo.UndoRedoManager
Creates a new instance of UndoRedoManager.
UndoRedoManager(Action, IDisplayText, boolean) - Constructor for class au.com.forward.undoRedo.UndoRedoManager
Creates a new instance of UndoRedoManager.
UndoRedoManager.DisplayTextArea - Class in au.com.forward.undoRedo
 
UndoRedoManager.DisplayTextArea() - Constructor for class au.com.forward.undoRedo.UndoRedoManager.DisplayTextArea
 
UndoRedoManager.Frame - Class in au.com.forward.undoRedo
This class hold the information needed to reset the UndoRedo tree to some prevous state
UndoRedoManager.Frame(UndoRedoTreeNode) - Constructor for class au.com.forward.undoRedo.UndoRedoManager.Frame
Frame constructor.
UndoRedoManager.TextAreaWrapper - Class in au.com.forward.undoRedo
 
UndoRedoManager.TextAreaWrapper(IDisplayText) - Constructor for class au.com.forward.undoRedo.UndoRedoManager.TextAreaWrapper
 
UndoRedoManager.UndoRedoTreeSelectionListener - Class in au.com.forward.undoRedo
 
UndoRedoManager.UndoRedoTreeSelectionListener() - Constructor for class au.com.forward.undoRedo.UndoRedoManager.UndoRedoTreeSelectionListener
 
UndoRedoManager.WidthEnabledCellRenderer - Class in au.com.forward.undoRedo
A tree cell renderer which respects the set width.
UndoRedoManager.WidthEnabledCellRenderer() - Constructor for class au.com.forward.undoRedo.UndoRedoManager.WidthEnabledCellRenderer
 
UndoRedoTreeNode - Class in au.com.forward.undoRedo
 
UndoRedoTreeNode() - Constructor for class au.com.forward.undoRedo.UndoRedoTreeNode
Creates a new instance of UndoRedoTreeNode
UndoRedoTreeNode(Object) - Constructor for class au.com.forward.undoRedo.UndoRedoTreeNode
Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.
UNREACHABLE_FORMAT - Static variable in class au.com.forward.undoRedo.UndoRedo
Prefix for unreachable nodes
updateDisplayMessage() - Method in class au.com.forward.undoRedo.BranchDefaultMutableTreeNode
Find the deepest presentation name and set it as this nodes presentation name

V

valueChanged(TreeSelectionEvent) - Method in class au.com.forward.undoRedo.UndoRedoManager.UndoRedoTreeSelectionListener
 
VERSION - Static variable in class au.com.forward.undoRedo.UndoRedoManager
UndoRedoManager Version

A B C D E F G H I P R S T U V
©2005, Forward Computing and Control Pty. Ltd
ACN 003 669 994   NSW Australia
All Rights Reserved.