ej.fp.widget

Class Joystick

java.lang.Object

ej.fp.Widget

ej.fp.util.WidgetWithListener

ej.fp.widget.Joystick

All Implemented Interfaces:

MouseListener, ThirdEventThread.ThirdEventWidget

public class Joystick
extends WidgetWithListener
implements MouseListener, ThirdEventThread.ThirdEventWidget

This widget simulates until five buttons organized like a cross + center button. It manages three states by button: pressed, repeat and released.

Notes:

• This widget requires a listener: an implementation of Button.ButtonListener to send the button events,
• The widget label must be an integer. It allows to create a MicroUI event using this button ID,
• The center button event is sent using the mouse third button (often right button),
• The center button can be disabled using setDisableEnter(boolean) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Joystick.JoystickListener Interface that handle joystick buttons events.
static class	Joystick.JoystickListenerToCommandEvents Default implementation of Joystick.JoystickListener.

Nested classes/interfaces inherited from class ej.fp.Widget

Widget.WidgetAttribute, Widget.WidgetDescription

Nested classes/interfaces inherited from interface ej.fp.MouseListener

MouseListener.MouseButton

Field Summary

Fields inherited from class ej.fp.Widget

DEFAULT_LABEL

Constructor Summary

Constructors

Constructor and Description
Joystick() Creates a joystick widget.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes the widget's associated resources (such as threads, images...).
void	finalizeConfiguration() Checks whether the widget configuration is valid or not and finalizes the widget configuration according all attributes previously set.
int	getSleepPeriod() The thread sleep period is different than buttons period: thread should work faster than the buttons period in order to be able to simulate several repeat event on several buttons.
void	mousePressed(int x, int y, MouseListener.MouseButton button) Invoked when a mouse has been pressed on a widget.
void	mouseReleased(int x, int y, MouseListener.MouseButton button) Invoked when a mouse has been released on a widget.
protected Object	newDefaultListener() Lets subclass creates a default listener.
void	sendThirdEvent() Asks to send the third event.
void	setDisableEnter(boolean disableEnter) Disables enter button.
void	setDownSkin(Image skin) Sets the skin to show joystick DOWN action.
void	setEnterSkin(Image skin) Sets the skin to show joystick ENTER action.
void	setLeftSkin(Image skin) Sets the skin to show joystick LEFT action.
void	setListenerClass(String listenerClassName) Defines the user class which has to implement Joystick.JoystickListener.
void	setRepeatPeriod(int period) Sets the repeat event period.
void	setRightSkin(Image skin) Sets the skin to show joystick RIGHT action.
void	setUpSkin(Image skin) Sets the skin to show joystick UP action.
void	start() Starts the widget.

Methods inherited from class ej.fp.util.WidgetWithListener

newListener, setListenerClass

Methods inherited from class ej.fp.Widget

getAbsoluteX, getAbsoluteY, getCurrentSkin, getFilter, getHeight, getLabel, getParent, getSkin, getWidth, getX, getY, isOver, repaint, repaint, setCurrentSkin, setFilter, setHeight, setLabel, setOverlay, setSkin, setWidth, setX, setY, showYourself

Methods inherited from class java.lang.Object

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

Methods inherited from interface ej.fp.MouseListener

mouseDragged, mouseEntered, mouseExited, mouseMoved, mouseWheelMoved

Constructor Detail

Joystick

public Joystick()

Creates a joystick widget.

The default repeat period is 200ms.

Method Detail

dispose

public void dispose()

Description copied from class: Widget

Disposes the widget's associated resources (such as threads, images...).

Default behavior disposes the common images and subclasses should override this method to define their own behavior.

This method should only be called by front panel engine.

Overrides:

dispose in class Widget

finalizeConfiguration

public void finalizeConfiguration()

Description copied from class: Widget

Checks whether the widget configuration is valid or not and finalizes the widget configuration according all attributes previously set.

The widget attributes are set by the front panel parser but the order is not defined. This method allows to perform some checks between several attributes (this method is called by the front panel parser after setting all attributes defined in front panel file).

