org.das2.event

Class DasMouseInputAdapter

java.lang.Object

java.awt.event.MouseAdapter

javax.swing.event.MouseInputAdapter

org.das2.event.DasMouseInputAdapter

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener, javax.swing.event.MouseInputListener, Editable

public class DasMouseInputAdapter
extends javax.swing.event.MouseInputAdapter
implements Editable, java.awt.event.MouseWheelListener

DasMouseInputAdapter delegates mouse and key events to mouse modules, which do something with the events. Also, mouse events are promoted to MouseDragEvents which conveniently store information about the entire drag gesture. The base class of MouseModule has do-nothing stubs for KeyListener, MouseListener, MouseMotionListener, and MouseWheelListener, which can be implemented if the module wants to do something with these events. Also MouseDragEvents will be sent to the module as its DragRenderer has requested: after the mouse release, during the drag, or when keys are pressed. The module will first receive the low-level events before receiving the MouseDragEvents.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DasMouseInputAdapter.Feedback

Field Summary

Fields

Modifier and Type	Field and Description
static DasMouseInputAdapter.Feedback	NULL_FEEDBACK
protected DasCanvasComponent	parent
protected java.awt.event.ActionListener	popupListener
protected javax.swing.JPopupMenu	primaryPopup
protected javax.swing.JPopupMenu	secondaryPopup

Constructor Summary

Constructors

Constructor and Description
DasMouseInputAdapter(DasCanvasComponent parent) Create a DasMouseInputAdapter to handle mouse events for the component.

Method Summary

Modifier and Type	Method and Description
javax.swing.JMenu	addMenu(java.lang.String label) return a menu with font to match LAF.
void	addMenuItem(java.awt.Component b)
void	addMouseModule(MouseModule module) add a mouse module to the list of available modules.
void	cancel() allow clients to cancel, to take the same action as if cancel were pressed.
MouseModule	getActive() return the active mouse module, for scripting.
DasMouseInputAdapter.Feedback	getFeedback() get the feedback object, so its message can be set.
java.awt.event.KeyAdapter	getKeyAdapter() creates a new KeyAdapter, and should probably be private.
MouseModule	getModuleByLabel(java.lang.String label) remove the mouse module with the label.
MouseModule	getMouseModule(int i)
MouseModule[]	getMouseModules()
java.awt.Point	getMousePressPosition() returns the position of the last mouse press.
java.awt.Point	getMousePressPositionOnCanvas() return the position of the last mouse press, in the canvas coordinate frame.
int	getNumInserted() return number of elements for diagnostic purposes.
boolean	getPinned()
MouseModule	getPrimaryModule()
java.lang.String	getPrimaryModuleByLabel()
javax.swing.JPopupMenu	getPrimaryPopupMenu() added so ColumnColumnConnector could delegate to DasPlot's adapter.
MouseModule	getSecondaryModule()
java.lang.String	getSecondaryModuleByLabel()
javax.swing.JPopupMenu	getSecondaryPopupMenu() access popup menu so that synchronized blocks are minimized.
boolean	isHoverHighlite()
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	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e) the mouse wheel was turned so many units.
void	paint(java.awt.Graphics g1)
void	releaseAll() remove all references to mouse modules
void	removeMenuItem(java.lang.String label) hack to provide way to get rid of "Dump Data".
void	removeMouseModule(MouseModule module)
void	replaceMenuItem(java.lang.String label, java.awt.Component b) provide a way for an alternate implementation to be added at the position occupied by "label".
void	replaceMouseModule(MouseModule oldModule, MouseModule newModule)
void	resetName(java.lang.String name) set the name of the menus to help with debugging
void	setFeedback(DasMouseInputAdapter.Feedback f)
void	setHoverHighlite(boolean value) glow the outline of the mouse area, for development.
void	setMenuLabel(java.lang.String id)
void	setMouseModule(int i, MouseModule mouseModule) //TODO: check this Setter for property mouseModules.
void	setMousePressPositionOnCanvas(java.awt.Point p) set the mouse press position, so that it is a bean property and one DasMouseInputAdapter can delegate to another.
void	setPinned(boolean b)
void	setPrimaryModule(MouseModule module) set the primary module, the module receiving left-button events, to the module provided.
void	setPrimaryModuleByLabel(java.lang.String label)
void	setSecondaryModule(MouseModule module) set the secondary module, the module receiving middle-button events, to the module provided.
void	setSecondaryModuleByLabel(java.lang.String label)

Methods inherited from class java.awt.event.MouseAdapter

mouseClicked

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.event.MouseListener

mouseClicked

Field Detail

primaryPopup

protected javax.swing.JPopupMenu primaryPopup

secondaryPopup

protected javax.swing.JPopupMenu secondaryPopup

popupListener

protected java.awt.event.ActionListener popupListener

parent

protected DasCanvasComponent parent

NULL_FEEDBACK

public static final DasMouseInputAdapter.Feedback NULL_FEEDBACK

Constructor Detail

DasMouseInputAdapter

public DasMouseInputAdapter(DasCanvasComponent parent)

Create a DasMouseInputAdapter to handle mouse events for the component.

Parameters:

parent - the component.

Method Detail

setMenuLabel

public void setMenuLabel(java.lang.String id)

resetName

public void resetName(java.lang.String name)

set the name of the menus to help with debugging

Parameters:

name -

setFeedback

public void setFeedback(DasMouseInputAdapter.Feedback f)

