org.das2.event

Class MouseModule

java.lang.Object

org.das2.event.MouseModule

All Implemented Interfaces:

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

Direct Known Subclasses:

AnnotatorMouseModule, BoxRangeSelectorMouseModule, BoxSelectorMouseModule, ColumnColumnConnectorMouseModule, CrossHairMouseModule, DataPointSelectorMouseModule, DisplayDataMouseModule, HorizontalDragRangeSelectorMouseModule, HorizontalRangeSelectorMouseModule, HorizontalSlicerMouseModule, LengthMouseModule, MoveComponentMouseModule, VerticalDragRangeSelectorMouseModule, VerticalRangeSelectorMouseModule, VerticalSlicerMouseModule, WaypointsMouseModule, ZoomPanMouseModule

public class MouseModule
extends java.lang.Object
implements Editable, Displayable, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener

A MouseModule is a pluggable unit that promotes simple mouse events into human events or actions that are useful for science analysis. Each component has a mouseInputAdapter that manages a set of mouseModules, one is active at any given time. The DasMouseInputAdapter will delegate mouse events, key events, and mouse wheel events to the active mouse module. This base class will be extended by instances of MouseModule, overriding methods they wish to handle.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MouseModule.Pos used by subclasses to describe positions.

Field Summary

Fields

Modifier and Type	Field and Description
protected DragRenderer	dragRenderer
protected static java.util.logging.Logger	logger
protected DasCanvasComponent	parent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MouseModule()
	MouseModule(DasCanvasComponent parent) create the mouse module for the parent component.
	MouseModule(DasCanvasComponent parent, DragRenderer dragRenderer, java.lang.String label) create the mouse module for the parent component using the dragRenderer to paint graphic feedback to the human operator.

Method Summary

Modifier and Type	Method and Description
protected static boolean	axisIsAdjustable(DasAxis axis) return true if the axis is not an axis with enumeration units.
void	drawListIcon(java.awt.Graphics2D g, int x, int y) implement this to provide nice drawing of icon on printing graphics context.
java.awt.Cursor	getCursor() return a cursor that indicates the selected module.
java.lang.String	getDirections() allow one-line directions to be added to the mouse module.
DragRenderer	getDragRenderer() return the current drag renderer.
java.lang.String	getLabel() returns a human-readable string that identifies the module
javax.swing.Icon	getListIcon() return the list icon.
java.lang.String	getListLabel() return a String that will help the user identify this item when choosing from a list.
DasCanvasComponent	getParent() return the canvas component (for example, a DasPlot) where this MouseModule is listening.
void	keyPressed(java.awt.event.KeyEvent keyEvent)
void	keyReleased(java.awt.event.KeyEvent keyEvent)
void	keyTyped(java.awt.event.KeyEvent keyEvent)
protected static DatumRange	maybeRound(DasAxis xAxis, DatumRange dr) round to the nearest nice interval by looking for a DomainDivider in the axis.
void	mouseClicked(java.awt.event.MouseEvent e)
void	mouseDragged(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
void	mouseExited(java.awt.event.MouseEvent e)
void	mouseMoved(java.awt.event.MouseEvent e)
void	mousePointSelected(MousePointSelectionEvent e) Action to take when a point (click or drag) is selected.
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseRangeSelected(MouseDragEvent e) Action to take when a mouse range (click, drag, release) has been selected.
void	mouseReleased(java.awt.event.MouseEvent e)
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e)
MouseModule.Pos	position(DasDevicePosition ddp, int pos, int threshold) indicate if the position (pixels) is near the ends of the DasRow or DasColumn.
void	setDirections(java.lang.String directions) set the human-readable directions string, so clients like Autoplot can display them.
void	setDragRenderer(DragRenderer d) set the drag renderer.
void	setLabel(java.lang.String label) set the human-readable label.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final java.util.logging.Logger logger

dragRenderer

protected DragRenderer dragRenderer

parent

protected DasCanvasComponent parent

Constructor Detail

MouseModule

protected MouseModule()

MouseModule

public MouseModule(DasCanvasComponent parent)

create the mouse module for the parent component. This is without a drag renderer, and the class name is used for the label. paint graphic feedback to the human operator.

