org.biolegato.core.data.seqdoc
Interface SeqDocListener

public interface SeqDocListener

The listener class for sequence document objects.

This interface is used to receive document changes within a SeqDoc file. All SeqDoc listeners will receive notification when sequences are added to, changed within or removed from the SeqDoc. Notification for sequence modification will be sent if the sequence is inside the SeqDoc structure regardless of whether the modification originated from the containing SeqDoc class.

Author:

Graham Alvare, Brian Fristensky

Method Summary

void	sequenceAdded(SeqDoc source, int index, Sequence sequence) This method is called when a sequence is added to a SeqDoc.
void	sequenceChanged(SeqDoc source, int index, Sequence sequence, java.lang.String key) This method is called when a field in a sequence is modified.
void	sequenceRemoved(SeqDoc source, int index, Sequence sequence) This method is called when a sequence is removed from the SeqDoc class.

Method Detail

sequenceAdded

void sequenceAdded(SeqDoc source,
                   int index,
                   Sequence sequence)

This method is called when a sequence is added to a SeqDoc.

Parameters:

source - the source of the sequence insertion event.

index - the location (line number) where the sequence was added within the SeqDoc structure.

sequence - the sequence object added to the SeqDoc structure.

sequenceChanged

void sequenceChanged(SeqDoc source,
                     int index,
                     Sequence sequence,
                     java.lang.String key)

This method is called when a field in a sequence is modified. The field may either be modified by the SeqDoc class or by an external class so long as the sequence is contained within the SeqDoc class.

Parameters:

source - the source of the sequence alteration message.

index - the location (line number) of the sequence which was modified.

sequence - the modified sequence object.

key - the field key of the sequence object which was modified.

sequenceRemoved

void sequenceRemoved(SeqDoc source,
                     int index,
                     Sequence sequence)

This method is called when a sequence is removed from the SeqDoc class.

Parameters:

source - the source of the sequence removal message.

index - the location (line number) where the sequence was removed from.

sequence - the sequence removed from the SeqDoc.