getFeedback

public DasMouseInputAdapter.Feedback getFeedback()

get the feedback object, so its message can be set.

Returns:

the feedback object.

replaceMouseModule

public void replaceMouseModule(MouseModule oldModule,
                               MouseModule newModule)

removeMouseModule

public void removeMouseModule(MouseModule module)

addMouseModule

public void addMouseModule(MouseModule module)

add a mouse module to the list of available modules. If a module with the same label exists already, it will be replaced.

Parameters:

module - the module

getPrimaryPopupMenu

public javax.swing.JPopupMenu getPrimaryPopupMenu()

added so ColumnColumnConnector could delegate to DasPlot's adapter.

Returns:

getSecondaryPopupMenu

public javax.swing.JPopupMenu getSecondaryPopupMenu()

access popup menu so that synchronized blocks are minimized.

Returns:

cancel

public void cancel()

allow clients to cancel, to take the same action as if cancel were pressed.

getKeyAdapter

public java.awt.event.KeyAdapter getKeyAdapter()

creates a new KeyAdapter, and should probably be private.

Returns:

getPrimaryModule

public MouseModule getPrimaryModule()

getSecondaryModule

public MouseModule getSecondaryModule()

setPrimaryModule

public void setPrimaryModule(MouseModule module)

set the primary module, the module receiving left-button events, to the module provided. If the module is not already loaded, implicitly addMouseModule is called.

Parameters:

module - the module

setSecondaryModule

public void setSecondaryModule(MouseModule module)

set the secondary module, the module receiving middle-button events, to the module provided. If the module is not already loaded, implicitly addMouseModule is called.

Parameters:

module -

paint

public void paint(java.awt.Graphics g1)

mouseMoved

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

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

Overrides:

mouseMoved in class java.awt.event.MouseAdapter

setPinned

public void setPinned(boolean b)

getPinned

public boolean getPinned()

mousePressed

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

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class java.awt.event.MouseAdapter

mouseDragged

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

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

Overrides:

mouseDragged in class java.awt.event.MouseAdapter

getActive

public MouseModule getActive()

return the active mouse module, for scripting. Active means the button has been pressed, etc.

Returns:

null or the active module.

mouseReleased

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

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class java.awt.event.MouseAdapter

getMouseModule

public MouseModule getMouseModule(int i)

getMouseModules

public MouseModule[] getMouseModules()

getPrimaryModuleByLabel

public java.lang.String getPrimaryModuleByLabel()

setPrimaryModuleByLabel

public void setPrimaryModuleByLabel(java.lang.String label)

getSecondaryModuleByLabel

public java.lang.String getSecondaryModuleByLabel()

setSecondaryModuleByLabel

public void setSecondaryModuleByLabel(java.lang.String label)

setMouseModule

public void setMouseModule(int i,
                           MouseModule mouseModule)

//TODO: check this Setter for property mouseModules.

Parameters:

i - the index

mouseModule - the new mouseModule to use.

mouseEntered

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

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Overrides:

mouseEntered in class java.awt.event.MouseAdapter

mouseExited

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

Specified by:

mouseExited in interface java.awt.event.MouseListener

Overrides:

mouseExited in class java.awt.event.MouseAdapter

replaceMenuItem

public void replaceMenuItem(java.lang.String label,
                            java.awt.Component b)

provide a way for an alternate implementation to be added at the position occupied by "label".

Parameters:

label - the parameter to find, e.h.

b -

removeMenuItem

public void removeMenuItem(java.lang.String label)

hack to provide way to get rid of "Dump Data".

Parameters:

label - string to search for.

addMenuItem

public void addMenuItem(java.awt.Component b)

addMenu

public javax.swing.JMenu addMenu(java.lang.String label)

return a menu with font to match LAF.

Parameters:

label -

Returns:

getNumInserted

public int getNumInserted()

return number of elements for diagnostic purposes.

Returns:

getModuleByLabel

public MouseModule getModuleByLabel(java.lang.String label)

remove the mouse module with the label.

Parameters:

label - the label (case-sensitive)

Returns:

null if not found, or the module.

isHoverHighlite

public boolean isHoverHighlite()

setHoverHighlite

public void setHoverHighlite(boolean value)

glow the outline of the mouse area, for development.

Parameters:

value -

getMousePressPosition

public java.awt.Point getMousePressPosition()

returns the position of the last mouse press. This is a hack so that the mouse position can be obtained to get the context of the press. The result point is in the parent's coordinate system.

Returns:

the position of the mouse press, or null if a press has not been received.

See Also:

getMousePressPositionOnCanvas()

getMousePressPositionOnCanvas

public java.awt.Point getMousePressPositionOnCanvas()

return the position of the last mouse press, in the canvas coordinate frame.

Returns:

the position of the mouse press in the canvas coordinate frame, or null if a press has not been received.

See Also:

getMousePressPosition()

setMousePressPositionOnCanvas

public void setMousePressPositionOnCanvas(java.awt.Point p)

set the mouse press position, so that it is a bean property and one DasMouseInputAdapter can delegate to another.

Parameters:

p -

mouseWheelMoved

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

the mouse wheel was turned so many units. Delegate this to the primary module, so that if it is set to "ZoomX" then the mousewheel will be in just the X direction.

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

Overrides:

mouseWheelMoved in class java.awt.event.MouseAdapter

Parameters:

e - the mouse wheel event

releaseAll

public void releaseAll()

remove all references to mouse modules