com.swath.cmd
Class UserChoice

java.lang.Object
  com.swath.Info
      com.swath.cmd.SwathCommand
          com.swath.cmd.UserChoice

All Implemented Interfaces:

CommandIfc

public final class UserChoice

extends com.swath.cmd.SwathCommand

Ask the user to choose between some options in a dialog box.
Prompts: -

Since:

SWATH 1.7

See Also:

MessageBox, UserInput, UserChoiceList

Field Summary

static int	BUTTON_CANCEL Cancel button pressed.
static int	BUTTON_FIRST First button pressed.
static int	BUTTON_SECOND Second button pressed.
static int	BUTTON_THIRD Third button pressed.

Method Summary

static int	exec(java.lang.String text, java.lang.String caption, java.lang.String button1, java.lang.String button2, java.lang.String button3) Ask the user to choose between some options in a dialog box.
java.lang.String	getClassName() Gets the command class name.
java.lang.String	getName() Gets the name of the command.
java.util.Enumeration	getParams() Gets the command parameters.
boolean	initCommand()
boolean	isInternal() Indicates if this is an internal SWATH command or not.
boolean	isUserDefined() Indicates if this command is user defined or not.

Methods inherited from class java.lang.Object

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

Field Detail

BUTTON_FIRST

public static final int BUTTON_FIRST

First button pressed.

See Also:

Constant Field Values

BUTTON_SECOND

public static final int BUTTON_SECOND

Second button pressed.

See Also:

Constant Field Values

BUTTON_THIRD

public static final int BUTTON_THIRD

Third button pressed.

See Also:

Constant Field Values

BUTTON_CANCEL

public static final int BUTTON_CANCEL

Cancel button pressed.

See Also:

Constant Field Values

Method Detail

isInternal

public boolean isInternal()

Description copied from interface: CommandIfc

Indicates if this is an internal SWATH command or not.

initCommand

public boolean initCommand()

exec

public static int exec(java.lang.String text,
                       java.lang.String caption,
                       java.lang.String button1,
                       java.lang.String button2,
                       java.lang.String button3)
                throws java.lang.Exception

Ask the user to choose between some options in a dialog box.

Parameters:

text - The text to display in the dialog box.

caption - The caption text of the dialog box or null if the default script caption text should be used.

button1 - The text of the first (left) button or null to hide the button.

button2 - The text of the second (center) button or null to hide the button.

button3 - The text of the third (right) button or null to hide the button.

Returns:

The choosen button or BUTTON_CANCEL if cancelled.

Throws:

java.lang.Exception

Since:

SWATH 1.7

See Also:

BUTTON_FIRST, BUTTON_SECOND, BUTTON_THIRD, BUTTON_CANCEL

isUserDefined

public final boolean isUserDefined()

Description copied from interface: CommandIfc

Indicates if this command is user defined or not.

Specified by:

isUserDefined in interface CommandIfc

Returns:

true if user defined, otherwise false.

getName

public final java.lang.String getName()

Description copied from interface: CommandIfc

Gets the name of the command.

Specified by:

getName in interface CommandIfc

Returns:

The command name.

getClassName

public final java.lang.String getClassName()

Description copied from interface: CommandIfc

Gets the command class name.

Specified by:

getClassName in interface CommandIfc

Returns:

The class name.

getParams

public final java.util.Enumeration getParams()

Description copied from interface: CommandIfc

Gets the command parameters.

Specified by:

getParams in interface CommandIfc

Returns:

The command parameters.