Package org.basex.gui

Interface GUICommand

All Known Implementing Classes:
GUIMenuCmd, GUIPopupCmd
public interface GUICommand
This interface defines GUI command methods.
Author:
BaseX Team 2005-21, BSD License, Christian Gruen

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final GUICommand
    SEPARATOR
    Separator.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    enabled(GUI gui)
    Checks if the command is currently enabled.
    void
    execute(GUI gui)
    Executes the command.
    String
    label()
    Returns the command label.
    boolean
    selected(GUI gui)
    Checks if the command is currently selected.
    String
    shortCut()
    Returns a shortcut.
    Object
    shortcuts()
    Returns the command shortcuts.
    boolean
    toggle()
    Indicates if this is a command that can be turned on and off.

  • Field Details

    • SEPARATOR

      static final GUICommand SEPARATOR
      Separator.

  • Method Details

    • execute

      void execute(GUI gui)
      Executes the command.
      Parameters:
      gui - reference to the main window

    • enabled

      boolean enabled(GUI gui)
      Checks if the command is currently enabled.
      Parameters:
      gui - reference to the main window
      Returns:
      result of check

    • selected

      boolean selected(GUI gui)
      Checks if the command is currently selected.
      Parameters:
      gui - reference to the main window
      Returns:
      result of check

    • toggle

      boolean toggle()
      Indicates if this is a command that can be turned on and off.
      Returns:
      result of check

    • label

      String label()
      Returns the command label.
      Returns:
      command label

    • shortCut

      String shortCut()
      Returns a shortcut.
      Returns:
      shortcut

    • shortcuts

      Object shortcuts()
      Returns the command shortcuts.
      Returns:
      command shortcut