org.das2.event

Class DataPointSelectorMouseModule

java.lang.Object

org.das2.event.MouseModule

org.das2.event.DataPointSelectorMouseModule

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 DataPointSelectorMouseModule
extends MouseModule

General purpose mouse module for getting data point selections. The client provides the DragRenderer, generally a vertical line, horizontal line or a crosshair. Three properties control when DataPointSelectionEvents are to be fired: dragEvents as the mouse is dragged, keyEvents when a key is pressed. (The key is the "keyChar" plane of the event) releaseEvents when the mouse is released. (false by default)

See Also:

CrossHairRenderer

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
DataPointSelectorMouseModule(DasPlot parent, DataSetConsumer consumer, DragRenderer dragRenderer, java.lang.String label)

Method Summary

Modifier and Type	Method and Description
void	addDataPointSelectionListener(DataPointSelectionListener listener) Registers DataPointSelectionListener to receive events.
protected void	fireDataPointSelectionListenerDataPointSelected(DataPointSelectionEvent event) Notifies all registered listeners about the event.
boolean	isDragEvents() Getter for property dragEvents.
boolean	isKeyEvents() Getter for property keyEvents.
boolean	isReleaseEvents() Getter for property releaseEvents.
void	keyPressed(java.awt.event.KeyEvent e)
void	mousePointSelected(MousePointSelectionEvent e) Action to take when a point (click or drag) is selected.
void	mouseReleased(java.awt.event.MouseEvent e)
void	removeDataPointSelectionListener(DataPointSelectionListener listener) Removes DataPointSelectionListener from the list of listeners.
void	setDragEvents(boolean dragEvents) Setter for property dragEvents.
void	setKeyEvents(boolean keyEvents) Setter for property keyEvents.
void	setReleaseEvents(boolean releaseEvents) Setter for property releaseEvents.

Methods inherited from class org.das2.event.MouseModule

axisIsAdjustable, drawListIcon, getCursor, getDirections, getDragRenderer, getLabel, getListIcon, getListLabel, getParent, keyReleased, keyTyped, maybeRound, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseRangeSelected, 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

DataPointSelectorMouseModule

public DataPointSelectorMouseModule(DasPlot parent,
                                    DataSetConsumer consumer,
                                    DragRenderer dragRenderer,
                                    java.lang.String label)

Method Detail

mousePointSelected

public void mousePointSelected(MousePointSelectionEvent e)

Description copied from class: MouseModule

Action to take when a point (click or drag) is selected. This is intended to be overridden.

Overrides:

mousePointSelected in class MouseModule

Parameters:

e - the event.

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Specified by:

keyPressed in interface java.awt.event.KeyListener

Overrides:

keyPressed in class MouseModule

addDataPointSelectionListener

public void addDataPointSelectionListener(DataPointSelectionListener listener)

Registers DataPointSelectionListener to receive events.

Parameters:

listener - The listener to register.

removeDataPointSelectionListener

public void removeDataPointSelectionListener(DataPointSelectionListener listener)

Removes DataPointSelectionListener from the list of listeners.

Parameters:

listener - The listener to remove.

fireDataPointSelectionListenerDataPointSelected

protected void fireDataPointSelectionListenerDataPointSelected(DataPointSelectionEvent event)

Notifies all registered listeners about the event.

Parameters:

event - The event to be fired

isDragEvents

public boolean isDragEvents()

Getter for property dragEvents.

Returns:

Value of property dragEvents.

setDragEvents

public void setDragEvents(boolean dragEvents)

Setter for property dragEvents.

Parameters:

dragEvents - New value of property dragEvents.

isKeyEvents

public boolean isKeyEvents()

Getter for property keyEvents.

Returns:

Value of property keyEvents.

setKeyEvents

public void setKeyEvents(boolean keyEvents)

Setter for property keyEvents.

Parameters:

keyEvents - New value of property keyEvents.

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class MouseModule

isReleaseEvents

public boolean isReleaseEvents()

Getter for property releaseEvents.

Returns:

Value of property releaseEvents.

setReleaseEvents

public void setReleaseEvents(boolean releaseEvents)

Setter for property releaseEvents.

Parameters:

releaseEvents - New value of property releaseEvents.