info.bioinfweb.libralign.model.implementations.swingundo

Interface SwingEditFactory<T>

public interface SwingEditFactory<T>

Classes providing custom edit objects to an instance of SwingUndoAlignmentModel must implement this interface.

The type of edit that shall be created can be obtained by the class type of the passed edit objects. These objects provide getter methods that allow to access the relevant data. The returned object might also be a wrapper of the passed edit.

Important: Edit objects are executed by SwingUndoAlignmentModel and added to the linked UndoManager after it called one of the methods specified here, which means that implementing classes should not execute or add the the edits they return to the undo manager by themselves within implementations of methods of this interface.

Since:

0.1.0

Author:

Ben Stöver

See Also:

SwingUndoAlignmentModel

Method Summary

Modifier and Type	Method and Description
SwingAddSequenceEdit	createAddSequenceEdit(SwingConcreteAddSequenceEdit<T> edit) This method is called if an edit object that inserts a new sequence shall be created.
javax.swing.undo.UndoableEdit	createEdit(LibrAlignSwingAlignmentEdit<T> edit) This method is called to create new edit objects (except if a new sequence shall be added).

Method Detail

createEdit

javax.swing.undo.UndoableEdit createEdit(LibrAlignSwingAlignmentEdit<T> edit)

This method is called to create new edit objects (except if a new sequence shall be added).

Parameters:

edit - the default LibrAlign edit that would perform the requested operation

Returns:

the edit object that shall be used by the calling instance of SwingUndoAlignmentModel

createAddSequenceEdit

SwingAddSequenceEdit createAddSequenceEdit(SwingConcreteAddSequenceEdit<T> edit)

This method is called if an edit object that inserts a new sequence shall be created.

Parameters:

edit - the default LibrAlign edit that would perform the requested operation.

Returns:

the edit object that shall be used by the calling instance of SwingUndoAlignmentModel