All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface mesquite.lib.Commandable

public abstract interface Commandable
Interface for object to claim it is commandable. MesquiteModules, MesquiteWindows and other classes are Commandable.


Method Index

 o doCommand(String, String, CommandRecord, CommandChecker)
This method sends two strings to the Commandable: the command name, and the arguments.

Methods

 o doCommand
 public abstract java.lang.Object doCommand(java.lang.String commandName,
                                            java.lang.String arguments,
                                            mesquite.lib.CommandRecord commandRec,
                                            mesquite.lib.CommandChecker checker)
This method sends two strings to the Commandable: the command name, and the arguments. In order to support the command documentation system, a non-null CommandChecker must be passed to the command. The scripting parameter indicates whether the command comes from a script (e.g., saved in the Mesquite block of a NEXUS file, or in a macro file) or is attached to a direct user-interface action (e.g. selecting a menu or hitting a button). In the former, the commanded object should avoid interaction with the user to make decisions about parameters; in the latter, it is appropriate for the object to query the user for informations as needed.


All Packages  Class Hierarchy  This Package  Previous  Next  Index