The configuration validation depends on widget itself. Each subclass must verify its configuration after checking its parent configuration.

When framework calling this method, all device widgets are not created and finalized yet, and by extension the device itself is not fully created too. So the implementation must not have to call some methods on other widgets and the methods Device.getDevice() or FrontPanel.getDevice(). As soon as all widgets are created and finalized, the simulation starts calling the method Widget.start() on each widget. As this moment only, the widget is able to use the other widgets and the device itself.

On configuration error, a RuntimeException (or a subclass of RuntimeException) must be thrown.

This method should only be called by front panel parser.

Overrides:

finalizeConfiguration in class Widget

getSleepPeriod

public int getSleepPeriod()

The thread sleep period is different than buttons period: thread should work faster than the buttons period in order to be able to simulate several repeat event on several buttons.

Specified by:

getSleepPeriod in interface ThirdEventThread.ThirdEventWidget

Returns:

a time in milliseconds.

mousePressed

public void mousePressed(int x,
                         int y,
                         MouseListener.MouseButton button)

Description copied from interface: MouseListener

Invoked when a mouse has been pressed on a widget.

Specified by:

mousePressed in interface MouseListener

Parameters:

x - the mouse x coordinate relative to widget position.

y - the mouse y coordinate relative to widget position.

button - the button that has been pressed.

mouseReleased

public void mouseReleased(int x,
                          int y,
                          MouseListener.MouseButton button)

Description copied from interface: MouseListener

Invoked when a mouse has been released on a widget.

Specified by:

mouseReleased in interface MouseListener

Parameters:

x - the mouse x coordinate relative to widget position.

y - the mouse y coordinate relative to widget position.

button - the button that has been released.

newDefaultListener

protected Object newDefaultListener()

Description copied from class: WidgetWithListener

Lets subclass creates a default listener. This method must not return null. The listener should at least prints some traces in the standard output stream.

Overrides:

newDefaultListener in class WidgetWithListener

Returns:

a default listener.

sendThirdEvent

public void sendThirdEvent()

Description copied from interface: ThirdEventThread.ThirdEventWidget

Asks to send the third event.

Specified by:

sendThirdEvent in interface ThirdEventThread.ThirdEventWidget

setDisableEnter

public void setDisableEnter(boolean disableEnter)

Disables enter button. By default this button is enabled.

This method should only be called by front panel parser.

Parameters:

disableEnter - true to disable enter button.

setDownSkin

public void setDownSkin(Image skin)

Sets the skin to show joystick DOWN action.

This method should only be called by front panel parser.

Parameters:

skin - skin for joystick DOWN action.

setEnterSkin

public void setEnterSkin(Image skin)

Sets the skin to show joystick ENTER action.

This method should only be called by front panel parser.

Parameters:

skin - skin for joystick ENTER action.

setLeftSkin

public void setLeftSkin(Image skin)

Sets the skin to show joystick LEFT action.

This method should only be called by front panel parser.

Parameters:

skin - skin for joystick LEFT action.

setListenerClass

public void setListenerClass(String listenerClassName)

Defines the user class which has to implement Joystick.JoystickListener.

This method should only be called by front panel parser.

Parameters:

listenerClassName - user listener class name.

setRepeatPeriod

public void setRepeatPeriod(int period)

Sets the repeat event period.

This method should only be called by front panel parser.

Parameters:

period - a time in milliseconds.

setRightSkin

public void setRightSkin(Image skin)

Sets the skin to show joystick RIGHT action.

This method should only be called by front panel parser.

Parameters:

skin - skin for joystick RIGHT action.

setUpSkin

public void setUpSkin(Image skin)

Sets the skin to show joystick UP action.

This method should only be called by front panel parser.

Parameters:

skin - skin for joystick UP action.

start

public void start()

Description copied from class: Widget

Starts the widget. For instance a widget can start a thread, call methods on other widgets (all widgets are created and finalized, see Widget.finalizeConfiguration()).

Main implementation does nothing.

This method should only be called by front panel engine.

Overrides:

start in class Widget