org.biojava.bio.gui.sequence

Class SequenceViewerEvent

java.lang.Object

java.util.EventObject

org.biojava.bio.gui.sequence.SequenceViewerEvent

All Implemented Interfaces:

java.io.Serializable

public class SequenceViewerEvent
extends java.util.EventObject

An event indicating that a mouse gesture was recognised within a widget that renders sequences.

Since:

1.2

Author:

Matthew Pocock

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
SequenceViewerEvent(java.lang.Object source, java.lang.Object target, int pos, java.awt.event.MouseEvent mouseEvent, java.util.List path) Construct a SequenceViewerEvent with the given source, target, mouseEvent and path.

Method Summary

Modifier and Type	Method and Description
java.awt.event.MouseEvent	getMouseEvent() Get the mouse event that caused this.
java.util.List	getPath() Get the list of SequenceRenderer instances that were passed through to produce this event
int	getPos() Get the offset within the sequence - the symbol index.
java.lang.Object	getTarget() Get the Object that was the target of the mouse gesture or null if the mouse is not gesturing over any recognizable rendered object.
java.lang.String	toString()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceViewerEvent

public SequenceViewerEvent(java.lang.Object source,
                           java.lang.Object target,
                           int pos,
                           java.awt.event.MouseEvent mouseEvent,
                           java.util.List path)

Construct a SequenceViewerEvent with the given source, target, mouseEvent and path.

Parameters:

source - the event source, presumably a GUI component

target - an Object that is the target of the gesture - a feature, or {alignment, label, index} or some other structure, or null if there is no obvious target

pos - the position (offset) within the sequence

mouseEvent - the MouseEvent that caused this event to be produced

path - a List of SequenceRenderer instances passed through to reach this event source

Method Detail

getPath

public java.util.List getPath()

Get the list of SequenceRenderer instances that were passed through to produce this event

Returns:

a List of SequenceRenderer instances

getTarget

public java.lang.Object getTarget()

Get the Object that was the target of the mouse gesture or null if the mouse is not gesturing over any recognizable rendered object.

Returns:

the Object gestured at by the mouse event

getPos

public int getPos()

Get the offset within the sequence - the symbol index. This is not guaranteed to be within the legal range of symbol indices.

Returns:

the position of the gesture in sequence coordinates

getMouseEvent

public java.awt.event.MouseEvent getMouseEvent()

Get the mouse event that caused this.

Returns:

the MouseEvent that caused this gesture to be noticed

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject