uk.theretiredprogrammer.gpssurvey.ui

Class ButtonActions

java.lang.Object

uk.theretiredprogrammer.gpssurvey.ui.ButtonActions

All Implemented Interfaces:

IRControlAction

public class ButtonActions
extends Object
implements IRControlAction

The Button Actions class - allows definition of Actions associated with buttons.

Author:

Richard Linsdale (richard at theretiredprogrammer.uk)

Nested Class Summary

Nested classes/interfaces inherited from interface uk.theretiredprogrammer.gpssurvey.input.IRControlAction

IRControlAction.Button

Constructor Summary

Constructors

Constructor and Description
ButtonActions() Constructor - no default action defined.
ButtonActions(String title) Constructor - no default action defined.
ButtonActions(String title, String defaultline, Action defaultaction) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	actionOnButton(IRControlAction.Button button) Act on button.
ButtonActions	addLine(IRControlAction.Button button, Action action) Add a button with an action and no associated menu text.
ButtonActions	addLine(IRControlAction.Button button, String text) Add a button (without an action) and its associated menu text.
ButtonActions	addLine(IRControlAction.Button button, String text, Action action) Add a button with an action and its associated menu text.
String	text() Get the formated menu for this set of button actions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ButtonActions

public ButtonActions(String title,
                     String defaultline,
                     Action defaultaction)

Constructor

Parameters:

title - the title to be displayed in any menu associated with these button actions.

defaultline - the text to be displayed for the default action

defaultaction - the default action

ButtonActions

public ButtonActions(String title)

Constructor - no default action defined.

Parameters:

title - the title to be displayed in any menu associated with these button actions.

ButtonActions

public ButtonActions()

Constructor - no default action defined.

Method Detail

addLine

public ButtonActions addLine(IRControlAction.Button button,
                             String text)
                      throws IOException

Add a button (without an action) and its associated menu text.

Parameters:

button - the button

text - the menu text

Returns:

this object

Throws:

IOException - if problems

addLine

public ButtonActions addLine(IRControlAction.Button button,
                             Action action)
                      throws IOException

Add a button with an action and no associated menu text.

Parameters:

button - the button

action - the action for the button

Returns:

this object

Throws:

IOException - if problems

addLine

public ButtonActions addLine(IRControlAction.Button button,
                             String text,
                             Action action)
                      throws IOException

Add a button with an action and its associated menu text.

Parameters:

button - the button

text - the menu text

action - the action for the button

Returns:

this object

Throws:

IOException - if problems

text

public String text()

Get the formated menu for this set of button actions.

Returns:

the menu text

actionOnButton

public boolean actionOnButton(IRControlAction.Button button)
                       throws IOException

Act on button. Undertake th explicit action if define for the button or the default action if defined.

Specified by:

actionOnButton in interface IRControlAction

Parameters:

button - the button

Returns:

true if action taken (either explicit or default)

Throws:

IOException - if problems