icy.undo

Class IcyUndoManager

java.lang.Object

javax.swing.undo.AbstractUndoableEdit

icy.undo.IcyUndoManager

All Implemented Interfaces:

java.io.Serializable, java.util.EventListener, javax.swing.event.UndoableEditListener, javax.swing.undo.UndoableEdit

public class IcyUndoManager
extends javax.swing.undo.AbstractUndoableEdit
implements javax.swing.event.UndoableEditListener

Custom UndoManager for Icy.

Author:

Stephane

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IcyUndoManager(java.lang.Object owner)
IcyUndoManager(java.lang.Object owner, int limit)

Method Summary

Methods

Modifier and Type	Method and Description
void	addEdit(AbstractIcyUndoableEdit anEdit) Adds an AbstractIcyUndoableEdit to this UndoManager, if it's possible.
boolean	addEdit(javax.swing.undo.UndoableEdit anEdit)
void	addListener(IcyUndoManagerListener listener) Add the specified listener to listeners list
boolean	canRedo() Returns true if edits may be redone.
boolean	canUndo() Returns true if edits may be undone.
void	discardAllEdits() Empties the undo manager sending each edit a die message in the process.
void	discardEdits(java.lang.Object source) Discard edits from specified source by sending each edit a die message in the process.
void	discardFutureEdits() Remove future edits (the ones to redo) from the undo manager sending each edit a die message in the process.
void	discardFutureEdits(int keep) Remove future edits (the ones to redo) from the undo manager sending each edit a die message in the process.
void	discardOldEdits() Remove old edits (the ones to undo) from the undo manager sending each edit a die message in the process.
void	discardOldEdits(int keep) Remove previous edits (the ones to undo) from the undo manager sending each edit a die message in the process.
java.util.List<AbstractIcyUndoableEdit>	getAllEdits() Retrieve all edits in the UndoManager
AbstractIcyUndoableEdit	getEdit(int index) Get edit of specified index
int	getEditsCount() Get number of edit in UndoManager
int	getFirstEditIndex(java.lang.Object source) Get index of first edit from specified source
int	getIndex(AbstractIcyUndoableEdit e) Get the index in list of specified edit
int	getLastEditIndex(java.lang.Object source) Get index of last edit from specified source
int	getLimit() Returns the maximum number of edits this UndoManager holds.
IcyUndoManagerListener[]	getListeners() Get listeners list
int	getNextAddIndex() Return the next insert index.
java.lang.Object	getOwner()
java.lang.String	getRedoPresentationName() Returns a description of the redoable form of this edit.
AbstractIcyUndoableEdit	getSignificantEdit(int index) Get significant edit of specified index
int	getSignificantEditsCount() Get number of significant edit in UndoManager
int	getSignificantEditsCountBefore(int index) Get number of significant edit before the specified position in UndoManager
int	getSignificantIndex(AbstractIcyUndoableEdit e) Get the index in list of specified significant edit
java.lang.String	getUndoPresentationName() Returns a description of the undoable form of this edit.
void	noMergeForNextEdit() Prevent the last edit inserted in the UndoManager to be merged with the next inserted edit (even if they are compatible)
void	redo() Redo the appropriate edits.
void	removeListener(IcyUndoManagerListener listener) Remove the specified listener from listeners list
void	setLimit(int l) Sets the maximum number of edits this UndoManager holds.
void	undo() Undoes the appropriate edits.
void	undoableEditHappened(javax.swing.event.UndoableEditEvent e)
void	undoAll() Undoes all changes.
void	undoOrRedoTo(AbstractIcyUndoableEdit edit) Undo or redo all changes until the specified edit.

Methods inherited from class javax.swing.undo.AbstractUndoableEdit

die, getPresentationName, isSignificant, replaceEdit, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IcyUndoManager

public IcyUndoManager(java.lang.Object owner,
              int limit)

IcyUndoManager

public IcyUndoManager(java.lang.Object owner)

Method Detail

getOwner

public java.lang.Object getOwner()

Returns:

the owner

getLimit

public int getLimit()

