com.swath.cmd
Class UserInput

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

All Implemented Interfaces:

CommandIfc

public final class UserInput

extends com.swath.cmd.SwathCommand

Ask the user to input a text string using a dialog box.
Prompts: -

Since:

SWATH 1.7

See Also:

UserChoice, UserChoiceList

Method Summary

static java.lang.String	exec(java.lang.String text) Ask the user to input a text string using a dialog box.
static java.lang.String	exec(java.lang.String text, java.lang.String caption, java.lang.String defaultInput, boolean hideInput) Ask the user to input a text string using 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

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 java.lang.String exec(java.lang.String text)
                             throws java.lang.Exception

Ask the user to input a text string using a dialog box.

Parameters:

text - The text to display in the dialog box.

Returns:

The text input from the user or null if cancelled.

Throws:

java.lang.Exception

Since:

SWATH 1.7

exec

public static java.lang.String exec(java.lang.String text,
                                    java.lang.String caption,
                                    java.lang.String defaultInput,
                                    boolean hideInput)
                             throws java.lang.Exception

Ask the user to input a text string using 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.

defaultInput - The default input text or null if none.

hideInput - true to hide the input characters or false otherwise.

Returns:

The text input from the user or null if cancelled.

Throws:

java.lang.Exception

Since:

SWATH 1.7

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.