org.basex.gui
Interface GUICmd

All Known Implementing Classes:
GUIBaseCmd, GUICommands

public interface GUICmd

This interface defines GUI command methods.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen

Method Summary
 boolean checked()
          Tests if this command includes a menu checkbox.
 void execute(GUI gui)
          Executes the command.
 java.lang.String help()
          Returns the command help.
 java.lang.String key()
          Returns the command shortcut.
 java.lang.String label()
          Returns the command label.
 void refresh(GUI gui, javax.swing.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,
             javax.swing.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()
Tests if this command includes a menu checkbox.

Returns:
result of check

label

java.lang.String label()
Returns the command label.

Returns:
command label

help

java.lang.String help()
Returns the command help.

Returns:
command help

key

java.lang.String key()
Returns the command shortcut.

Returns:
command shortcut