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

Class UICmd

java.lang.Object

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

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

public class UICmd
extends Command

A command for interacting with and managing the User Interface (UI) elements of the engine.

This command primarily dispatches to its subcommands for specific UI operations. See subcommand documentation for more detail on arguments and usage strings (ToggleCmd)}

Aliases: ui, gui, swing

Typical Usage:

     ui toggle layertree  - 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:

• Command
• ToggleCmd

Field Summary

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

aliases, args, description, usages

Constructor Summary

Constructors

Constructor	Description
UICmd()

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.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

Constructor Details

UICmd

public UICmd()

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.