info.bioinfweb.commons.swing

Class AbstractDocumentEdit

java.lang.Object

info.bioinfweb.commons.swing.AbstractDocumentEdit

All Implemented Interfaces:

javax.swing.undo.UndoableEdit

public abstract class AbstractDocumentEdit
extends java.lang.Object
implements javax.swing.undo.UndoableEdit

Implements basic functionality for edits on a document that takes track of changes.

Author:

Ben Stöver

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentEdit()

Method Summary

Modifier and Type	Method and Description
boolean	addEdit(javax.swing.undo.UndoableEdit edit)
boolean	canRedo()
boolean	canUndo()
void	die()
boolean	getIsSubedit()
java.lang.String	getRedoPresentationName()
java.lang.String	getUndoPresentationName()
boolean	isSignificant()
void	redo() Default implementation that just calls registerDocumentChange() if this edit is not a subedit.
protected abstract void	registerDocumentChange() Inheriting classes should, e.g., inform document listeners here.
boolean	replaceEdit(javax.swing.undo.UndoableEdit edit)
void	setIsSubedit(boolean isSubedit) Indicates whether this edit is independent or part of another edit.
void	undo() Default implementation that just calls registerDocumentChange() if this edit is not a subedit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.swing.undo.UndoableEdit

getPresentationName

Constructor Detail

AbstractDocumentEdit

public AbstractDocumentEdit()

Method Detail

getIsSubedit

public boolean getIsSubedit()

setIsSubedit

public void setIsSubedit(boolean isSubedit)

Indicates whether this edit is independent or part of another edit. The value of this property determines if the document is informed if this edit was redone or undone.

addEdit

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

Specified by:

addEdit in interface javax.swing.undo.UndoableEdit

canRedo

public boolean canRedo()

Specified by:

canRedo in interface javax.swing.undo.UndoableEdit

canUndo

public boolean canUndo()

Specified by:

canUndo in interface javax.swing.undo.UndoableEdit

die

public void die()

Specified by:

die in interface javax.swing.undo.UndoableEdit

getRedoPresentationName

public java.lang.String getRedoPresentationName()

Specified by:

getRedoPresentationName in interface javax.swing.undo.UndoableEdit

getUndoPresentationName

public java.lang.String getUndoPresentationName()

Specified by:

getUndoPresentationName in interface javax.swing.undo.UndoableEdit

isSignificant

public boolean isSignificant()

Specified by:

isSignificant in interface javax.swing.undo.UndoableEdit

replaceEdit

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

Specified by:

replaceEdit in interface javax.swing.undo.UndoableEdit

registerDocumentChange

protected abstract void registerDocumentChange()

Inheriting classes should, e.g., inform document listeners here.

redo

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

Default implementation that just calls registerDocumentChange() if this edit is not a subedit. Inheriting classes would have to overwrite this method to perform there document changes but should call the inherited methods at the end of the implementation.

Specified by:

redo in interface javax.swing.undo.UndoableEdit

Throws:

javax.swing.undo.CannotRedoException

undo

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

Default implementation that just calls registerDocumentChange() if this edit is not a subedit. Inheriting classes would have to overwrite this method to undo there document changes but should call the inherited methods at the end of the implementation.

Specified by:

undo in interface javax.swing.undo.UndoableEdit

Throws:

javax.swing.undo.CannotUndoException