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

Class MouseHoverAction

java.lang.Object

java.awt.event.MouseAdapter

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

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

All Implemented Interfaces:

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

public class MouseHoverAction
extends MouseWidgetAction

Mouse hover event handler.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	effectiveWidgetId the id of the sub-widget which is the mouse hover target
private static CentralLogger	LOG Logger
protected boolean	registered flag indicating that handler is registered
protected int	windowId the id of thw widget's window

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

gd, mouseActions, widget

Constructor Summary

Constructors

Constructor and Description
MouseHoverAction(Widget<?> widget) Constructor.
MouseHoverAction(Widget<?> widget, int effectiveWidgetId) Constructor.

Method Summary

Modifier and Type	Method and Description
void	deregister() De-register the handler
GuiDriver	gd() Get the GUI driver
void	mouseEntered(java.awt.event.MouseEvent e) On mouse entered, set the mouse cursor to the effective custom cursor.
void	mouseExited(java.awt.event.MouseEvent e) On mouse exit, set the mouse cursor to the parent widget cursor.
protected MousePtrWrapper	parentCursor() Get the custom cursor of the parent widget
void	register() Register the handler
protected void	setCursor(MousePtrWrapper ptr) Set the custom mouse pointer
java.lang.String	toString() Get the String representation of the handler
void	updateCursor() Update the custom cursor shape
int	wid() Get the id of the sub-widget which is the mouse hover target
Widget<?>	widget() Get the widget for which the action is defined
int	windowId() Get the id of the enclosing window

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

getEventId, hasEvent

Methods inherited from class java.awt.event.MouseAdapter

mouseClicked, mouseDragged, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger

effectiveWidgetId

protected final int effectiveWidgetId

the id of the sub-widget which is the mouse hover target

registered

protected boolean registered

flag indicating that handler is registered

windowId

protected volatile int windowId

the id of thw widget's window

Constructor Detail

MouseHoverAction

public MouseHoverAction(Widget<?> widget,
                        int effectiveWidgetId)

Constructor.

Parameters:

widget - The widget which supports custom mouse cursor.

effectiveWidgetId - The id of the sub-widget which is the mouse hover target

MouseHoverAction

public MouseHoverAction(Widget<?> widget)

Constructor.

Parameters:

widget - The widget which supports custom mouse cursor.

Method Detail

mouseEntered

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

On mouse entered, set the mouse cursor to the effective custom cursor.

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Overrides:

mouseEntered in class java.awt.event.MouseAdapter

Parameters:

e - The mouse event.

mouseExited

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

On mouse exit, set the mouse cursor to the parent widget cursor.

Specified by:

mouseExited in interface java.awt.event.MouseListener

Overrides:

mouseExited in class java.awt.event.MouseAdapter

Parameters:

e - The mouse event.

updateCursor

public void updateCursor()

Update the custom cursor shape

parentCursor

protected MousePtrWrapper parentCursor()

Get the custom cursor of the parent widget

Returns:

the custom cursor of the parent widget

gd

public GuiDriver gd()

Get the GUI driver

Returns:

the GUI driver

wid

public int wid()

Get the id of the sub-widget which is the mouse hover target

Returns:

the id of the sub-widget which is the mouse hover target

widget

public Widget<?> widget()

Get the widget for which the action is defined

Returns:

the widget for which the action is defined

windowId

public int windowId()

Get the id of the enclosing window

Returns:

the id of the enclosing window

register

public void register()

Register the handler

deregister

public void deregister()

De-register the handler

setCursor

protected void setCursor(MousePtrWrapper ptr)

Set the custom mouse pointer

Parameters:

ptr - the custom mouse pointer

toString

public java.lang.String toString()

Get the String representation of the handler

Overrides:

toString in class java.lang.Object

Returns:

the the String representation of the handler