org.basex.gui.layout

Enum BaseXKeys

java.lang.Object

java.lang.Enum<BaseXKeys>

org.basex.gui.layout.BaseXKeys

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BaseXKeys>

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

This class offers system-dependent key mappings.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen, Leo Woerteler

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMENT (Un)comment.
CONTEXT Context menu.
COPY1 Copy.
COPY2 Copy.
CUT1 Cut.
CUT2 Cut.
DECFONT Decrease size.
DELLINEEND Delete line to end.
DELLINESTART Delete line to begin.
DELNEXT Delete.
DELNEXTWORD Delete word.
DELPREV Delete backwards.
DELPREVWORD Delete word backwards.
ENTER Enter.
ESCAPE Escape.
EXEC Execute.
FIND Find search term.
FINDNEXT Find next hit.
FINDNEXT2 Find next hit.
FINDPREV Find previous hit.
FINDPREV2 Find previous hit.
GOBACK Browse back.
GOBACK2 Browse back.
GOFORWARD Browse forward.
GOHOME Browse home.
GOUP Browse up.
INCFONT1 Increment size.
INCFONT2 Increment size.
INPUT1 Jump to input bar.
INPUT2 Jump to input bar.
LINEEND End of line.
LINESTART Beginning of line.
NEXT Right.
NEXTLINE Down.
NEXTPAGE Page down.
NEXTTAB Next panel.
NEXTWORD Word right.
NORMFONT Standard size.
PASTE1 Paste.
PASTE2 Paste.
PREV Left.
PREVLINE Up.
PREVPAGE Page up.
PREVTAB Previous panel.
PREVWORD Word left.
REDOSTEP Redo.
SCROLLDOWN Scroll down.
SCROLLUP Scroll up.
SELECTALL Select all.
SPACE Space key.
TAB Tab key.
TEXTEND End of text.
TEXTSTART Beginning of text.
UNDOSTEP Undo.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	control(java.awt.event.KeyEvent e) Returns true if the pressed key includes a control key.
boolean	is(java.awt.event.KeyEvent e) Returns true if the specified key combination was pressed.
static boolean	modifier(java.awt.event.KeyEvent e) Returns true if the pressed key is a modifier key (including 'escape' and 'alt'-'tab').
static boolean	sc(java.awt.event.InputEvent e) Returns true if the system's shortcut key was pressed.
static BaseXKeys	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BaseXKeys[]	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

Enum Constant Detail

PREV

public static final BaseXKeys PREV

Left.

NEXT

public static final BaseXKeys NEXT

Right.

PREVWORD

public static final BaseXKeys PREVWORD

Word left.

NEXTWORD

public static final BaseXKeys NEXTWORD

Word right.

LINESTART

public static final BaseXKeys LINESTART

Beginning of line.

LINEEND

public static final BaseXKeys LINEEND

End of line.

PREVLINE

public static final BaseXKeys PREVLINE

Up.

NEXTLINE

public static final BaseXKeys NEXTLINE

Down.

PREVPAGE

public static final BaseXKeys PREVPAGE

Page up.

NEXTPAGE

public static final BaseXKeys NEXTPAGE

Page down.

TEXTSTART

public static final BaseXKeys TEXTSTART

Beginning of text.

TEXTEND

public static final BaseXKeys TEXTEND

End of text.

SCROLLUP

public static final BaseXKeys SCROLLUP

Scroll up.

SCROLLDOWN

public static final BaseXKeys SCROLLDOWN

Scroll down.

FIND

public static final BaseXKeys FIND

Find search term.

FINDNEXT

public static final BaseXKeys FINDNEXT

Find next hit.

FINDNEXT2

public static final BaseXKeys FINDNEXT2

Find next hit.

FINDPREV

public static final BaseXKeys FINDPREV

Find previous hit.

FINDPREV2

public static final BaseXKeys FINDPREV2

Find previous hit.

UNDOSTEP

public static final BaseXKeys UNDOSTEP

Undo.

REDOSTEP

public static final BaseXKeys REDOSTEP

Redo.

CUT1

public static final BaseXKeys CUT1

Cut.

CUT2

public static final BaseXKeys CUT2

Cut.

COPY1

public static final BaseXKeys COPY1

Copy.

COPY2

public static final BaseXKeys COPY2

Copy.

PASTE1

public static final BaseXKeys PASTE1

Paste.

PASTE2

public static final BaseXKeys PASTE2

Paste.

SELECTALL

public static final BaseXKeys SELECTALL

Select all.

DELPREV

public static final BaseXKeys DELPREV

Delete backwards.

DELNEXT

public static final BaseXKeys DELNEXT

Delete.

DELPREVWORD

public static final BaseXKeys DELPREVWORD

Delete word backwards.

DELNEXTWORD

public static final BaseXKeys DELNEXTWORD

Delete word.

DELLINESTART

public static final BaseXKeys DELLINESTART

Delete line to begin.

DELLINEEND

public static final BaseXKeys DELLINEEND

Delete line to end.

COMMENT

public static final BaseXKeys COMMENT

(Un)comment.

EXEC

public static final BaseXKeys EXEC

Execute.

INPUT1

public static final BaseXKeys INPUT1

Jump to input bar.

INPUT2

public static final BaseXKeys INPUT2

Jump to input bar.

NEXTTAB

public static final BaseXKeys NEXTTAB

Next panel.

PREVTAB

public static final BaseXKeys PREVTAB

Previous panel.

GOBACK

public static final BaseXKeys GOBACK

Browse back.

GOBACK2

public static final BaseXKeys GOBACK2

Browse back.

GOFORWARD

public static final BaseXKeys GOFORWARD

Browse forward.

GOUP

public static final BaseXKeys GOUP

Browse up.

GOHOME

public static final BaseXKeys GOHOME

Browse home.

INCFONT1

public static final BaseXKeys INCFONT1

Increment size.

INCFONT2

public static final BaseXKeys INCFONT2

Increment size.

DECFONT

public static final BaseXKeys DECFONT

Decrease size.

NORMFONT

public static final BaseXKeys NORMFONT

Standard size.

ESCAPE

public static final BaseXKeys ESCAPE

Escape.

CONTEXT

public static final BaseXKeys CONTEXT

Context menu.

SPACE

public static final BaseXKeys SPACE

Space key.

TAB

public static final BaseXKeys TAB

Tab key.

ENTER

public static final BaseXKeys ENTER

Enter.

Method Detail

values

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

Returns:

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

valueOf

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

is

public boolean is(java.awt.event.KeyEvent e)

Returns true if the specified key combination was pressed.

Parameters:

e - key event

Returns:

result of check

sc

public static boolean sc(java.awt.event.InputEvent e)

Returns true if the system's shortcut key was pressed.

Parameters:

e - input event

Returns:

result of check

control

public static boolean control(java.awt.event.KeyEvent e)

Returns true if the pressed key includes a control key.

Parameters:

e - key event

Returns:

result of check

modifier

public static boolean modifier(java.awt.event.KeyEvent e)

Returns true if the pressed key is a modifier key (including 'escape' and 'alt'-'tab').

Parameters:

e - key event

Returns:

result of check