Package org.basex.gui

Class GUIConstants

java.lang.Object

org.basex.gui.GUIConstants

public final class GUIConstants
extends Object

GUI Constants used in different views. To add a new view, please proceed as follows: All views have unique names, which are defined below. The following steps are necessary to add a new view (the implementation of the existing views might help you):

• define a unique name for your view (e.g. map)
• add a string for your view, as shown below
• add the string in the VIEWS string below
• create your view implementation in a new sub package (e.g. MapView).
• add a new View instance in the GUI constructor.

Add some more code to allow switching on/off your view:

• add a boolean visibility flag with the view name included in the GUIOptions class GUIOptions.SHOWMAP)
• add strings for the menu text.
• optionally add localized translations in the .lang files (e.g. c_showmap and c_showmaptt)
• add a corresponding command in the GUIMenuCmd class (e.g. GUIMenuCmd.C_SHOWMAP)and add a reference in the MENUITEMS menu structure

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GUIConstants.Msg	Icon type.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALT	Alt key.
static final Color	BACK	Background color.
static Font	bfont	Bold Font.
static final Color	BLUE	Color: blue.
static Color	color1	Second bright GUI color.
static Color	color1A	Alpha color.
static Color	color2	Middle color.
static Color	color2A	Transparent background color.
static Color	color3	Middle color.
static Color	color3A	Cursor background color.
static Color	color4	Dark color.
static Color	colormark1	Mark color.
static Color	colormark1A	Mark color, custom alpha value.
static Color	colormark2	Second mark color.
static Color	colormark2A	Second mark color, custom alpha value.
static Color	colormark3	Third mark color.
static Color	colormark4	Fourth mark color.
static final Color	COMMENT	Color: comments.
static final int	CTRL	Control key.
static final Cursor	CURSORARROW	Arrow cursor.
static final Cursor	CURSORHAND	Hand cursor.
static final Cursor	CURSORMOVE	Move cursor.
static final Cursor	CURSORMOVEH	Left/Right arrow cursor.
static final Cursor	CURSORMOVEV	Move cursor.
static final Cursor	CURSORTEXT	Text cursor.
static final Cursor	CURSORWAIT	Wait cursor.
static Color	dgray	Background color.
static final Color	DIGIT	Color: digits.
static Font	dmfont	Default monospace font.
static final String	EDITORVIEW	Internal name of the Editor View.
static final String	EXPLOREVIEW	Internal name of the Explore View.
static final String	FOLDERVIEW	Internal name of the Tree View.
static Font	font	Font.
static int	fontSize	Current font size.
static Color	gray	Button color.
static final Color	GREEN	Color: green.
static final String	INFOVIEW	Internal name of the Info View.
static final Color	KEYWORD	Color: keywords.
static Color	lgray	Cell color.
static final Color	LRED	Color: light red.
static final String	MAPVIEW	Internal name of the Map View.
static final int	META	Shortcut key (CTRL/META).
static Font	mfont	Monospace font.
static Color	mgray	Middle gray color.
static final int	NO_MOD	No modifier.
static final Color	PANEL	Panel color.
static final String	PLOTVIEW	Internal name of the Plot View.
static final GUIMenuCmd[]	POPUP	Context menu entries.
static final Color	RED	Color: red.
static final int	SHIFT	Shift key.
static final String	TABLEVIEW	Internal name of the Table View.
static final Color	TEXT	Text color.
static final String	TEXTVIEW	Internal name of the Text View.
static final String	TREEVIEW	Internal name of the Tree View.
static final Color	VALUE	Color: names.
static final Color	VARIABLE	Color: variables.
static final String	VIEWS	Default GUI Layout.

Method Summary

Modifier and Type	Method	Description
static Color	color(int i)	Returns the specified color from the color gradient.
static int	fontSize()	Returns the standard font size.
static void	init(GUIOptions opts)	Initializes UI settings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MAPVIEW

public static final String MAPVIEW

Internal name of the Map View.

See Also:

• Constant Field Values

FOLDERVIEW

public static final String FOLDERVIEW

Internal name of the Tree View.

See Also:

• Constant Field Values

TEXTVIEW

public static final String TEXTVIEW

Internal name of the Text View.

