Package org.basex.gui

Enum GUIMenuCmd

java.lang.Object

java.lang.Enum<GUIMenuCmd>

org.basex.gui.GUIMenuCmd

All Implemented Interfaces:

Serializable, Comparable<GUIMenuCmd>, GUICommand

public enum GUIMenuCmd
extends Enum<GUIMenuCmd>
implements GUICommand

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

Author:

BaseX Team 2005-24, BSD License, Christian Gruen

Enum Constant Summary

Enum Constants

Enum Constant	Description
C_ABOUT	Shows the "about" information.
C_CHECK_FOR_UPDATES	Opens the update web page.
C_CLOSE	Closes the database.
C_COLOR	Color schema.
C_COMMENT	Adds or removes a comment.
C_COMMUNITY	Opens the community web page.
C_COPY_NODES	Copies the currently marked nodes.
C_COPY_PATH	Copies the current database path to the clipboard.
C_CREATE	Opens a dialog to create a new database.
C_DELETE_NODES	Deletes the currently marked nodes.
C_EDIT_CLOSE	Closes the current editor file.
C_EDIT_CLOSE_ALL	Closes all editor files.
C_EDIT_NEW	Creates a new file in the editor.
C_EDIT_NODES	Opens a dialog to edit the currently marked nodes.
C_EDIT_OPEN	Opens a new file in the editor.
C_EDIT_REOPEN	Reverts the current editor file.
C_EDIT_SAVE	Saves the current file in the editor.
C_EDIT_SAVE_AS	Saves the current editor file under a new name.
C_EXIT	Exits the application.
C_EXPORT	Exports a database.
C_EXTERNAL_VARIABLES	Edits external variables.
C_FILTER_NODES	Filters the currently marked nodes.
C_FIND_CONTENTS	Finds files.
C_FONTS	Changes the fonts.
C_FORMAT	Formats text in the editor.
C_FULLSCREEN	Fullscreen mode.
C_GO	Runs the currently opened query.
C_GO_BACK	Goes one step back.
C_GO_FORWARD	Goes one step forward.
C_GO_HOME	Goes to the root node.
C_GO_UP	Goes one level up.
C_HELP	Shows the documentation web page.
C_INDENT_RESULT	Indent result.
C_JUMP_TO_BRACKET	Jump to matching bracket.
C_JUMP_TO_FILE	Jumps to the currently edited file.
C_LOWER_CASE	Lower case.
C_NEW_NODES	Inserts new nodes.
C_NEXT_ERROR	Jumps to the next error.
C_OPEN_MANAGE	Opens a dialog to manage databases.
C_PACKAGES	Repository manager.
C_PASTE_NODES	Pastes the copied nodes.
C_PREFERENCES	Shows a preference dialog.
C_PROPERTIES	Shows database info.
C_RT_EXECUTION	Real-time execution on/off.
C_RT_FILTERING	Real-time filtering on/off.
C_SHOW_BUTTONS	Shows the buttons.
C_SHOW_EDITOR	Shows the XQuery view.
C_SHOW_EXPLORE	Shows the explorer view.
C_SHOW_FOLDER	Shows the tree view.
C_SHOW_HOME	Displays the root node in the text view.
C_SHOW_INFO	Shows info.
C_SHOW_INPUT_BAR	Show Input Field.
C_SHOW_MAP	Shows the map.
C_SHOW_MEM	Shows used memory.
C_SHOW_PLOT	Shows the plot view.
C_SHOW_PROJECT	Shows the XQuery project structure.
C_SHOW_RESULT	Shows the text view.
C_SHOW_STATUS_BAR	Shows the status bar.
C_SHOW_TABLE	Shows the table view.
C_SHOW_TREE	Shows the tree view.
C_SORT	Sorts text.
C_TITLE_CASE	Title case.
C_UPPER_CASE	Upper case.

Field Summary

Fields inherited from interface org.basex.gui.GUICommand

SEPARATOR

Method Summary

Modifier and Type	Method	Description
boolean	enabled(GUI gui)	Checks if the command is currently enabled.
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.
static GUIMenuCmd	valueOf(String name)	Returns the enum constant of this type with the specified name.
static GUIMenuCmd[]	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 GUIMenuCmd C_CREATE

