ej.fp.widget

Class RepeatButton

java.lang.Object

ej.fp.Widget

ej.fp.util.WidgetWithListener

ej.fp.widget.Button

ej.fp.widget.RepeatButton

All Implemented Interfaces:

MouseListener, ThirdEventThread.ThirdEventWidget

public class RepeatButton
extends Button
implements ThirdEventThread.ThirdEventWidget

Extended button widget which manages repeat button press events.

Notes:

• This widget requires a listener: an implementation of RepeatButton.RepeatButtonListener 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	RepeatButton.RepeatButtonListener Interface that handle repeat button press events.
static class	RepeatButton.RepeatButtonListenerToButtonEvents Default implementation of RepeatButton.RepeatButtonListener.

Nested classes/interfaces inherited from class ej.fp.widget.Button

Button.ButtonListener, Button.ButtonListenerToButtonEvents

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
RepeatButton() Creates a repeat button widget.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes the widget's associated resources (such as threads, images...).
int	getSleepPeriod() Gets the sleep period the thread has to wait before asking to send third event.
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	sendThirdEvent() Asks to send the third event.
void	setListenerClass(String listenerClassName) Defines the user class which has to implement Button.ButtonListener.
void	setRepeatPeriod(int period) Sets the repeat event period.
void	start() Starts the widget.

Methods inherited from class ej.fp.widget.Button

getID, getListener, getPushedSkin, mousePressed, mouseReleased, setLabel, setPushedSkin

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

RepeatButton

public RepeatButton()

Creates a repeat button widget.

The default repeat period is 200ms.

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 Button

getSleepPeriod

public int getSleepPeriod()

Description copied from interface: ThirdEventThread.ThirdEventWidget

Gets the sleep period the thread has to wait before asking to send third event.

Specified by:

getSleepPeriod in interface ThirdEventThread.ThirdEventWidget

Returns:

a time in milliseconds.

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 Button

Returns:

a default listener.

press

protected void press()

Description copied from class: Button

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

Overrides:

press in class Button

release

protected void release()

Description copied from class: Button

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

Overrides:

release in class Button

sendThirdEvent

public void sendThirdEvent()

Description copied from interface: ThirdEventThread.ThirdEventWidget

Asks to send the third event.

Specified by:

sendThirdEvent in interface ThirdEventThread.ThirdEventWidget

setListenerClass

public void setListenerClass(String listenerClassName)

Description copied from class: Button

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

This method should only be called by front panel parser.

Overrides:

setListenerClass in class Button

Parameters:

listenerClassName - user listener class name.

setRepeatPeriod

public void setRepeatPeriod(int period)

Sets the repeat event period.

This method should only be called by front panel parser.

Parameters:

period - a time in milliseconds.

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 Button