com.goldencode.p2j.ui.client.gui.driver.swing

Class SwingMouseHandler

java.lang.Object

java.awt.event.MouseAdapter

com.goldencode.p2j.ui.client.gui.driver.MouseHandler

com.goldencode.p2j.ui.client.gui.driver.swing.SwingMouseHandler

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class SwingMouseHandler
extends MouseHandler

Provide mouse event support for the swing GUI driver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SwingMouseHandler.WorkArea Container for mouse-related data.

Field Summary

Fields

Modifier and Type	Field and Description
private java.awt.event.MouseEvent	delayedMouseExited Delayed mouseExited event.
private Widget<?>	lastHoveredWidget The last widget over which the mouse was moved.
private static ContextLocal<SwingMouseHandler.WorkArea>	local Context-local data for this mouse-handler.
private static java.awt.Point	pointerLocation Current mouse pointer location
private boolean	pressed Pressed flag.

Fields inherited from class com.goldencode.p2j.ui.client.gui.driver.MouseHandler

ews, tc

Constructor Summary

Constructors

Constructor and Description
SwingMouseHandler()

Method Summary

Modifier and Type	Method and Description
(package private) static void	deregisterActions(java.util.Collection<MouseHoverAction> toRemove) Remove all mouse actions provided in the argument list.
(package private) static void	deregisterWidgetActions(int wid) Deregister the complex actions for the specified widget ID.
private Widget<?>	findMouseSource(java.awt.event.MouseEvent e) Find the mouse source on which the specified event will act, based on coordinates.
Widget<?>	getDropCandidate() Returns the widget that can be considered as candidate for drop operation.
static java.awt.Point	getPointerLocation() Retrieves the current location of the mouse pointer.
void	mouseClicked(java.awt.event.MouseEvent e) Notification of a mouse clicked event.
void	mouseDragged(java.awt.event.MouseEvent e) Notification of a mouse dragged event.
void	mouseEntered(java.awt.event.MouseEvent e) Notification of a mouse entered event.
void	mouseExited(java.awt.event.MouseEvent e) Notification of a mouse exited event.
void	mouseMoved(java.awt.event.MouseEvent e) Notification of a mouse moved event.
void	mousePressed(java.awt.event.MouseEvent e) Notification of a mouse pressed event.
void	mouseReleased(java.awt.event.MouseEvent e) Notification of a mouse released event.
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e) Notification of a mouse wheel event.
private boolean	processAction(java.awt.event.MouseEvent e) Determine the widget which will react on the specified event and process any actions associated with it.
private boolean	processAction(Widget<?> widget, java.awt.event.MouseEvent e) Process any actions for the given widget and event.
(package private) static void	registerAction(int wid, MouseWidgetAction action) Register a complex action for the specified widget ID.

Methods inherited from class com.goldencode.p2j.ui.client.gui.driver.MouseHandler

applyMouseEvent, canProcessMouse, captureMouseEvents, deregisterTooltipWorker, deregisterWidget, getCachedActions, getWidgetActions, getWidgetListForTooltipWorkers, handleMouseEvent, processWidgetActions, registerWidgetAction, setWindow

Methods inherited from class java.lang.Object

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

Field Detail

pointerLocation

private static java.awt.Point pointerLocation

Current mouse pointer location

local

private static final ContextLocal<SwingMouseHandler.WorkArea> local

Context-local data for this mouse-handler.

lastHoveredWidget

private Widget<?> lastHoveredWidget

The last widget over which the mouse was moved.

pressed

private boolean pressed

Pressed flag.

delayedMouseExited

private java.awt.event.MouseEvent delayedMouseExited

Delayed mouseExited event.

Constructor Detail

SwingMouseHandler

public SwingMouseHandler()

Method Detail

mouseClicked

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

Notification of a mouse clicked event. If the mouse event can't be processed by the driver directly, it will post it to the event manager.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Overrides:

mouseClicked in class MouseHandler

Parameters:

e - The mouse event.

mousePressed

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

Notification of a mouse pressed event. If the mouse event can't be processed by the driver directly, it will post it to the event manager.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class MouseHandler

Parameters:

e - The mouse event.

mouseReleased

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

Notification of a mouse released event. If the mouse event can't be processed by the driver directly, it will post it to the event manager.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class MouseHandler

Parameters:

e - The mouse event.

mouseEntered

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

Notification of a mouse entered event. If the mouse event can't be processed by the driver directly, it will post it to the event manager.

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Overrides:

mouseEntered in class MouseHandler

Parameters:

e - The mouse event.

mouseExited

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

Notification of a mouse exited event. If the mouse event can't be processed by the driver directly, it will post it to the event manager.

Specified by:

mouseExited in interface java.awt.event.MouseListener

Overrides:

mouseExited in class MouseHandler

Parameters:

e - The mouse event.

mouseWheelMoved

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

Notification of a mouse wheel event. If the mouse event can't be processed by the driver directly, it will post it to the event manager.

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

Overrides:

mouseWheelMoved in class MouseHandler

Parameters:

e - The mouse event.

mouseDragged

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

Notification of a mouse dragged event. If the mouse event can't be processed by the driver directly, it will post it to the event manager.

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

Overrides:

mouseDragged in class MouseHandler

Parameters:

e - The mouse event.

mouseMoved

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

Notification of a mouse moved event. If the mouse event can't be processed by the driver directly, it will post it to the event manager.

If the hovered widget has changed, it will raise MouseEvent.MOUSE_EXITED and MouseEvent.MOUSE_ENTERED events instead of MouseEvent.MOUSE_MOVED.

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

Overrides:

mouseMoved in class MouseHandler

Parameters:

e - The mouse event.

getDropCandidate

public Widget<?> getDropCandidate()

Returns the widget that can be considered as candidate for drop operation. This is the widget where mouse was released.

Returns:

See above.

deregisterWidgetActions

static final void deregisterWidgetActions(int wid)

Deregister the complex actions for the specified widget ID.

Parameters:

wid - The widget ID.

deregisterActions

static final void deregisterActions(java.util.Collection<MouseHoverAction> toRemove)

Remove all mouse actions provided in the argument list.

Parameters:

toRemove - actions to remove

registerAction

static final void registerAction(int wid,
                                 MouseWidgetAction action)

Register a complex action for the specified widget ID.

Use this method (instead of the MouseHandler.registerWidgetAction(int, MouseWidgetAction)) to register actions to Swing GUI-specific action map, i.e. the actions will be ignored by other drivers.

Parameters:

wid - The widget ID.

action - The mouse action.

findMouseSource

private Widget<?> findMouseSource(java.awt.event.MouseEvent e)

Find the mouse source on which the specified event will act, based on coordinates.

Parameters:

e - The event.

Returns:

The mouse source, as returned by TitledWindow.findMouseSource(com.goldencode.p2j.ui.client.event.MouseEvt).

processAction

private boolean processAction(java.awt.event.MouseEvent e)

Determine the widget which will react on the specified event and process any actions associated with it.

Parameters:

e - The mouse event.

Returns:

See above.

processAction

private boolean processAction(Widget<?> widget,
                              java.awt.event.MouseEvent e)

Process any actions for the given widget and event.

Parameters:

widget - The widget. If null, it will be determined by findMouseSource(java.awt.event.MouseEvent).

e - The mouse event.

Returns:

true if at least one action was executed

getPointerLocation

public static java.awt.Point getPointerLocation()

Retrieves the current location of the mouse pointer.

Returns:

The Point representing the mouse pointer's coordinates on the screen.