Returns the maximum number of edits this UndoManager holds. A value less than 0 indicates the number of edits is not limited.

Returns:

the maximum number of edits this UndoManager holds

See Also:

addEdit(javax.swing.undo.UndoableEdit), setLimit(int)

discardAllEdits

public void discardAllEdits()

Empties the undo manager sending each edit a die message in the process.

See Also:

AbstractUndoableEdit.die()

discardFutureEdits

public void discardFutureEdits(int keep)

Remove future edits (the ones to redo) from the undo manager sending each edit a die message in the process.

Parameters:

keep - number of future edits to keep (1 means we keep only the next edit)

See Also:

AbstractUndoableEdit.die()

discardFutureEdits

public void discardFutureEdits()

Remove future edits (the ones to redo) from the undo manager sending each edit a die message in the process.

See Also:

AbstractUndoableEdit.die()

discardOldEdits

public void discardOldEdits(int keep)

Remove previous edits (the ones to undo) from the undo manager sending each edit a die message in the process.

Parameters:

keep - number of previous edits to keep (1 mean we keep only the last edit)

See Also:

AbstractUndoableEdit.die()

discardOldEdits

public void discardOldEdits()

Remove old edits (the ones to undo) from the undo manager sending each edit a die message in the process.

See Also:

AbstractUndoableEdit.die()

setLimit

public void setLimit(int l)

Sets the maximum number of edits this UndoManager holds. A value less than 0 indicates the number of edits is not limited. If edits need to be discarded to shrink the limit, die will be invoked on them in the reverse order they were added. The default is 100.

Parameters:

l - the new limit

Throws:

java.lang.RuntimeException - if this UndoManager is not in progress (end has been invoked)

See Also:

addEdit(javax.swing.undo.UndoableEdit), getLimit()

undoAll

public void undoAll()
             throws javax.swing.undo.CannotUndoException

Undoes all changes.

Throws:

javax.swing.undo.CannotUndoException - if one of the edits throws CannotUndoException

undo

public void undo()
          throws javax.swing.undo.CannotUndoException

Undoes the appropriate edits. This invokes undo on all edits between the index of the next edit and the last significant edit, updating the index of the next edit appropriately.

Specified by:

undo in interface javax.swing.undo.UndoableEdit

Overrides:

undo in class javax.swing.undo.AbstractUndoableEdit

Throws:

javax.swing.undo.CannotUndoException - if one of the edits throws CannotUndoException or there are no edits to be undone

See Also:

canUndo(), editToBeUndone()

canUndo

public boolean canUndo()

Returns true if edits may be undone. This returns true if there are any edits to be undone (editToBeUndone returns non-null).

Specified by:

canUndo in interface javax.swing.undo.UndoableEdit

Overrides:

canUndo in class javax.swing.undo.AbstractUndoableEdit

Returns:

true if there are edits to be undone

See Also:

editToBeUndone()

redo

public void redo()
          throws javax.swing.undo.CannotRedoException

Redo the appropriate edits. This invokes redo on all edits between the index of the next edit and the next significant edit, updating the index of the next edit appropriately.

Specified by:

redo in interface javax.swing.undo.UndoableEdit

Overrides:

redo in class javax.swing.undo.AbstractUndoableEdit

Throws:

javax.swing.undo.CannotRedoException - if one of the edits throws CannotRedoException or there are no edits to be redone

See Also:

CompoundEdit.end(), canRedo(), editToBeRedone()

canRedo

public boolean canRedo()

Returns true if edits may be redone. If end has been invoked, this returns the value from super. Otherwise, this returns true if there are any edits to be redone (editToBeRedone returns non-null).

Specified by:

canRedo in interface javax.swing.undo.UndoableEdit

Overrides:

canRedo in class javax.swing.undo.AbstractUndoableEdit

Returns:

true if there are edits to be redone

See Also:

CompoundEdit.canRedo(), editToBeRedone()

undoOrRedoTo

public void undoOrRedoTo(AbstractIcyUndoableEdit edit)
                  throws javax.swing.undo.CannotRedoException,
                         javax.swing.undo.CannotUndoException

