icy.undo

Class AbstractIcyUndoableEdit

java.lang.Object

icy.undo.AbstractIcyUndoableEdit

All Implemented Interfaces:

IcyUndoableEdit, javax.swing.undo.UndoableEdit

Direct Known Subclasses:

AbstractROIEdit, AbstractROIsEdit, AbstractSequenceEdit

public abstract class AbstractIcyUndoableEdit
extends java.lang.Object
implements IcyUndoableEdit

Abstract Icy UndoableEdit class.

Author:

Stephane

Constructor Summary

Constructors

Constructor and Description
AbstractIcyUndoableEdit(java.lang.Object source) Creates an UndoableAction which defaults hasBeenDone and alive to true.
AbstractIcyUndoableEdit(java.lang.Object source, java.awt.Image icon) Creates an UndoableAction which defaults hasBeenDone and alive to true.
AbstractIcyUndoableEdit(java.lang.Object source, java.lang.String name) Creates an UndoableAction which defaults hasBeenDone and alive to true.
AbstractIcyUndoableEdit(java.lang.Object source, java.lang.String name, java.awt.Image icon) Creates an UndoableAction which defaults hasBeenDone and alive to true.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addEdit(javax.swing.undo.UndoableEdit anEdit)
boolean	canRedo()
boolean	canUndo()
void	die() Sets alive to false.
IcyIcon	getIcon()
java.lang.String	getPresentationName() This default implementation returns "".
java.lang.String	getRedoPresentationName() Retrieves the value from the defaults table with key AbstractUndoableEdit.redoText and returns that value followed by a space, followed by getPresentationName.
java.lang.Object	getSource() Retrieve source of this edit
java.lang.String	getUndoPresentationName() Retrieves the value from the defaults table with key AbstractUndoableEdit.undoText and returns that value followed by a space, followed by getPresentationName.
boolean	isMergeable()
boolean	isSignificant()
void	redo() Throws CannotRedoException if canRedo returns false.
boolean	replaceEdit(javax.swing.undo.UndoableEdit anEdit)
void	setMergeable(boolean value)
java.lang.String	toString() Returns a string that displays and identifies this object's properties.
void	undo() Throws CannotUndoException if canUndo returns false.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractIcyUndoableEdit

public AbstractIcyUndoableEdit(java.lang.Object source,
                       java.lang.String name,
                       java.awt.Image icon)

Creates an UndoableAction which defaults hasBeenDone and alive to true.

AbstractIcyUndoableEdit

public AbstractIcyUndoableEdit(java.lang.Object source,
                       java.lang.String name)

Creates an UndoableAction which defaults hasBeenDone and alive to true.

AbstractIcyUndoableEdit

public AbstractIcyUndoableEdit(java.lang.Object source,
                       java.awt.Image icon)

Creates an UndoableAction which defaults hasBeenDone and alive to true.

AbstractIcyUndoableEdit

public AbstractIcyUndoableEdit(java.lang.Object source)

Creates an UndoableAction which defaults hasBeenDone and alive to true.

Method Detail

getSource

public java.lang.Object getSource()

Description copied from interface: IcyUndoableEdit

Retrieve source of this edit

Specified by:

getSource in interface IcyUndoableEdit

getIcon

public IcyIcon getIcon()

Specified by:

getIcon in interface IcyUndoableEdit

Returns:

the icon

die

public void die()

Sets alive to false. Note that this is a one way operation; dead edits cannot be resurrected.
Sending undo or redo to a dead edit results in an exception being thrown.

Typically an edit is killed when it is consolidated by another edit's addEdit or replaceEdit method, or when it is dequeued from an UndoManager.

Specified by:

die in interface javax.swing.undo.UndoableEdit

undo

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

Throws CannotUndoException if canUndo returns false. Sets hasBeenDone to false. Subclasses should override to undo the operation represented by this edit. Override should begin with a call to super.

Specified by:

undo in interface javax.swing.undo.UndoableEdit

Throws:

javax.swing.undo.CannotUndoException - if canUndo returns false

See Also:

canUndo()

canUndo

public boolean canUndo()

Specified by:

canUndo in interface javax.swing.undo.UndoableEdit

redo

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

Throws CannotRedoException if canRedo returns false. Sets hasBeenDone to true. Subclasses should override to redo the operation represented by this edit. Override should begin with a call to super.

Specified by:

redo in interface javax.swing.undo.UndoableEdit

Throws:

javax.swing.undo.CannotRedoException - if canRedo returns false

See Also:

canRedo()

canRedo

public boolean canRedo()

Specified by:

canRedo in interface javax.swing.undo.UndoableEdit

addEdit

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

Specified by:

addEdit in interface javax.swing.undo.UndoableEdit

replaceEdit

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

Specified by:

replaceEdit in interface javax.swing.undo.UndoableEdit

isSignificant

public final boolean isSignificant()

Specified by:

isSignificant in interface javax.swing.undo.UndoableEdit

isMergeable

public boolean isMergeable()

Specified by:

isMergeable in interface IcyUndoableEdit

Returns:

true if this edit can be merged with a compatible edit

setMergeable

public void setMergeable(boolean value)

getPresentationName

public java.lang.String getPresentationName()

This default implementation returns "". Used by getUndoPresentationName and getRedoPresentationName to construct the strings they return. Subclasses should override to return an appropriate description of the operation this edit represents.

Specified by:

getPresentationName in interface javax.swing.undo.UndoableEdit

Returns:

the empty string ""

See Also:

getUndoPresentationName(), getRedoPresentationName()

getUndoPresentationName

public java.lang.String getUndoPresentationName()

Retrieves the value from the defaults table with key AbstractUndoableEdit.undoText and returns that value followed by a space, followed by getPresentationName. If getPresentationName returns "", then the defaults value is returned alone.

Specified by:

getUndoPresentationName in interface javax.swing.undo.UndoableEdit

Returns:

the value from the defaults table with key AbstractUndoableEdit.undoText , followed by a space, followed by getPresentationName unless getPresentationName is "" in which case, the defaults value is returned alone.

See Also:

getPresentationName()

getRedoPresentationName

public java.lang.String getRedoPresentationName()

Retrieves the value from the defaults table with key AbstractUndoableEdit.redoText and returns that value followed by a space, followed by getPresentationName. If getPresentationName returns "", then the defaults value is returned alone.

Specified by:

getRedoPresentationName in interface javax.swing.undo.UndoableEdit

Returns:

the value from the defaults table with key AbstractUndoableEdit.redoText , followed by a space, followed by getPresentationName unless getPresentationName is "" in which case, the defaults value is returned alone.

See Also:

getPresentationName()

toString

public java.lang.String toString()

Returns a string that displays and identifies this object's properties.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this object