org.xith3d.ui.hud.listeners
Interface WidgetInputListener

All Known Implementing Classes:

WidgetEventsReceiverAdapter, WidgetInputAdapter, WidgetZIndexGroup

public interface WidgetInputListener

A WidgetMouseListener is notified of Widget-Mouse interaction events.

Method Summary

void	onControllerAxisChanged(Widget widget, org.jagatoo.input.devices.components.ControllerAxis axis, int axisDelta) This event is fired when a ControllerAxis has changed and this Widget is the currently focussed one.
void	onControllerButtonPressed(Widget widget, org.jagatoo.input.devices.components.ControllerButton button) This event is fired when a ControllerButton has been pressed and this Widget is the currently focussed one.
void	onControllerButtonReleased(Widget widget, org.jagatoo.input.devices.components.ControllerButton button) This event is fired when a ControllerButton has been released and this Widget is the currently focussed one.
void	onInputStateChanged(Widget widget, org.jagatoo.input.devices.components.DeviceComponent comp, int delta, int state, boolean isTopMost, boolean hasFocus) This event is fired when the state of any DeviceComponent has changed.
void	onKeyPressed(Widget widget, org.jagatoo.input.devices.components.Key key, long when) This event is fired, when a key is pressed on a focused Widget.
void	onKeyReleased(Widget widget, org.jagatoo.input.devices.components.Key key, long when) This event is fired, when a key is released on a focused Widget.
void	onKeyTyped(Widget widget, char ch, long when) This event is fired when a key is typed on the keyboard.
void	onMouseButtonPressed(Widget widget, org.jagatoo.input.devices.components.MouseButton button, int x, int y, long when, long lastWhen, boolean isTopMost, boolean hasFocus) This event is fired, when a mouse button is pressed on a focused Widget.
void	onMouseButtonReleased(Widget widget, org.jagatoo.input.devices.components.MouseButton button, int x, int y, long when, long lastWhen, boolean isTopMost, boolean hasFocus) This event is fired, when a mouse button is released on a focused Widget.
void	onMouseEntered(Widget widget, boolean isTopMost, boolean hasFocus) This method is called when the mouse entered the Widget area
void	onMouseLeft(Widget widget, boolean isTopMost, boolean hasFocus) This method is called when the mouse left the Widget area
void	onMouseMoved(Widget widget, int x, int y, int buttonsState, long when, boolean isTopMost, boolean hasFocus) This event is fired, when the mouse is moved on a Widget.
void	onMouseStopped(Widget widget, int x, int y, long when, boolean isTopMost, boolean hasFocus) This event is fired, when the mouse position has not been changed on this Widget for a certain amount of time.
void	onMouseUnbound(Widget widget) This event is fired, when the mouse is released.
void	onMouseWheelMoved(Widget widget, int delta, boolean isPageMove, int x, int y, long when, boolean isTopMost) This event is fired, when the mouse wheel is moved on a Widget.

Method Detail

onKeyPressed

void onKeyPressed(Widget widget,
                  org.jagatoo.input.devices.components.Key key,
                  long when)

This event is fired, when a key is pressed on a focused Widget.

Parameters:

widget - the Widget for which this event was fired

key - the key that was pressed

when - the gameTime of the key event

onKeyReleased

void onKeyReleased(Widget widget,
                   org.jagatoo.input.devices.components.Key key,
                   long when)

This event is fired, when a key is released on a focused Widget.

Parameters:

widget - the Widget for which this event was fired

key - the key that was released

when - the gameTime of the key event

onKeyTyped

void onKeyTyped(Widget widget,
                char ch,
                long when)

This event is fired when a key is typed on the keyboard.

Parameters:

widget - the Widget for which this event was fired

ch - the typed key's character

when - the gameTime of the key event

onMouseButtonPressed

void onMouseButtonPressed(Widget widget,
                          org.jagatoo.input.devices.components.MouseButton button,
                          int x,
                          int y,
                          long when,
                          long lastWhen,
                          boolean isTopMost,
                          boolean hasFocus)

This event is fired, when a mouse button is pressed on a focused Widget.

Parameters:

widget - the Widget for which this event was fired

button - the button that was pressed

x - the current mouse x position

y - the current mouse y position

when - the gameTime of the mouse event

lastWhen - the milli-time when the button has last been pressed

