org.basex.gui

Enum GUICommands

java.lang.Object

java.lang.Enum<GUICommands>

org.basex.gui.GUICommands

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GUICommands>, GUICommand

public enum GUICommands
extends java.lang.Enum<GUICommands>
implements GUICommand

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

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Enum Constant Summary

Enum Constants

Enum Constant and Description
C_ABOUT Shows the "about" information.
C_CLOSE Closes the database.
C_COLOR Color schema.
C_COMMUNITY Opens the community web page.
C_COPY Copies the currently marked nodes.
C_COPYPATH Copies the current path.
C_CREATE Opens a dialog to create a new database.
C_DELETE Deletes the currently marked nodes.
C_EDIT Opens a dialog to edit the currently marked nodes.
C_EDITCLOSE Closes the current editor file.
C_EDITNEW Opens a query file.
C_EDITOPEN Opens a new editor file.
C_EDITSAVE Saves the current editor file.
C_EDITSAVEAS Saves the current editor file under a new name.
C_EXIT Exits the application.
C_EXPORT Exports a database.
C_FILTER Filters the currently marked nodes.
C_FONTS Changes the fonts.
C_FULL Fullscreen mode.
C_GOBACK Goes one step back.
C_GOFORWARD Goes one step forward.
C_GOHOME Goes to the root node.
C_GOUP Goes one level up.
C_HELP Shows the documentation web page.
C_HOME Displays the root node in the text view.
C_INFO Shows database info.
C_INSERT Inserts new nodes.
C_MAPLAYOUT Map layout.
C_OPEN_MANAGE Opens a dialog to manage databases.
C_PACKAGES Repository manager.
C_PASTE Pastes the copied nodes.
C_PREFS Shows a preference dialog.
C_RTEXEC Realtime execution on/off.
C_RTFILTER Realtime filtering on/off.
C_SERVER Server Dialog.
C_SHOWBUTTONS Shows the buttons.
C_SHOWEDITOR Shows the XQuery view.
C_SHOWEXPLORE Shows the explorer view.
C_SHOWFOLDER Shows the tree view.
C_SHOWINFO Shows info.
C_SHOWINPUT Show Input Field.
C_SHOWMAP Shows the map.
C_SHOWPLOT Shows the plot view.
C_SHOWSTATUS Shows the status bar.
C_SHOWTABLE Shows the table view.
C_SHOWTEXT Shows the text view.
C_SHOWTREE Shows the tree view.
C_TREEOPTIONS TreeView options.
C_UPDATES Opens the update web page.

Field Summary

Fields inherited from interface org.basex.gui.GUICommand

