Package com.j3d.engine.interact.cmd.commands.uicmd

Class ToggleCmd

java.lang.Object

com.j3d.engine.interact.cmd.base.Command

com.j3d.engine.interact.cmd.args.Subcommand

com.j3d.engine.interact.cmd.commands.uicmd.ToggleCmd

All Implemented Interfaces:

Argument

public class ToggleCmd
extends Subcommand

A subcommand of UICmd which toggles the visibility of various UI floating panels.

It provides a required argument that specifies which floating panel to toggle.

Aliases: t, tog

Typical Usage:

     ui toggle layers     - Toggles the visibility of the Layer Tree panel.
     gui t history        - Toggles the visibility of the History panel.
     swing toggle debug   - Toggles the visibility of the Debug panel.
     

Author:

Lehlogonolo Poole

See Also:

• UICmd
• Subcommand
• ArgSet
• LayerTree
• History
• DebugPanel

Field Summary

Fields

Modifier and Type	Field	Description
(package private) ArgSet	argSet

Fields inherited from class com.j3d.engine.interact.cmd.base.Command

aliases, args, description, usages

Constructor Summary

Constructors

Constructor	Description
ToggleCmd()

Method Summary

Modifier and Type	Method	Description
void	run(Invoker invoker, SafeJLabel logLabel, String aliasUsed, Object[] args, ArrayList<TaggedArgValue<?>> taggedArgs)	The method to be overridden by subclasses to implement command functionality.

Methods inherited from class com.j3d.engine.interact.cmd.args.Subcommand

getDescription, getName, isOptional

Methods inherited from class com.j3d.engine.interact.cmd.base.Command

addNoArgUsage, aliases, aliasStream, args, dispatchToSubcommands, getUsages, hasNoArgs, parseUsages, usages, varTaggedArgs

Methods inherited from class java.lang.Object

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

Field Details

argSet

ArgSet argSet

Constructor Details

ToggleCmd

public ToggleCmd()

Method Details

run

public void run(Invoker invoker,
 SafeJLabel logLabel,
 String aliasUsed,
 Object[] args,
 ArrayList<TaggedArgValue<?>> taggedArgs)

Description copied from class: Command

The method to be overridden by subclasses to implement command functionality.

Overrides:

run in class Command

Parameters:

invoker - The invoker of this command

logLabel - The JLabel to display log messages.

aliasUsed - The alias of the command that was used to invoke it.

args - The arguments passed to the command.

taggedArgs - Tagged arguments passed to the command.