org.basex.gui
Enum GUICommands

java.lang.Object
  extended by java.lang.Enum<GUICommands>
      extended by org.basex.gui.GUICommands
All Implemented Interfaces:
Serializable, Comparable<GUICommands>, GUICommand

public enum GUICommands
extends Enum<GUICommands>
implements GUICommand

This enumeration encapsulates all commands that are triggered by GUI operations.

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

Enum Constant Summary
ABOUT
          Shows the "about" information.
CLOSE
          Closes the database.
COLOR
          Color schema.
COPY
          Copies the currently marked nodes.
COPYPATH
          Copies the current path.
CREATE
          Opens a dialog to create a new database.
CREATEFS
          Opens a dialog to import given directory as DeepFS instance.
DELETE
          Deletes the currently marked nodes.
DQE
          Opens a dialog to use DeepFS instance as Desktop Query Engine.
DROP
          Opens a dialog to drop databases.
EDIT
          Opens a dialog to edit the currently marked nodes.
EXIT
          Exits the application.
EXPORT
          Exports a document.
FILTER
          Filters the currently marked nodes.
FONTS
          Changes the fonts.
FULL
          Fullscreen mode.
GOBACK
          Goes one step back.
GOFORWARD
          Goes one step forward.
GOHOME
          Goes to the root node.
GOUP
          Goes one level up.
HOME
          Displays the root node in the text view.
INFO
          Shows database info.
INSERT
          Inserts new nodes.
MAPLAYOUT
          Map layout.
MOUNTFS
          Opens a dialog to mount DeepFS instance as Filesystem in USErspace.
OPEN
          Opens a dialog to open a database.
PASTE
          Pastes the copied nodes.
PREFS
          Shows a preference dialog.
RTEXEC
          Realtime execution on/off.
RTFILTER
          Realtime filtering on/off.
SERVER
          Server Dialog.
SHOWBUTTONS
          Shows the buttons.
SHOWEXPLORE
          Shows the explorer view.
SHOWFOLDER
          Shows the tree view.
SHOWHELP
          Shows the help window.
SHOWINFO
          Shows info.
SHOWINPUT
          Show Input Field.
SHOWMAP
          Shows the map.
SHOWMENU
          Shows the menu.
SHOWPLOT
          Shows the plot view.
SHOWSTATUS
          Shows the status bar.
SHOWTABLE
          Shows the table view.
SHOWTEXT
          Shows the text view.
SHOWXQUERY
          Shows the XQuery view.
XQOPEN
          Opens an XQuery file.
XQSAVE
          Saves the current XQuery.
XQSAVEAS
          Saves the current XQuery.
 
Method Summary
 boolean checked()
          Returns if this command includes a menu checkbox.
 String desc()
          Returns the command entry.
 String help()
          Returns the command help.
 String key()
          Returns the command shortcut.
 void refresh(GUI gui, AbstractButton b)
          Enables or disables the specified button, depending on the command properties.
static IO save(GUI gui, boolean single)
          Displays a file save dialog and returns the file name or a null reference.
static GUICommands valueOf(String name)
          Returns the enum constant of this type with the specified name.