Undo or redo all changes until the specified edit.
The specified edit should be in "done" state after the operation.
That means redo operation is inclusive while undo is exclusive.
To undo all operations just use undoAll().

Throws:

javax.swing.undo.CannotRedoException

javax.swing.undo.CannotUndoException

addEdit

public boolean addEdit(javax.swing.undo.UndoableEdit anEdit)

Specified by:

addEdit in interface javax.swing.undo.UndoableEdit

Overrides:

addEdit in class javax.swing.undo.AbstractUndoableEdit

addEdit

public void addEdit(AbstractIcyUndoableEdit anEdit)

Adds an AbstractIcyUndoableEdit to this UndoManager, if it's possible. This removes all edits from the index of the next edit to the end of the edits list.

Parameters:

anEdit - the edit to be added

See Also:

CompoundEdit.addEdit(javax.swing.undo.UndoableEdit)

noMergeForNextEdit

public void noMergeForNextEdit()

Prevent the last edit inserted in the UndoManager to be merged with the next inserted edit (even if they are compatible)

getUndoPresentationName

public java.lang.String getUndoPresentationName()

Returns a description of the undoable form of this edit. If there are edits to be undone, this returns the value from the next significant edit that will be undone. If there are no edits to be undone this returns the value from the UIManager property "AbstractUndoableEdit.undoText".

Specified by:

getUndoPresentationName in interface javax.swing.undo.UndoableEdit

Overrides:

getUndoPresentationName in class javax.swing.undo.AbstractUndoableEdit

Returns:

a description of the undoable form of this edit

See Also:

undo(), CompoundEdit.getUndoPresentationName()

getRedoPresentationName

public java.lang.String getRedoPresentationName()

Returns a description of the redoable form of this edit. If there are edits to be redone, this returns the value from the next significant edit that will be redone. If there are no edits to be redone this returns the value from the UIManager property "AbstractUndoableEdit.redoText".

Specified by:

getRedoPresentationName in interface javax.swing.undo.UndoableEdit

Overrides:

getRedoPresentationName in class javax.swing.undo.AbstractUndoableEdit

Returns:

a description of the redoable form of this edit

See Also:

redo(), CompoundEdit.getRedoPresentationName()

addListener

public void addListener(IcyUndoManagerListener listener)

Add the specified listener to listeners list

removeListener

public void removeListener(IcyUndoManagerListener listener)

Remove the specified listener from listeners list

getListeners

public IcyUndoManagerListener[] getListeners()

Get listeners list

getAllEdits

public java.util.List<AbstractIcyUndoableEdit> getAllEdits()

Retrieve all edits in the UndoManager

getEditsCount

public int getEditsCount()

Get number of edit in UndoManager

getIndex

public int getIndex(AbstractIcyUndoableEdit e)

Get the index in list of specified edit

getSignificantIndex

public int getSignificantIndex(AbstractIcyUndoableEdit e)

Get the index in list of specified significant edit

getSignificantEditsCountBefore

public int getSignificantEditsCountBefore(int index)

Get number of significant edit before the specified position in UndoManager

getSignificantEditsCount

public int getSignificantEditsCount()

Get number of significant edit in UndoManager

getEdit

public AbstractIcyUndoableEdit getEdit(int index)

Get edit of specified index

getSignificantEdit

public AbstractIcyUndoableEdit getSignificantEdit(int index)

Get significant edit of specified index

getNextAddIndex

public int getNextAddIndex()

Return the next insert index.

getFirstEditIndex

public int getFirstEditIndex(java.lang.Object source)

Get index of first edit from specified source

getLastEditIndex

public int getLastEditIndex(java.lang.Object source)

Get index of last edit from specified source

discardEdits

public void discardEdits(java.lang.Object source)

Discard edits from specified source by sending each edit a die message in the process.

undoableEditHappened

public void undoableEditHappened(javax.swing.event.UndoableEditEvent e)

Specified by:

undoableEditHappened in interface javax.swing.event.UndoableEditListener