info.bioinfweb.libralign.model.implementations.swingundo.edits.token

Class SwingTokenEdit<T>

java.lang.Object

info.bioinfweb.commons.swing.AbstractDocumentEdit

info.bioinfweb.libralign.model.implementations.swingundo.edits.LibrAlignSwingAlignmentEdit<T>

info.bioinfweb.libralign.model.implementations.swingundo.edits.token.SwingTokenEdit<T>

All Implemented Interfaces:

javax.swing.undo.UndoableEdit

Direct Known Subclasses:

SwingInsertRemoveTokensEdit, SwingSetTokensEdit

public abstract class SwingTokenEdit<T>
extends LibrAlignSwingAlignmentEdit<T>

Offers basic functionality used by edits that manipulate sequence elements (tokens).

Since:

0.1.0

Author:

Ben Stöver

See Also:

SwingUndoAlignmentModel

Field Summary

Fields

Modifier and Type	Field and Description
protected int	beginIndex
protected java.lang.String	sequenceID
protected java.util.Collection<? extends T>	tokens

Constructor Summary

Constructors

Constructor and Description
SwingTokenEdit(SwingUndoAlignmentModel<T> provider, java.lang.String sequenceID, int beginIndex, java.util.Collection<? extends T> tokens)

Method Summary

Modifier and Type	Method and Description
int	getBeginIndex() Returns the index in the sequence where this token edit is taking place.
protected abstract java.lang.String	getOperationName()
java.lang.String	getPresentationName()
java.lang.String	getSequenceID() Returns the sequence ID this edit deals with.
java.util.Collection<? extends T>	getTokens() Returns the list of tokens this edit deals with.

Methods inherited from class info.bioinfweb.libralign.model.implementations.swingundo.edits.LibrAlignSwingAlignmentEdit

getModel, registerDocumentChange

Methods inherited from class info.bioinfweb.commons.swing.AbstractDocumentEdit

addEdit, canRedo, canUndo, die, getIsSubedit, getRedoPresentationName, getUndoPresentationName, isSignificant, redo, replaceEdit, setIsSubedit, undo

Methods inherited from class java.lang.Object

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

Field Detail

sequenceID

protected java.lang.String sequenceID

beginIndex

protected int beginIndex

tokens

protected java.util.Collection<? extends T> tokens

Constructor Detail

SwingTokenEdit

public SwingTokenEdit(SwingUndoAlignmentModel<T> provider,
                      java.lang.String sequenceID,
                      int beginIndex,
                      java.util.Collection<? extends T> tokens)

Method Detail

getSequenceID

public java.lang.String getSequenceID()

Returns the sequence ID this edit deals with.

Returns:

the sequence ID

getBeginIndex

public int getBeginIndex()

Returns the index in the sequence where this token edit is taking place.

Returns:

an index >= 0 (The first position has the index 0.)

getTokens

public java.util.Collection<? extends T> getTokens()

Returns the list of tokens this edit deals with. These are the tokens to be inserted or deleted or the tokens that will replace the current tokens in case of SwingSetTokensEdit.

Returns:

an unmodifiable collection of tokens

getOperationName

protected abstract java.lang.String getOperationName()

getPresentationName

public java.lang.String getPresentationName()