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

Class MouseWidgetAction

java.lang.Object

java.awt.event.MouseAdapter

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

All Implemented Interfaces:

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

Direct Known Subclasses:

MouseDirectManipulation, MouseEmptySelector, MouseHoverAction, MouseMoveable, MousePopupable, MouseResizeable, MouseTooltipWorker, SystemAction

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

A generic action which can be applied to a specified widget, via mouse.

Field Summary

Fields

Modifier and Type	Field and Description
private int	eventId The MouseEvt event ID for this high-level action.
protected GuiDriver	gd The active GUI driver.
protected org.roaringbitmap.RoaringBitmap	mouseActions The low-level mouse actions on which this instance can operate.
protected Widget<?>	widget The widget associated with this action.

Constructor Summary

Constructors

Constructor and Description
MouseWidgetAction(int wid, int eventId) Create a new mouse action, for the specified widget.
MouseWidgetAction(int wid, int[] mouseActions, int eventId) Create a new mouse action, for the specified widget.
MouseWidgetAction(Widget<?> widget, int[] mouseActions, int eventId) Create a new mouse action, for the specified widget.

Method Summary

Modifier and Type	Method and Description
int	getEventId() Get the event ID for this high-level action.
boolean	hasEvent(java.awt.event.MouseEvent e) Determine if this complex action requires to process the given mouse event.

Methods inherited from class java.awt.event.MouseAdapter

mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved

Methods inherited from class java.lang.Object

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

Field Detail

widget

protected final Widget<?> widget

The widget associated with this action.

gd

protected final GuiDriver gd

The active GUI driver.

mouseActions

protected org.roaringbitmap.RoaringBitmap mouseActions

The low-level mouse actions on which this instance can operate.

eventId

private final int eventId

The MouseEvt event ID for this high-level action.

Constructor Detail

MouseWidgetAction

public MouseWidgetAction(int wid,
                         int eventId)

Create a new mouse action, for the specified widget.

Parameters:

wid - The widget ID.

eventId - The event ID.

MouseWidgetAction

public MouseWidgetAction(int wid,
                         int[] mouseActions,
                         int eventId)

Create a new mouse action, for the specified widget.

Parameters:

wid - The widget ID.

mouseActions - The low-level mouse events on which this instance operates. May be null if it can act on any mouse event.

eventId - The event ID.

MouseWidgetAction

public MouseWidgetAction(Widget<?> widget,
                         int[] mouseActions,
                         int eventId)

Create a new mouse action, for the specified widget.

Parameters:

widget - The widget.

mouseActions - The low-level mouse events on which this instance operates. May be null if it can act on any mouse event.

eventId - The event ID.

Method Detail

getEventId

public int getEventId()

Get the event ID for this high-level action.

Returns:

See above.

hasEvent

public boolean hasEvent(java.awt.event.MouseEvent e)

Determine if this complex action requires to process the given mouse event.

Parameters:

e - The mouse event.

Returns:

If the event's code is part of the mouseActions.