See Also:

• Constant Field Values

TABLEVIEW

public static final String TABLEVIEW

Internal name of the Table View.

See Also:

• Constant Field Values

INFOVIEW

public static final String INFOVIEW

Internal name of the Info View.

See Also:

• Constant Field Values

EXPLOREVIEW

public static final String EXPLOREVIEW

Internal name of the Explore View.

See Also:

• Constant Field Values

PLOTVIEW

public static final String PLOTVIEW

Internal name of the Plot View.

See Also:

• Constant Field Values

TREEVIEW

public static final String TREEVIEW

Internal name of the Tree View.

See Also:

• Constant Field Values

EDITORVIEW

public static final String EDITORVIEW

Internal name of the Editor View.

See Also:

• Constant Field Values

VIEWS

public static final String VIEWS

Default GUI Layout. The layout is formatted as follows: The character 'H' or 'V' adds a new horizontal or vertical level, and a level is closed again with the '-' character. All views are separated with spaces, and all views must be specified in this layout. This layout is displayed as soon as a database is opened.

See Also:

• Constant Field Values

POPUP

public static final GUIMenuCmd[] POPUP

Context menu entries.

CURSORARROW

public static final Cursor CURSORARROW

Arrow cursor.

CURSORHAND

public static final Cursor CURSORHAND

Hand cursor.

CURSORWAIT

public static final Cursor CURSORWAIT

Wait cursor.

CURSORMOVEH

public static final Cursor CURSORMOVEH

Left/Right arrow cursor.

CURSORMOVEV

public static final Cursor CURSORMOVEV

Move cursor.

CURSORTEXT

public static final Cursor CURSORTEXT

Text cursor.

CURSORMOVE

public static final Cursor CURSORMOVE

Move cursor.

BACK

public static final Color BACK

Background color.

TEXT

public static final Color TEXT

Text color.

PANEL

public static final Color PANEL

Panel color.

RED

public static final Color RED

Color: red.

LRED

public static final Color LRED

Color: light red.

GREEN

public static final Color GREEN

Color: green.

BLUE

public static final Color BLUE

Color: blue.

KEYWORD

public static final Color KEYWORD

Color: keywords.

COMMENT

public static final Color COMMENT

Color: comments.

DIGIT

public static final Color DIGIT

Color: digits.

VARIABLE

public static final Color VARIABLE

Color: variables.

VALUE

public static final Color VALUE

Color: names.

lgray

public static Color lgray

Cell color.

gray

public static Color gray

Button color.

mgray

public static Color mgray

Middle gray color.

dgray

public static Color dgray

Background color.

color1

public static Color color1

Second bright GUI color.

color2

public static Color color2

Middle color.

color3

public static Color color3

Middle color.

color4

public static Color color4

Dark color.

colormark1

public static Color colormark1

Mark color.

colormark2

public static Color colormark2

Second mark color.

colormark3

public static Color colormark3

Third mark color.

colormark4

public static Color colormark4

Fourth mark color.

color1A

public static Color color1A

Alpha color.

color2A

public static Color color2A

Transparent background color.

color3A

public static Color color3A

Cursor background color.

colormark1A

public static Color colormark1A

Mark color, custom alpha value.

colormark2A

public static Color colormark2A

Second mark color, custom alpha value.

font

public static Font font

Font.

bfont

public static Font bfont

Bold Font.

mfont

public static Font mfont

Monospace font.

dmfont

public static Font dmfont

Default monospace font.

fontSize

public static int fontSize

Current font size.

NO_MOD

public static final int NO_MOD

No modifier.

See Also:

• Constant Field Values

SHIFT

public static final int SHIFT

Shift key.

See Also:

• Constant Field Values

ALT

public static final int ALT

Alt key.

See Also:

• Constant Field Values

CTRL

public static final int CTRL

Control key.

See Also:

• Constant Field Values

META

public static final int META

Shortcut key (CTRL/META).

Method Details

init

public static void init(GUIOptions opts)

Initializes UI settings.

Parameters:

opts - gui options

color

public static Color color(int i)

Returns the specified color from the color gradient.

Parameters:

i - color index

Returns:

color

fontSize

public static int fontSize()

Returns the standard font size.

Returns:

font size