Parameters:

parent - the component, such as a DasPlot for the crosshair digitizer or the DasAxis for zoom.

MouseModule

public MouseModule(DasCanvasComponent parent,
                   DragRenderer dragRenderer,
                   java.lang.String label)

create the mouse module for the parent component using the dragRenderer to paint graphic feedback to the human operator. For example, the dragRenderer might draw a box during the click-drag-release mouse action, and then on release this mouse module creates the event used elsewhere.

Parameters:

parent - the component, such as a DasPlot for the crosshair digitizer or the DasAxis for zoom.

dragRenderer - the drag renderer to provide feedback

label - label for the mouse module.

Method Detail

getLabel

public java.lang.String getLabel()

returns a human-readable string that identifies the module

Returns:

a human-readable string that identifies the module

getCursor

public java.awt.Cursor getCursor()

return a cursor that indicates the selected module. Note this is currently not used.

Returns:

a cursor that indicates the selected module.

getDragRenderer

public DragRenderer getDragRenderer()

return the current drag renderer.

Returns:

the current drag renderer.

setDragRenderer

public void setDragRenderer(DragRenderer d)

set the drag renderer. (Made public when the digitizer had different modes.)

Parameters:

d - set the drag renderer.

mouseRangeSelected

public void mouseRangeSelected(MouseDragEvent e)

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

Parameters:

e - the drag event.

mousePointSelected

public void mousePointSelected(MousePointSelectionEvent e)

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

Parameters:

e - the event.

setLabel

public final void setLabel(java.lang.String label)

set the human-readable label.

Parameters:

label - the human-readable label.

getParent

public DasCanvasComponent getParent()

return the canvas component (for example, a DasPlot) where this MouseModule is listening.

Returns:

the canvas component.

maybeRound

protected static DatumRange maybeRound(DasAxis xAxis,
                                       DatumRange dr)

round to the nearest nice interval by looking for a DomainDivider in the axis.

Parameters:

xAxis - the axis

dr - a datum range.

Returns:

the DatumRange, possibly rounded to a nice range.

axisIsAdjustable

protected static boolean axisIsAdjustable(DasAxis axis)

return true if the axis is not an axis with enumeration units.

Parameters:

axis - the axis, which might have enumeration units.

Returns:

true if the axis is not an axis with enumeration units.

getDirections

public java.lang.String getDirections()

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

Returns:

the directions, or null.

setDirections

public void setDirections(java.lang.String directions)

set the human-readable directions string, so clients like Autoplot can display them.

Parameters:

directions - human-readable directions.

getListIcon

public javax.swing.Icon getListIcon()

return the list icon. This will be be overridden by MouseModules to give a visual reference.

Specified by:

getListIcon in interface Displayable

Returns:

the list icon.

drawListIcon

public void drawListIcon(java.awt.Graphics2D g,
                         int x,
                         int y)

Description copied from interface: Displayable

implement this to provide nice drawing of icon on printing graphics context.

Specified by:

drawListIcon in interface Displayable

Parameters:

g - the graphics context.

x - the x position, typically 0.

y - the y position, typically 0.

getListLabel

public java.lang.String getListLabel()

Description copied from interface: Displayable

return a String that will help the user identify this item when choosing from a list.

Specified by:

getListLabel in interface Displayable

Returns:

the list label.

keyPressed

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

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyReleased

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

Specified by:

keyReleased in interface java.awt.event.KeyListener

keyTyped

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

Specified by:

keyTyped in interface java.awt.event.KeyListener

mouseReleased

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

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mousePressed

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

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseDragged

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

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

mouseClicked

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

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mouseEntered

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

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

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

Specified by:

mouseExited in interface java.awt.event.MouseListener

mouseMoved

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

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

mouseWheelMoved

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

position

public MouseModule.Pos position(DasDevicePosition ddp,
                                int pos,
                                int threshold)

indicate if the position (pixels) is near the ends of the DasRow or DasColumn. Note that the max of a row is its bottom.

Parameters:

ddp - the row or column

pos - the position to describe.

threshold - pixel distance to the boundary, 20 is often used.

Returns:

enumeration of the position, for example Pos.beyondMin.