ej.fp.widget

Class Pointer

java.lang.Object

ej.fp.Widget

ej.fp.util.WidgetWithListener

ej.fp.widget.Pointer

All Implemented Interfaces:

MouseListener

public class Pointer
extends WidgetWithListener
implements MouseListener

Widget to simulate a mouse or a touch panel. It manages too the states for pointer buttons press and release.

Notes:

• This widget requires a listener: an implementation of Pointer.PointerListener to send the pointer events,
• When setTouch(boolean) attribute is false, this widget manages a mouse. Until three buttons are managed,
• When setTouch(boolean) attribute is true, this widget manages a touch panel. Only one button is managed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Pointer.PointerListener Interface that handle pointer events.
static class	Pointer.PointerListenerToPointerEvents Default implementation of Pointer.PointerListener.

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

Method Summary

Modifier and Type	Method and Description
void	finalizeConfiguration() Checks whether the widget configuration is valid or not and finalizes the widget configuration according all attributes previously set.
protected Pointer.PointerListener	getListener() Gets the widget listener.
protected int	getMoveFilteringDelay() Gets the minimum delay (in milliseconds) the system has to respect to send a new move event to the application.
protected boolean	isTouch() Tells if pointer is a touch panel or a mouse.
void	mouseDragged(int x, int y) Invoked when a mouse has been dragged on a widget.
void	mouseEntered(int x, int y) Invoked when a mouse enters a widget.
void	mouseExited(int x, int y) Invoked when a mouse exits a widget.
void	mouseMoved(int x, int y) Invoked when a mouse has been moved 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	setAreaHeight(int height) Sets the area height of the pointer area.
void	setAreaWidth(int width) Sets the area width of the pointer area.
void	setListenerClass(String listenerClassName) Defines the user class which has to implement Pointer.PointerListener.
void	setTouch(boolean touch) Configures touch or mouse mode.
void	start() Starts the widget.

Methods inherited from class ej.fp.util.WidgetWithListener

newListener, setListenerClass

Methods inherited from class ej.fp.Widget

dispose, 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

mouseWheelMoved

Constructor Detail

Pointer

public Pointer()

Method Detail

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

getListener

protected Pointer.PointerListener getListener()

Gets the widget listener.

Returns:

the listener which manages the events.

getMoveFilteringDelay

protected int getMoveFilteringDelay()

Gets the minimum delay (in milliseconds) the system has to respect to send a new move event to the application. Under this delay, the move event is filtered and not sent to the application. This filtering allows to reduce the number of move events sent to the application in order to reduce the application actions (repaint etc.).

Returns:

minimum delay between two move events.

isTouch

protected boolean isTouch()

Tells if pointer is a touch panel or a mouse.

Returns:

true when pointer manages a touch panel.

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.

mouseEntered

public void mouseEntered(int x,
                         int y)

Description copied from interface: MouseListener

Invoked when a mouse enters a widget.

Specified by:

mouseEntered in interface MouseListener

Parameters:

x - the mouse x coordinate relative to widget position.

y - the mouse y coordinate relative to widget position.

mouseExited

public void mouseExited(int x,
                        int y)

Description copied from interface: MouseListener

Invoked when a mouse exits a widget.

Specified by:

mouseExited in interface MouseListener

Parameters:

x - the mouse x coordinate relative to widget position.

y - the mouse y coordinate relative to widget position.

mouseMoved

public void mouseMoved(int x,
                       int y)

Description copied from interface: MouseListener

Invoked when a mouse has been moved on a widget.

Specified by:

mouseMoved 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.

setAreaHeight

public void setAreaHeight(int height)

Sets the area height of the pointer area. If not set, the area height is equals to the widget height (see finalizeConfiguration()).

This method should only be called by front panel parser.

Parameters:

height - the height to set.

setAreaWidth

public void setAreaWidth(int width)

Sets the area width of the pointer area. If not set, the area width is equals to the widget width (see finalizeConfiguration()).

This method should only be called by front panel parser.

Parameters:

width - the width to set.

setListenerClass

public void setListenerClass(String listenerClassName)

Defines the user class which has to implement Pointer.PointerListener.

This method should only be called by front panel parser.

Parameters:

listenerClassName - user listener class name.

setTouch

public void setTouch(boolean touch)

Configures touch or mouse mode.

This method should only be called by front panel parser.

Parameters:

touch - true to set touch mode.

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