EMPTY

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checked() Tests if this command includes a menu checkbox.
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 b) Enables or disables the specified button, depending on the command properties.
static GUICommands	valueOf(java.lang.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

clone, compareTo, equals, finalize, 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

C_CREATE

public static final GUICommands C_CREATE

Opens a dialog to create a new database.

C_OPEN_MANAGE

public static final GUICommands C_OPEN_MANAGE

Opens a dialog to manage databases.

C_INFO

public static final GUICommands C_INFO

Shows database info.

C_EXPORT

public static final GUICommands C_EXPORT

Exports a database.

C_CLOSE

public static final GUICommands C_CLOSE

Closes the database.

C_SERVER

public static final GUICommands C_SERVER

Server Dialog.

C_EDITNEW

public static final GUICommands C_EDITNEW

Opens a query file.

C_EDITOPEN

public static final GUICommands C_EDITOPEN

Opens a new editor file.

C_EDITSAVE

public static final GUICommands C_EDITSAVE

Saves the current editor file.

C_EDITSAVEAS

public static final GUICommands C_EDITSAVEAS

Saves the current editor file under a new name.

C_EDITCLOSE

public static final GUICommands C_EDITCLOSE

Closes the current editor file.

C_EXIT

public static final GUICommands C_EXIT

Exits the application.

C_COPYPATH

public static final GUICommands C_COPYPATH

Copies the current path.

C_COPY

public static final GUICommands C_COPY

Copies the currently marked nodes.

C_PASTE

public static final GUICommands C_PASTE

Pastes the copied nodes.

C_DELETE

public static final GUICommands C_DELETE

Deletes the currently marked nodes.

C_INSERT

public static final GUICommands C_INSERT

Inserts new nodes.

C_EDIT

public static final GUICommands C_EDIT

Opens a dialog to edit the currently marked nodes.

C_FILTER

public static final GUICommands C_FILTER

Filters the currently marked nodes.

C_SHOWEDITOR

public static final GUICommands C_SHOWEDITOR

Shows the XQuery view.

C_SHOWINFO

public static final GUICommands C_SHOWINFO

Shows info.

C_PACKAGES

public static final GUICommands C_PACKAGES

Repository manager.

C_SHOWBUTTONS

public static final GUICommands C_SHOWBUTTONS

Shows the buttons.

C_SHOWINPUT

public static final GUICommands C_SHOWINPUT

Show Input Field.

C_SHOWSTATUS

public static final GUICommands C_SHOWSTATUS

Shows the status bar.

C_SHOWTEXT

public static final GUICommands C_SHOWTEXT

Shows the text view.

C_SHOWMAP

public static final GUICommands C_SHOWMAP

Shows the map.

C_SHOWTREE

public static final GUICommands C_SHOWTREE

Shows the tree view.

C_SHOWFOLDER

public static final GUICommands C_SHOWFOLDER

Shows the tree view.

C_SHOWPLOT

public static final GUICommands C_SHOWPLOT

Shows the plot view.

C_SHOWTABLE

public static final GUICommands C_SHOWTABLE

Shows the table view.

C_SHOWEXPLORE

public static final GUICommands C_SHOWEXPLORE

Shows the explorer view.

C_FULL

public static final GUICommands C_FULL

Fullscreen mode.

C_RTEXEC

public static final GUICommands C_RTEXEC

Realtime execution on/off.

C_RTFILTER

public static final GUICommands C_RTFILTER

Realtime filtering on/off.

C_COLOR

public static final GUICommands C_COLOR

Color schema.

C_FONTS

public static final GUICommands C_FONTS

Changes the fonts.

C_MAPLAYOUT

public static final GUICommands C_MAPLAYOUT

Map layout.

C_TREEOPTIONS

public static final GUICommands C_TREEOPTIONS

TreeView options.

C_PREFS

public static final GUICommands C_PREFS

Shows a preference dialog.

C_HELP

public static final GUICommands C_HELP

Shows the documentation web page.

C_COMMUNITY

public static final GUICommands C_COMMUNITY

Opens the community web page.

C_UPDATES

public static final GUICommands C_UPDATES

Opens the update web page.

C_ABOUT

public static final GUICommands C_ABOUT

Shows the "about" information.

C_GOBACK

public static final GUICommands C_GOBACK

Goes one step back.

C_GOFORWARD

public static final GUICommands C_GOFORWARD

Goes one step forward.

C_GOUP

public static final GUICommands C_GOUP

Goes one level up.

C_GOHOME

public static final GUICommands C_GOHOME

Goes to the root node.

C_HOME

public static final GUICommands C_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(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

refresh

public void refresh(GUI gui,
           javax.swing.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

Tests if this command includes a menu checkbox.

Specified by:

checked in interface GUICommand

Returns:

result of check

help

public java.lang.String help()

Description copied from interface: GUICommand

Returns the command help.

Specified by:

help in interface GUICommand

Returns:

command help

label

public java.lang.String label()

Description copied from interface: GUICommand

Returns the command label.

Specified by:

label in interface GUICommand

Returns:

command label

key

public java.lang.String key()

Description copied from interface: GUICommand

Returns the command shortcut.

Specified by:

key in interface GUICommand

Returns:

command shortcut