ej.fp.widget

Class Button

java.lang.Object

ej.fp.Widget

ej.fp.util.WidgetWithListener

ej.fp.widget.Button

All Implemented Interfaces:

MouseListener

Direct Known Subclasses:

LongButton, RepeatButton

public class Button
extends WidgetWithListener
implements MouseListener

Basic widget to simulate a button with two states: pressed 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Button.ButtonListener Interface that handle button events.
static class	Button.ButtonListenerToButtonEvents Default implementation of Button.ButtonListener.

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

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes the widget's associated resources (such as threads, images...).
int	getID() Gets the button identifier (equals to its label).
protected Button.ButtonListener	getListener() Gets the widget listener.
Image	getPushedSkin() Gets the skin which shows the button as pressed.
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.
protected void	press() Default implementation of press action: update the skin and ask to the listener to manage the event.
protected void	release() Default implementation of release action: update the skin and ask to the listener to manage the event.
void	setLabel(String label) Sets the label (tag) of this widget.
void	setListenerClass(String listenerClassName) Defines the user class which has to implement Button.ButtonListener.
void	setPushedSkin(Image pushedSkin) Sets the image which shows the pressed button.
void	start() Starts the widget.

Methods inherited from class ej.fp.util.WidgetWithListener

newListener, setListenerClass

Methods inherited from class ej.fp.Widget

finalizeConfiguration, getAbsoluteX, getAbsoluteY, getCurrentSkin, getFilter, getHeight, getLabel, getParent, getSkin, getWidth, getX, getY, isOver, repaint, repaint, setCurrentSkin, setFilter, setHeight, 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

Button

public Button()

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

getID

public int getID()

Gets the button identifier (equals to its label).

Returns:

the button identifier.

getListener

protected Button.ButtonListener getListener()

Gets the widget listener.

Returns:

the listener which manages the events.

getPushedSkin

public Image getPushedSkin()

Gets the skin which shows the button as pressed.

Returns:

the pushed skin

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.

press

protected void press()

Default implementation of press action: update the skin and ask to the listener to manage the event.

release

protected void release()

Default implementation of release action: update the skin and ask to the listener to manage the event.

setLabel

public void setLabel(String label)

Description copied from class: Widget

Sets the label (tag) of this widget. When null or not set, the default string "" (empty string) is used. This label is useful to retrieve a specific widget in the device hierarchy.

This method should only be called by front panel parser.

Overrides:

setLabel in class Widget

Parameters:

label - the widget label.

See Also:

Device.getWidget(Class, String)

setListenerClass

public void setListenerClass(String listenerClassName)

Defines the user class which has to implement Button.ButtonListener.

This method should only be called by front panel parser.

Parameters:

listenerClassName - user listener class name.

setPushedSkin

public void setPushedSkin(Image pushedSkin)

Sets the image which shows the pressed button.

This method should only be called by front panel parser.

Parameters:

pushedSkin - the button pressed image.

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