ej.fp.widget

Class Button

java.lang.Object

ej.fp.Widget

ej.fp.util.WidgetWithListener

ej.fp.widget.Button

All Implemented Interfaces:

ej.fp.MouseListener

Direct Known Subclasses:

LongButton, RepeatButton

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

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

Method Summary

Modifier and Type	Method and Description
void	dispose()
int	getID() Gets the button identifier (equals to its label).
protected Button.ButtonListener	getListener() Gets the widget listener.
ej.fp.Image	getPushedSkin() Gets the skin which shows the button as pressed.
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.
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(java.lang.String label)
void	setListenerClass(java.lang.String listenerClassName) Defines the user class which has to implement Button.ButtonListener.
void	setPushedSkin(ej.fp.Image pushedSkin) Sets the image which shows the pressed button.
void	start()

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

setLabel

public void setLabel(java.lang.String label)

Overrides:

setLabel in class ej.fp.Widget

setPushedSkin

public void setPushedSkin(ej.fp.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.

setListenerClass

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

start

public void start()

Overrides:

start in class ej.fp.Widget

dispose

public void dispose()

Overrides:

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

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

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.

getListener

protected Button.ButtonListener getListener()

Gets the widget listener.

Returns:

the listener which manages the events.

getPushedSkin

public ej.fp.Image getPushedSkin()

Gets the skin which shows the button as pressed.

Returns:

the pushed skin

getID

public int getID()

Gets the button identifier (equals to its label).

Returns:

the button identifier.