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

Class MouseHandler

java.lang.Object

java.awt.event.MouseAdapter

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SwingMouseHandler, WebMouseHandler

public abstract class MouseHandler
extends java.awt.event.MouseAdapter

Provide generic mouse event support for the GUI driver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	MouseHandler.ContextContainer Simple container that stores and returns a context-local instance of the global work area.
private static class	MouseHandler.WorkArea Container for mouse-related data.

Field Summary

Fields

Modifier and Type	Field and Description
protected EmulatedWindowState	ews The GUI window emulator with which this mouse handler is registered.
private static MouseHandler.ContextContainer	local Context-local data for this mouse-handler.
private static CentralLogger	LOG Logger
protected ThinClient	tc Access to ThinClient.

Constructor Summary

Constructors

Constructor and Description
MouseHandler() Create a new mouse handler, for the specified window emulator.

Method Summary

Modifier and Type	Method and Description
protected static void	applyMouseEvent(Widget<GuiOutputManager> mouseSource, java.awt.event.MouseEvent evt) Apply the specified mouse event to the specified source.
protected static boolean	canProcessMouse(java.awt.event.MouseEvent evt) Determine if mouse events can be processed.
static boolean	captureMouseEvents(boolean state) Enable or disable capture of mouse events.
static MouseWidgetAction	deregisterTooltipWorker(int wId) Deregister the specified widget for tooltip worker events.
static void	deregisterWidget(int wid) Deregister the specified widget for mouse events.
static org.roaringbitmap.RoaringBitmap	getCachedActions(int wid, java.util.function.Supplier<org.roaringbitmap.RoaringBitmap> calc) Get the cached mouse actions for this widget.
static org.roaringbitmap.RoaringBitmap	getWidgetActions(int widgetId) Get the event IDs for all actions registered with the specified widget.
static java.lang.Integer[]	getWidgetListForTooltipWorkers() Getting the list of the widgets with registered tooltip workers.
static void	handleMouseEvent(int sourceID, java.awt.event.MouseEvent evt) Handle the specified event, in the context of the specified widget.
private static boolean	handleMouseEventIfMovable(Widget<GuiOutputManager> source, java.awt.event.MouseEvent evt) Handle mouse events for movable widgets.
private static boolean	handleMouseEventIfSelectable(Widget<GuiOutputManager> source, java.awt.event.MouseEvent evt) Handle mouse events for selectable widgets.
private static boolean	isMouseClickEvent(java.awt.event.MouseEvent evt) When a mouse button is clicked 3 events MOUSE_CLICKED, MOUSE_PRESSED and MOUSE_RELEASED are generated.
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 moved event.
private static void	performAction(WidgetId id, java.awt.event.MouseEvent evt, java.util.function.Consumer<MouseDirectManipulation> mouseAction) Use a specific callback over all mouse direct manipulation registered actions.
protected static void	processWidgetActions(int sourceID, java.awt.event.MouseEvent evt) Process the mouse actions registered for the specified source.
static void	registerWidgetAction(int wid, MouseWidgetAction action) Register the specified mouse action with the specified widget.
void	setWindow(EmulatedWindowState ews) Set the window on which this mouse handler acts.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger

local

private static final MouseHandler.ContextContainer local

Context-local data for this mouse-handler.

ews

protected EmulatedWindowState ews

The GUI window emulator with which this mouse handler is registered.

tc

protected final ThinClient tc

Access to ThinClient.

Constructor Detail

MouseHandler

public MouseHandler()

Create a new mouse handler, for the specified window emulator.

Method Detail

getCachedActions

public static org.roaringbitmap.RoaringBitmap getCachedActions(int wid,
                                                               java.util.function.Supplier<org.roaringbitmap.RoaringBitmap> calc)

Get the cached mouse actions for this widget. If not yet cached, resolve them now.

Parameters:

wid - The widget's ID.

calc - The resolver for the widget's mouse actions, if not cached.

Returns:

cached mouse actions for this widget.

captureMouseEvents

public static boolean captureMouseEvents(boolean state)

Enable or disable capture of mouse events.

Parameters:

state - true to capture mouse events, false to ignore them.

Returns:

The previous state.

registerWidgetAction

public static void registerWidgetAction(int wid,
                                        MouseWidgetAction action)

Register the specified mouse action with the specified widget.

Parameters:

wid - The widget ID.

action - The action to be triggered for this widget, via mouse.

deregisterWidget

public static void deregisterWidget(int wid)

Deregister the specified widget for mouse events.

Parameters:

wid - The widget ID.

getWidgetListForTooltipWorkers

public static java.lang.Integer[] getWidgetListForTooltipWorkers()

Getting the list of the widgets with registered tooltip workers.

Returns:

The widget list for ones that have the registered worker.

deregisterTooltipWorker

public static MouseWidgetAction deregisterTooltipWorker(int wId)

Deregister the specified widget for tooltip worker events. The returned worker object should be stored somewhere in caller to be registered further.

Parameters:

wId - The widget ID.

Returns:

The previously registered tooltip worker for given widget or null if the tooltip worker was not registered for this widget.

handleMouseEvent