Opens a dialog to create a new database.

C_OPEN_MANAGE

public static final GUIMenuCmd C_OPEN_MANAGE

Opens a dialog to manage databases.

C_PROPERTIES

public static final GUIMenuCmd C_PROPERTIES

Shows database info.

C_EXPORT

public static final GUIMenuCmd C_EXPORT

Exports a database.

C_CLOSE

public static final GUIMenuCmd C_CLOSE

Closes the database.

C_EDIT_NEW

public static final GUIMenuCmd C_EDIT_NEW

Creates a new file in the editor.

C_EDIT_OPEN

public static final GUIMenuCmd C_EDIT_OPEN

Opens a new file in the editor.

C_EDIT_REOPEN

public static final GUIMenuCmd C_EDIT_REOPEN

Reverts the current editor file.

C_EDIT_SAVE

public static final GUIMenuCmd C_EDIT_SAVE

Saves the current file in the editor.

C_EDIT_SAVE_AS

public static final GUIMenuCmd C_EDIT_SAVE_AS

Saves the current editor file under a new name.

C_EDIT_CLOSE

public static final GUIMenuCmd C_EDIT_CLOSE

Closes the current editor file.

C_EDIT_CLOSE_ALL

public static final GUIMenuCmd C_EDIT_CLOSE_ALL

Closes all editor files.

C_GO

public static final GUIMenuCmd C_GO

Runs the currently opened query.

C_EXTERNAL_VARIABLES

public static final GUIMenuCmd C_EXTERNAL_VARIABLES

Edits external variables.

C_INDENT_RESULT

public static final GUIMenuCmd C_INDENT_RESULT

Indent result.

C_NEXT_ERROR

public static final GUIMenuCmd C_NEXT_ERROR

Jumps to the next error.

C_COMMENT

public static final GUIMenuCmd C_COMMENT

Adds or removes a comment.

C_FORMAT

public static final GUIMenuCmd C_FORMAT

Formats text in the editor.

C_SORT

public static final GUIMenuCmd C_SORT

Sorts text.

C_LOWER_CASE

public static final GUIMenuCmd C_LOWER_CASE

Lower case.

C_UPPER_CASE

public static final GUIMenuCmd C_UPPER_CASE

Upper case.

C_TITLE_CASE

public static final GUIMenuCmd C_TITLE_CASE

Title case.

C_JUMP_TO_BRACKET

public static final GUIMenuCmd C_JUMP_TO_BRACKET

Jump to matching bracket.

C_EXIT

public static final GUIMenuCmd C_EXIT

Exits the application.

C_COPY_PATH

public static final GUIMenuCmd C_COPY_PATH

Copies the current database path to the clipboard.

C_COPY_NODES

public static final GUIMenuCmd C_COPY_NODES

Copies the currently marked nodes.

C_PASTE_NODES

public static final GUIMenuCmd C_PASTE_NODES

Pastes the copied nodes.

C_DELETE_NODES

public static final GUIMenuCmd C_DELETE_NODES

Deletes the currently marked nodes.

C_NEW_NODES

public static final GUIMenuCmd C_NEW_NODES

Inserts new nodes.

C_EDIT_NODES

public static final GUIMenuCmd C_EDIT_NODES

Opens a dialog to edit the currently marked nodes.

C_FILTER_NODES

public static final GUIMenuCmd C_FILTER_NODES

Filters the currently marked nodes.

C_SHOW_EDITOR

public static final GUIMenuCmd C_SHOW_EDITOR

Shows the XQuery view.

C_JUMP_TO_FILE

public static final GUIMenuCmd C_JUMP_TO_FILE

Jumps to the currently edited file.

C_FIND_CONTENTS

public static final GUIMenuCmd C_FIND_CONTENTS

Finds files.

C_SHOW_PROJECT

public static final GUIMenuCmd C_SHOW_PROJECT

Shows the XQuery project structure.

C_SHOW_INFO

public static final GUIMenuCmd C_SHOW_INFO

Shows info.

C_PACKAGES

public static final GUIMenuCmd C_PACKAGES

Repository manager.

