com.swath.cmd
Class VisualMap

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

All Implemented Interfaces:

CommandIfc

public final class VisualMap

extends com.swath.cmd.SwathCommand

Control the Visual Map. You can show/hide the Visual Map and choose which sector to display.
Prompts: -

Since:

SWATH 1.6.2

Method Summary

static void	exec(boolean show) Show or hide the Visual Map.
static void	exec(int sector, boolean show) Display a sector in the Visual Map.
static void	exec(Sector sector, boolean show) Display a sector in the Visual Map.
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()
                    throws java.lang.Exception

Throws:

java.lang.Exception

exec

public static void exec(boolean show)
                 throws java.lang.Exception

Show or hide the Visual Map.

Parameters:

show - true to show the Visual Map or false to hide it.

Throws:

java.lang.Exception

Since:

SWATH 1.6.2

exec

public static void exec(int sector,
                        boolean show)
                 throws java.lang.Exception

Display a sector in the Visual Map.

Parameters:

sector - The sector to display.

show - true to show the Visual Map or false to hide it.

Throws:

java.lang.Exception

Since:

SWATH 1.6.2

exec

public static void exec(Sector sector,
                        boolean show)
                 throws java.lang.Exception

Display a sector in the Visual Map.

Parameters:

sector - The sector to display.

show - true to show the Visual Map or false to hide it.

Throws:

java.lang.Exception

Since:

SWATH 1.6.2

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.