isTopMost - is this Widget topMost

hasFocus - is this Widget focused

onMouseButtonReleased

void onMouseButtonReleased(Widget widget,
                           org.jagatoo.input.devices.components.MouseButton button,
                           int x,
                           int y,
                           long when,
                           long lastWhen,
                           boolean isTopMost,
                           boolean hasFocus)

This event is fired, when a mouse button is released on a focused Widget.

Parameters:

widget - the Widget for which this event was fired

button - the button that was released

x - the current mouse x position

y - the current mouse y position

when - the gameTime of the mouse event

lastWhen - the milli-time when the button has last been released

isTopMost - is this Widget topMost

hasFocus - is this Widget focused

onMouseMoved

void onMouseMoved(Widget widget,
                  int x,
                  int y,
                  int buttonsState,
                  long when,
                  boolean isTopMost,
                  boolean hasFocus)

This event is fired, when the mouse is moved on a Widget.

Parameters:

widget - the Widget for which this event was fired

x - the new X coordinate

y - the new Y coordinate

buttonsState - the buttons' state bitmask

when - the gameTime of the mouse event

isTopMost - is this Widget topMost

hasFocus - is this Widget focused

onMouseStopped

void onMouseStopped(Widget widget,
                    int x,
                    int y,
                    long when,
                    boolean isTopMost,
                    boolean hasFocus)

This event is fired, when the mouse position has not been changed on this Widget for a certain amount of time.

Parameters:

widget - the Widget for which this event was fired

x - the new X coordinate

y - the new Y coordinate

when - the gameTime of the mouse event

isTopMost - is this Widget topMost

hasFocus - is this Widget focused

onMouseWheelMoved

void onMouseWheelMoved(Widget widget,
                       int delta,
                       boolean isPageMove,
                       int x,
                       int y,
                       long when,
                       boolean isTopMost)

This event is fired, when the mouse wheel is moved on a Widget.

Parameters:

widget - the Widget for which this event was fired

delta - a positive value when the wheel was moved up

isPageMove - true, if whole pages are to be scrolled with this wheel move

x - the current mouse x position

y - the current mouse y position

when - the gameTime of the mouse event

isTopMost - is this Widget topMost

onMouseEntered

void onMouseEntered(Widget widget,
                    boolean isTopMost,
                    boolean hasFocus)

This method is called when the mouse entered the Widget area

Parameters:

widget - the Widget for which this event was fired

isTopMost - is this Widget topMost

hasFocus - is this Widget focused

onMouseLeft

void onMouseLeft(Widget widget,
                 boolean isTopMost,
                 boolean hasFocus)

This method is called when the mouse left the Widget area

Parameters:

widget - the Widget for which this event was fired

isTopMost - is this Widget topMost

hasFocus - is this Widget focused

onMouseUnbound

void onMouseUnbound(Widget widget)

This event is fired, when the mouse is released. onMouseMoved will not be called on the Widget anymore, when the mouse is not over it.

Parameters:

widget - the Widget, which was unbound from the mouse

onControllerButtonPressed

void onControllerButtonPressed(Widget widget,
                               org.jagatoo.input.devices.components.ControllerButton button)

This event is fired when a ControllerButton has been pressed and this Widget is the currently focussed one.

Parameters:

widget - the Widget for which this event was fired

button - the pressed button

onControllerButtonReleased

void onControllerButtonReleased(Widget widget,
                                org.jagatoo.input.devices.components.ControllerButton button)

This event is fired when a ControllerButton has been released and this Widget is the currently focussed one.

Parameters:

widget - the Widget for which this event was fired

button - the released button

onControllerAxisChanged

void onControllerAxisChanged(Widget widget,
                             org.jagatoo.input.devices.components.ControllerAxis axis,
                             int axisDelta)

This event is fired when a ControllerAxis has changed and this Widget is the currently focussed one.

Parameters:

widget - the Widget for which this event was fired

axis - the changed axis

axisDelta -

onInputStateChanged

void onInputStateChanged(Widget widget,
                         org.jagatoo.input.devices.components.DeviceComponent comp,
                         int delta,
                         int state,
                         boolean isTopMost,
                         boolean hasFocus)

This event is fired when the state of any DeviceComponent has changed.

Parameters:

widget - the Widget for which this event was fired

comp -

delta -

state -

isTopMost -

hasFocus -