public static void handleMouseEvent(int sourceID,
                                    java.awt.event.MouseEvent evt)

Handle the specified event, in the context of the specified widget.

Parameters:

sourceID - The source widget ID.

evt - The mouse event.

handleMouseEventIfMovable

private static boolean handleMouseEventIfMovable(Widget<GuiOutputManager> source,
                                                 java.awt.event.MouseEvent evt)

Handle mouse events for movable widgets. If the widgets support mouse direct manipulation, call mouse dragged if left button is dragged.

Parameters:

source - Widget

evt - Mouse event

Returns:

true iv event has been consumed false if not.

handleMouseEventIfSelectable

private static boolean handleMouseEventIfSelectable(Widget<GuiOutputManager> source,
                                                    java.awt.event.MouseEvent evt)

Handle mouse events for selectable widgets. If the widgets support mouse direct manipulation call mouse clicked if left button is clicked.

Parameters:

source - Widget

evt - Mouse event

Returns:

true iv event has been consumed false if not.

performAction

private static void performAction(WidgetId id,
                                  java.awt.event.MouseEvent evt,
                                  java.util.function.Consumer<MouseDirectManipulation> mouseAction)

Use a specific callback over all mouse direct manipulation registered actions.

Parameters:

id - Widget ID

evt - Mouse event

mouseAction - The callback which should be fired.

isMouseClickEvent

private static boolean isMouseClickEvent(java.awt.event.MouseEvent evt)

When a mouse button is clicked 3 events MOUSE_CLICKED, MOUSE_PRESSED and MOUSE_RELEASED are generated. For selectable widgets selection/deselection actions should be performed on MOUSE_CLICKED only but MOUSE_PRESSED and MOUSE_RELEASED events must be consumed.

Parameters:

evt - mouse event.

Returns:

true if is a mouse click false if not.

getWidgetActions

public static org.roaringbitmap.RoaringBitmap getWidgetActions(int widgetId)

Get the event IDs for all actions registered with the specified widget.

Parameters:

widgetId - The widget ID.

Returns:

See above.

applyMouseEvent

protected static void applyMouseEvent(Widget<GuiOutputManager> mouseSource,
                                      java.awt.event.MouseEvent evt)

Apply the specified mouse event to the specified source.

Parameters:

mouseSource - The mouse source.

evt - The mouse event.

processWidgetActions

protected static void processWidgetActions(int sourceID,
                                           java.awt.event.MouseEvent evt)

Process the mouse actions registered for the specified source.

Parameters:

sourceID - The source widget ID.

evt - The mouse event.

setWindow

public void setWindow(EmulatedWindowState ews)

Set the window on which this mouse handler acts.

Parameters:

ews - The window.

mouseClicked

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

Notification of a mouse clicked event. Event will be posted via ThinClient.postMouseEvent(java.awt.event.MouseEvent, int) only if mouse processing is active.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Overrides:

mouseClicked in class java.awt.event.MouseAdapter

Parameters:

e - The mouse event.

mousePressed

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

Notification of a mouse pressed event. Event will be posted via ThinClient.postMouseEvent(java.awt.event.MouseEvent, int) only if mouse processing is active.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class java.awt.event.MouseAdapter

Parameters:

e - The mouse event.

mouseDragged

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

Notification of a mouse dragged event. Event will be posted via ThinClient.postMouseEvent(java.awt.event.MouseEvent, int) only if mouse processing is active.

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

Overrides:

mouseDragged in class java.awt.event.MouseAdapter

Parameters:

e - The mouse event.

mouseReleased

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

Notification of a mouse released event. Event will be posted via ThinClient.postMouseEvent(java.awt.event.MouseEvent, int) only if mouse processing is active.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class java.awt.event.MouseAdapter

Parameters:

e - The mouse event.

mouseExited

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

Notification of a mouse exited event. Event will be posted via ThinClient.postMouseEvent(java.awt.event.MouseEvent, int) only if mouse processing is active.

Specified by:

mouseExited in interface java.awt.event.MouseListener

Overrides:

mouseExited in class java.awt.event.MouseAdapter

Parameters:

e - The mouse event.

mouseEntered

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

Notification of a mouse entered event. Event will be posted via ThinClient.postMouseEvent(java.awt.event.MouseEvent, int) only if mouse processing is active.

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Overrides:

mouseEntered in class java.awt.event.MouseAdapter

Parameters:

e - The mouse event.

mouseMoved

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

Notification of a mouse moved event. Event will be posted via ThinClient.postMouseEvent(java.awt.event.MouseEvent, int) only if mouse processing is active.

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

Overrides:

mouseMoved in class java.awt.event.MouseAdapter

Parameters:

e - The mouse event.

mouseWheelMoved

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

Notification of a mouse wheel moved event. Event will be posted via ThinClient.postMouseEvent(java.awt.event.MouseEvent, int) only if mouse processing is active.

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

Overrides:

mouseWheelMoved in class java.awt.event.MouseAdapter

Parameters:

e - The mouse event.

canProcessMouse

protected static boolean canProcessMouse(java.awt.event.MouseEvent evt)

Determine if mouse events can be processed.

Returns:

See above.