ej.fp.widget

Class Pointer

java.lang.Object

ej.fp.Widget

ej.fp.util.WidgetWithListener

ej.fp.widget.Pointer

All Implemented Interfaces:

ej.fp.MouseListener

public class Pointer
extends WidgetWithListener
implements ej.fp.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

ej.fp.Widget.WidgetAttribute, ej.fp.Widget.WidgetDescription

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

ej.fp.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()
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)
void	mouseEntered(int x, int y)
void	mouseExited(int x, int y)
void	mouseMoved(int x, int y)
void	mousePressed(int x, int y, ej.fp.MouseListener.MouseButton button)
void	mouseReleased(int x, int y, ej.fp.MouseListener.MouseButton button)
protected java.lang.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(java.lang.String listenerClassName) Defines the user class which has to implement Pointer.PointerListener.
void	setTouch(boolean touch) Configures touch or mouse mode.
void	start()

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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ej.fp.MouseListener

mouseWheelMoved

Constructor Detail

Pointer

public Pointer()

Method Detail

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.

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.

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.

setListenerClass

public void setListenerClass(java.lang.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.

finalizeConfiguration

public void finalizeConfiguration()

Overrides:

finalizeConfiguration in class ej.fp.Widget

start

public void start()

Overrides:

start in class ej.fp.Widget

newDefaultListener

protected java.lang.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.

mouseEntered

public void mouseEntered(int x,
                         int y)

Specified by:

mouseEntered in interface ej.fp.MouseListener

mouseExited

public void mouseExited(int x,
                        int y)

Specified by:

mouseExited in interface ej.fp.MouseListener

mouseMoved

public void mouseMoved(int x,
                       int y)

Specified by:

mouseMoved in interface ej.fp.MouseListener

mouseDragged

public void mouseDragged(int x,
                         int y)

Specified by:

mouseDragged in interface ej.fp.MouseListener

mousePressed

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

Specified by:

mousePressed in interface ej.fp.MouseListener

mouseReleased

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

Specified by:

mouseReleased in interface ej.fp.MouseListener

getListener

protected Pointer.PointerListener getListener()

Gets the widget listener.

Returns:

the listener which manages the events.

isTouch

protected boolean isTouch()

Tells if pointer is a touch panel or a mouse.

Returns:

true when pointer manages a touch panel.

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.