C_SHOW_BUTTONS

public static final GUIMenuCmd C_SHOW_BUTTONS

Shows the buttons.

C_SHOW_INPUT_BAR

public static final GUIMenuCmd C_SHOW_INPUT_BAR

Show Input Field.

C_SHOW_STATUS_BAR

public static final GUIMenuCmd C_SHOW_STATUS_BAR

Shows the status bar.

C_SHOW_RESULT

public static final GUIMenuCmd C_SHOW_RESULT

Shows the text view.

C_SHOW_MAP

public static final GUIMenuCmd C_SHOW_MAP

Shows the map.

C_SHOW_TREE

public static final GUIMenuCmd C_SHOW_TREE

Shows the tree view.

C_SHOW_FOLDER

public static final GUIMenuCmd C_SHOW_FOLDER

Shows the tree view.

C_SHOW_PLOT

public static final GUIMenuCmd C_SHOW_PLOT

Shows the plot view.

C_SHOW_TABLE

public static final GUIMenuCmd C_SHOW_TABLE

Shows the table view.

C_SHOW_EXPLORE

public static final GUIMenuCmd C_SHOW_EXPLORE

Shows the explorer view.

C_SHOW_MEM

public static final GUIMenuCmd C_SHOW_MEM

Shows used memory.

C_FULLSCREEN

public static final GUIMenuCmd C_FULLSCREEN

Fullscreen mode.

C_RT_EXECUTION

public static final GUIMenuCmd C_RT_EXECUTION

Real-time execution on/off.

C_RT_FILTERING

public static final GUIMenuCmd C_RT_FILTERING

Real-time filtering on/off.

C_COLOR

public static final GUIMenuCmd C_COLOR

Color schema.

C_FONTS

public static final GUIMenuCmd C_FONTS

Changes the fonts.

C_PREFERENCES

public static final GUIMenuCmd C_PREFERENCES

Shows a preference dialog.

C_HELP

public static final GUIMenuCmd C_HELP

Shows the documentation web page.

C_COMMUNITY

public static final GUIMenuCmd C_COMMUNITY

Opens the community web page.

C_CHECK_FOR_UPDATES

public static final GUIMenuCmd C_CHECK_FOR_UPDATES

Opens the update web page.

C_ABOUT

public static final GUIMenuCmd C_ABOUT

Shows the "about" information.

C_GO_BACK

public static final GUIMenuCmd C_GO_BACK

Goes one step back.

C_GO_FORWARD

public static final GUIMenuCmd C_GO_FORWARD

Goes one step forward.

C_GO_UP

public static final GUIMenuCmd C_GO_UP

Goes one level up.

C_GO_HOME

public static final GUIMenuCmd C_GO_HOME

Goes to the root node.

C_SHOW_HOME

public static final GUIMenuCmd C_SHOW_HOME

Displays the root node in the text view.

Method Detail

values

public static GUIMenuCmd[] 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 (GUIMenuCmd c : GUIMenuCmd.values())
    System.out.println(c);

Returns:

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

valueOf

public static GUIMenuCmd 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

enabled

public boolean enabled(GUI gui)

Description copied from interface: GUICommand

Checks if the command is currently enabled.

Specified by:

enabled in interface GUICommand

Parameters:

gui - reference to the main window

Returns:

result of check

selected

public boolean selected(GUI gui)

Description copied from interface: GUICommand

Checks if the command is currently selected.

Specified by:

selected in interface GUICommand

Parameters:

gui - reference to the main window

Returns:

result of check

label

public final String label()

Description copied from interface: GUICommand

Returns the command label.

Specified by:

label in interface GUICommand

Returns:

command label

toggle

public final boolean toggle()

Description copied from interface: GUICommand

Indicates if this is a command that can be turned on and off.

Specified by:

toggle in interface GUICommand

Returns:

result of check

shortCut

public String shortCut()

Description copied from interface: GUICommand

Returns a shortcut.

Specified by:

shortCut in interface GUICommand

Returns:

shortcut

shortcuts

public Object shortcuts()

Description copied from interface: GUICommand

Returns the command shortcuts.

Specified by:

shortcuts in interface GUICommand

Returns:

command shortcut