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>

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

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

Author:

Workgroup DBIS, University of Konstanz 2005-07, ISC License, Christian Gruen

Enum Constant Summary

ABOUT
Show about information.

BACK
Go one step back.

CLOSE
Reset database.

COLORS
Color schema.

COPY
Copy the currently marked nodes.

CREATE
Create database.

DELETE
Delete the currently marked nodes.

DROP
Drop database.

EDIT
Copy the currently marked nodes.

EXIT
Exit BaseX.

EXPORT
Export document.

FILTER
Filter currently marked nodes.

FONTS
Change fonts.

FORWARD
Go one step forward.

FULL
Fullscreen mode.

IMPORTFS
Import filesystem.

INFO
Show Database info.

INPUTMODE
Realtime filtering on/off.

INSERT
Insert new nodes.

MAPLAYOUT
Map layout.

OPEN
Open database.

PASTE
Paste the copied nodes.

PREFS
Database path.

ROOT
Go to root node.

RTFILTER
Realtime filtering on/off.

SELECT
Select current nodes.

SHOWBUTTONS
Show buttons.

SHOWHELP
Show Help.

SHOWINFO
Show info.

SHOWINPUT
Show Input Field.

SHOWMAP
Show map.

SHOWMENU
Show menu.

SHOWSEARCH
Show search.

SHOWSTATUS
Show Status Bar.

SHOWTABLE
Show Table View.

SHOWTEXT
Show Text View.

SHOWTREE
Show Tree View.

UP
Go one level up.

Field Summary

java.lang.String	entry Menu entry.
java.lang.String	help Help string.
java.lang.String	key Key shortcut.

Method Summary

boolean	checked() Returns if this command includes a menu checkbox.
abstract void	execute() Executes the command.
static GUICommands	get(java.lang.String cmd) Return the command for the specified string.
void	refresh(javax.swing.AbstractButton button, boolean sel) 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

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ABOUT

public static final GUICommands ABOUT

Show about information.

BACK

public static final GUICommands BACK

Go one step back.

CLOSE

public static final GUICommands CLOSE

Reset database.

COLORS

public static final GUICommands COLORS

Color schema.

COPY

public static final GUICommands COPY

Copy the currently marked nodes.

CREATE

public static final GUICommands CREATE

Create database.

DELETE

public static final GUICommands DELETE

Delete the currently marked nodes.

DROP

public static final GUICommands DROP

Drop database.

EDIT

public static final GUICommands EDIT

Copy the currently marked nodes.

EXIT

public static final GUICommands EXIT

Exit BaseX.

EXPORT

public static final GUICommands EXPORT

Export document.

FILTER

public static final GUICommands FILTER

Filter currently marked nodes.

FONTS

public static final GUICommands FONTS

Change fonts.

FORWARD

public static final GUICommands FORWARD

Go one step forward.

FULL

public static final GUICommands FULL

Fullscreen mode.

IMPORTFS

public static final GUICommands IMPORTFS

Import filesystem.

INFO

public static final GUICommands INFO

Show Database info.

INPUTMODE

public static final GUICommands INPUTMODE

Realtime filtering on/off.

INSERT

public static final GUICommands INSERT

Insert new nodes.

MAPLAYOUT

public static final GUICommands MAPLAYOUT

Map layout.

OPEN

public static final GUICommands OPEN

Open database.

PASTE

public static final GUICommands PASTE

Paste the copied nodes.

PREFS

public static final GUICommands PREFS

Database path.

ROOT

public static final GUICommands ROOT

Go to root node.

RTFILTER

public static final GUICommands RTFILTER

Realtime filtering on/off.

SELECT

public static final GUICommands SELECT

Select current nodes.

SHOWBUTTONS

public static final GUICommands SHOWBUTTONS

Show buttons.

SHOWHELP

public static final GUICommands SHOWHELP

Show Help.

SHOWINFO

public static final GUICommands SHOWINFO

Show info.

SHOWINPUT

public static final GUICommands SHOWINPUT

Show Input Field.

SHOWMAP

public static final GUICommands SHOWMAP

Show map.

SHOWMENU

public static final GUICommands SHOWMENU

Show menu.

SHOWSEARCH

public static final GUICommands SHOWSEARCH

Show search.

SHOWSTATUS

public static final GUICommands SHOWSTATUS

Show Status Bar.

SHOWTABLE

public static final GUICommands SHOWTABLE

Show Table View.

SHOWTEXT

public static final GUICommands SHOWTEXT

Show Text View.

SHOWTREE

public static final GUICommands SHOWTREE

Show Tree View.

UP

public static final GUICommands UP

Go one level up.

Field Detail

entry

public final java.lang.String entry

Menu entry.

help

public final java.lang.String help

Help string.

key

public final java.lang.String key

Key shortcut.

Method Detail

checked

public boolean checked()

Returns if this command includes a menu checkbox.

Returns:

result of check

execute

public abstract void execute()

Executes the command.

get

public static GUICommands get(java.lang.String cmd)

Return the command for the specified string.

Parameters:

cmd - command to be checked

Returns:

unique command

refresh

public void refresh(javax.swing.AbstractButton button,
                    boolean sel)

Enables or disables the specified button, depending on the command properties.

Parameters:

button - button to be modified

sel - selection flag

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

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