org.basex.gui
Interface GUICommand

All Known Implementing Classes:
GUICommands

public interface GUICommand

This interface defines GUI command methods.

Author:
Workgroup DBIS, University of Konstanz 2005-10, ISC License, Christian Gruen

Method Summary
 boolean checked()
          Returns if this command includes a menu checkbox.
 String desc()
          Returns the command entry.
 void execute(GUI gui)
          Executes the command.
 String help()
          Returns the command help.
 String key()
          Returns the command shortcut.
 void refresh(GUI gui, AbstractButton button)
          Enables or disables the specified button, depending on the command properties.
 

Method Detail

execute

void execute(GUI gui)
Executes the command.

Parameters:
gui - reference to the main window

refresh

void refresh(GUI gui,
             AbstractButton button)
Enables or disables the specified button, depending on the command properties.

Parameters:
gui - reference to the main window
button - button to be modified

checked

boolean checked()
Returns if this command includes a menu checkbox.

Returns:
result of check

desc

String desc()
Returns the command entry.

Returns:
command entry

help

String help()
Returns the command help.

Returns:
command help

key

String key()
Returns the command shortcut.

Returns:
command shortcut