ej.fp.widget

Class Wheel

java.lang.Object

ej.fp.Widget

ej.fp.util.WidgetWithListener

ej.fp.widget.Wheel

All Implemented Interfaces:

MouseListener

public class Wheel
extends WidgetWithListener
implements MouseListener

Widget to simulate a state machine.

Notes:

• This widget requires a listener: an implementation of Wheel.WheelListener to send the state events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Wheel.WheelListener Interface that handle wheel events.
static class	Wheel.WheelListenerToCommandEvents Default implementation of Wheel.WheelListener.

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
Wheel()

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.
void	mouseDragged(int x, int y) Invoked when a mouse has been dragged on a widget.
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	setListenerClass(String listenerClassName) Defines the user class which has to implement Wheel.WheelListener.
void	setMaxAngle(double maxAngle) Sets the bigger angle the wheel can have.
void	setPushedSkin(Image pushedSkin) Sets the skin to show the wheel press event.
void	setSteps(Image[] steps) Sets the images which simulate the wheel rotation.
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

mouseEntered, mouseExited, mouseMoved, mouseWheelMoved

Constructor Detail

Wheel

public Wheel()

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

mouseDragged

public void mouseDragged(int x,
                         int y)

Description copied from interface: MouseListener

Invoked when a mouse has been dragged on a widget.

Specified by:

mouseDragged in interface MouseListener

Parameters:

x - the mouse x coordinate relative to widget position.

y - the mouse y coordinate relative to widget position.

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.

setListenerClass

public void setListenerClass(String listenerClassName)

Defines the user class which has to implement Wheel.WheelListener.

This method should only be called by front panel parser.

Parameters:

listenerClassName - user listener class name.

setMaxAngle

public void setMaxAngle(double maxAngle)

Sets the bigger angle the wheel can have. A zero-angle means infinite.

This method should only be called by front panel parser.

Parameters:

maxAngle - an angle in degree.

setPushedSkin

public void setPushedSkin(Image pushedSkin)

Sets the skin to show the wheel press event.

This method should only be called by front panel parser.

Parameters:

pushedSkin - the press skin.

setSteps

public void setSteps(Image[] steps)

Sets the images which simulate the wheel rotation. The number of images is not defined but first image is for the wheel state 0° and the last image for the wheel state max°.

This method should only be called by front panel parser.

Parameters:

steps - array of images.

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