mesquite.lib
Interface Commandable

All Known Subinterfaces:

LegendHolder

All Known Implementing Classes:

AnnotationsPanel, Associable, InfoBar, Legend, ListableVector, MesquiteFile, MesquiteModule, MesquiteProject, MesquiteTree, MesquiteWindow, MousePanel, ToolPalette, TreeVector

public interface Commandable

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

Method Summary

java.lang.Object

doCommand(java.lang.String commandName, java.lang.String arguments, CommandRecord commandRec, CommandChecker checker) This method sends two strings to the Commandable: the command name, and the arguments.

Method Detail

doCommand

public java.lang.Object doCommand(java.lang.String commandName,
                                  java.lang.String arguments,
                                  CommandRecord commandRec,
                                  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.