org.das2.event

Class WaypointsMouseModule

java.lang.Object

org.das2.event.MouseModule

org.das2.event.WaypointsMouseModule

All Implemented Interfaces:

java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener, Displayable, Editable

public class WaypointsMouseModule
extends MouseModule

allows a thick highway to be used for digitizing, to be used with WaypointsDragRenderer.

Nested Class Summary

Nested classes/interfaces inherited from class org.das2.event.MouseModule

MouseModule.Pos

Field Summary

Fields inherited from class org.das2.event.MouseModule

dragRenderer, logger, parent

Constructor Summary

Constructors

Constructor and Description
WaypointsMouseModule(DasCanvasComponent parent, java.lang.String label)

Method Summary

Modifier and Type	Method and Description
void	addBoxSelectionListener(BoxSelectionListener listener) Registers BoxSelectionListener to receive events.
protected void	fireBoxSelectionListenerBoxSelected(BoxSelectionEvent event) Notifies all registered listeners about the event.
java.lang.String	getDirections() allow one-line directions to be added to the mouse module.
void	keyTyped(java.awt.event.KeyEvent keyEvent)
void	mouseRangeSelected(MouseDragEvent e) Action to take when a mouse range (click, drag, release) has been selected.
void	removeBoxSelectionListener(BoxSelectionListener listener) Removes BoxSelectionListener from the list of listeners.
QDataSet	whereWithin(QDataSet xx, QDataSet yy) returns a list of indices where the rank 1 yy is within the pathway, or null if none are found.

Methods inherited from class org.das2.event.MouseModule

axisIsAdjustable, drawListIcon, getCursor, getDragRenderer, getLabel, getListIcon, getListLabel, getParent, keyPressed, keyReleased, maybeRound, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePointSelected, mousePressed, mouseReleased, mouseWheelMoved, position, setDirections, setDragRenderer, setLabel

Methods inherited from class java.lang.Object

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

Constructor Detail

WaypointsMouseModule

public WaypointsMouseModule(DasCanvasComponent parent,
                            java.lang.String label)

Method Detail

getDirections

public java.lang.String getDirections()

Description copied from class: MouseModule

allow one-line directions to be added to the mouse module. This is used in Autoplot for the status bar.

Overrides:

getDirections in class MouseModule

Returns:

the directions, or null.

keyTyped

public void keyTyped(java.awt.event.KeyEvent keyEvent)

Specified by:

keyTyped in interface java.awt.event.KeyListener

Overrides:

keyTyped in class MouseModule

addBoxSelectionListener

public void addBoxSelectionListener(BoxSelectionListener listener)

Registers BoxSelectionListener to receive events. Though a BoxSelectionEvent is fired, clients should use the whereWithin method to query which points are within the bounding box drawn.

Parameters:

listener - The listener to register.

removeBoxSelectionListener

public void removeBoxSelectionListener(BoxSelectionListener listener)

Removes BoxSelectionListener from the list of listeners.

Parameters:

listener - The listener to remove.

fireBoxSelectionListenerBoxSelected

protected void fireBoxSelectionListenerBoxSelected(BoxSelectionEvent event)

Notifies all registered listeners about the event.

Parameters:

event - The event to be fired

mouseRangeSelected

public void mouseRangeSelected(MouseDragEvent e)

Description copied from class: MouseModule

Action to take when a mouse range (click, drag, release) has been selected. This is intended to be overridden.

Overrides:

mouseRangeSelected in class MouseModule

Parameters:

e - the drag event.

whereWithin

public QDataSet whereWithin(QDataSet xx,
                            QDataSet yy)

returns a list of indices where the rank 1 yy is within the pathway, or null if none are found.

Parameters:

xx - the rank 0 point for the data

yy - the rank 1 data points

Returns:

a list of indices into yy.