static GUICommands[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.basex.gui.GUICommand
execute
 

Enum Constant Detail

CREATE

public static final GUICommands CREATE
Opens a dialog to create a new database.


OPEN

public static final GUICommands OPEN
Opens a dialog to open a database.


INFO

public static final GUICommands INFO
Shows database info.


EXPORT

public static final GUICommands EXPORT
Exports a document.


DROP

public static final GUICommands DROP
Opens a dialog to drop databases.


CLOSE

public static final GUICommands CLOSE
Closes the database.


SERVER

public static final GUICommands SERVER
Server Dialog.


XQOPEN

public static final GUICommands XQOPEN
Opens an XQuery file.


XQSAVE

public static final GUICommands XQSAVE
Saves the current XQuery.


XQSAVEAS

public static final GUICommands XQSAVEAS
Saves the current XQuery.


EXIT

public static final GUICommands EXIT
Exits the application.


COPYPATH

public static final GUICommands COPYPATH
Copies the current path.


COPY

public static final GUICommands COPY
Copies the currently marked nodes.


PASTE

public static final GUICommands PASTE
Pastes the copied nodes.


DELETE

public static final GUICommands DELETE
Deletes the currently marked nodes.


INSERT

public static final GUICommands INSERT
Inserts new nodes.


EDIT

public static final GUICommands EDIT
Opens a dialog to edit the currently marked nodes.


FILTER

public static final GUICommands FILTER
Filters the currently marked nodes.


SHOWXQUERY

public static final GUICommands SHOWXQUERY
Shows the XQuery view.


SHOWINFO

public static final GUICommands SHOWINFO
Shows info.


SHOWMENU

public static final GUICommands SHOWMENU
Shows the menu.


SHOWBUTTONS

public static final GUICommands SHOWBUTTONS
Shows the buttons.


SHOWINPUT

public static final GUICommands SHOWINPUT
Show Input Field.


SHOWSTATUS

public static final GUICommands SHOWSTATUS
Shows the status bar.


SHOWTEXT

public static final GUICommands SHOWTEXT
Shows the text view.


SHOWMAP

public static final GUICommands SHOWMAP
Shows the map.


SHOWFOLDER

public static final GUICommands SHOWFOLDER
Shows the tree view.


SHOWTABLE

public static final GUICommands SHOWTABLE
Shows the table view.


SHOWPLOT

public static final GUICommands SHOWPLOT
Shows the plot view.


SHOWEXPLORE

public static final GUICommands SHOWEXPLORE
Shows the explorer view.


FULL

public static final GUICommands FULL
Fullscreen mode.


RTEXEC

public static final GUICommands RTEXEC
Realtime execution on/off.


RTFILTER

public static final GUICommands RTFILTER
Realtime filtering on/off.


COLOR

public static final GUICommands COLOR
Color schema.


FONTS

public static final GUICommands FONTS
Changes the fonts.


MAPLAYOUT

public static final GUICommands MAPLAYOUT
Map layout.


PREFS

public static final GUICommands PREFS
Shows a preference dialog.


CREATEFS

public static final GUICommands CREATEFS
Opens a dialog to import given directory as DeepFS instance.


DQE

public static final GUICommands DQE
Opens a dialog to use DeepFS instance as Desktop Query Engine.


MOUNTFS

public static final GUICommands MOUNTFS
Opens a dialog to mount DeepFS instance as Filesystem in USErspace.


SHOWHELP

public static final GUICommands SHOWHELP
Shows the help window.


ABOUT

public static final GUICommands ABOUT
Shows the "about" information.


GOBACK

public static final GUICommands GOBACK
Goes one step back.


GOFORWARD

public static final GUICommands GOFORWARD
Goes one step forward.


GOUP

public static final GUICommands GOUP
Goes one level up.


GOHOME

public static final GUICommands GOHOME
Goes to the root node.


HOME

public static final GUICommands HOME
Displays the root node in the text view.

Method Detail

values

public static GUICommands[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (GUICommands c : GUICommands.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static GUICommands valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

refresh

public void refresh(GUI gui,
                    AbstractButton b)
Description copied from interface: GUICommand
Enables or disables the specified button, depending on the command properties.

Specified by:
refresh in interface GUICommand
Parameters:
gui - reference to the main window
b - button to be modified

checked

public final boolean checked()
Description copied from interface: GUICommand
Returns if this command includes a menu checkbox.

Specified by:
checked in interface GUICommand
Returns:
result of check

help

public String help()
Description copied from interface: GUICommand
Returns the command help.

Specified by:
help in interface GUICommand
Returns:
command help

desc

public String desc()
Description copied from interface: GUICommand
Returns the command entry.

Specified by:
desc in interface GUICommand
Returns:
command entry

key

public String key()
Description copied from interface: GUICommand
Returns the command shortcut.

Specified by:
key in interface GUICommand
Returns:
command shortcut

save

public static IO save(GUI gui,
                      boolean single)
Displays a file save dialog and returns the file name or a null reference.

Parameters:
gui - gui reference
single - file vs directory dialog
Returns:
io reference