com.swath.cmd

Class UserAlert

java.lang.Object

com.swath.Info

com.swath.cmd.UserAlert

All Implemented Interfaces:

CommandIfc

public final class UserAlert
extends Info

Display a user alert window to the user and print the text in the SWATH console window.
Prompts: -

Since:

SWATH 1.6

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_ERROR User error alert.
static int	TYPE_INFORMATION User information alert.
static int	TYPE_WARNING User warning alert.

Method Summary

Modifier and Type	Method and Description
static void	exec(java.lang.String text, int type) Display a user alert window to the user and print the text in the SWATH console window.
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

TYPE_INFORMATION

public static final int TYPE_INFORMATION

User information alert.

See Also:

Constant Field Values

TYPE_WARNING

public static final int TYPE_WARNING

User warning alert.

See Also:

Constant Field Values

TYPE_ERROR

public static final int TYPE_ERROR

User error alert.

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.

Specified by:

isInternal in interface CommandIfc

Returns:

true if internal, otherwise false.

initCommand

public boolean initCommand()

exec

public static void exec(java.lang.String text,
                        int type)
                 throws java.lang.Exception

Display a user alert window to the user and print the text in the SWATH console window.

Parameters:

text - The text to display in the alert.

type - The type of user alert to display.

Throws:

java.lang.Exception

Since:

SWATH 1.6

See Also:

TYPE_INFORMATION, TYPE_WARNING, TYPE_ERROR

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.