Package org.basex.gui.layout

Enum Class BaseXKeys

java.lang.Object

java.lang.Enum<BaseXKeys>

org.basex.gui.layout.BaseXKeys

All Implemented Interfaces:

Serializable, Comparable<BaseXKeys>, java.lang.constant.Constable

public enum BaseXKeys
extends Enum<BaseXKeys>

This class offers system-dependent key mappings.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen, Leo Woerteler, Klavs Prieditis

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSETAB	Close tab.
COMPLETE	Code completion.
CONTEXT	Context menu.
COPY1	Copy.
COPY2	Copy.
COPYPATH	Copy path.
CUT1	Cut.
CUT2	Cut.
DECFONT	Decrease size.
DELLINEEND	Delete line to end.
DELLINES	Delete complete line.
DELLINESTART	Delete line to begin.
DELNEXT	Delete.
DELNEXTWORD	Delete word.
DELPREV	Delete backwards.
DELPREVWORD	Delete word backwards.
DUPLLINES	Duplicate line(s).
ENTER	Enter.
ESCAPE	Escape.
EXEC1	Execute.
FIND	Find search term.
FINDNEXT1	Find next hit.
FINDNEXT2	Find next hit.
FINDPREV1	Find previous hit.
FINDPREV2	Find previous hit.
FOCUSEDITOR	Jump to editor.
FOCUSINPUT	Jump to input bar.
GOBACK	Browse back.
GOFORWARD	Browse forward.
GOHOME	Browse home.
GOTOLINE	Go to line.
GOUP	Browse up.
INCFONT1	Increment size.
INCFONT2	Increment size.
LINEEND	End of line.
LINESTART	Beginning of line.
MATCHCASE	Match case.
MOVEDOWN	Move line(s) down.
MOVEUP	Move line(s) up.
MULTILINE	Multi-line.
NEWDIR	New directory.
NEXTCHAR	Right.
NEXTLINE	Down.
NEXTPAGE	Page down.
NEXTPAGE_RO	Page down (read-only).
NEXTTAB	Next tab.
NEXTWORD	Word right.
NORMFONT	Standard size.
PASTE1	Paste.
PASTE2	Paste.
PREVCHAR	Left.
PREVLINE	Up.
PREVPAGE	Page up.
PREVPAGE_RO	Page up (read-only).
PREVTAB	Previous tab.
PREVWORD	Word left.
REDOSTEP	Redo.
REFRESH	Refresh.
REGEX	Regular expression.
RENAME	Rename.
SCROLLDOWN	Scroll down.
SCROLLUP	Scroll up.
SELECTALL	Select all.
SHIFT_ENTER	Shift Enter.
SPACE	Space key.
TAB	Tab key.
TEXTEND	End of text.
TEXTSTART	Beginning of text.
UNDOSTEP	Undo.
UNIT	Test.
WHOLEWORD	Whole word.

Method Summary

Modifier and Type	Method	Description
static boolean	control(KeyEvent e)	Returns true if the pressed key includes a control key.
boolean	is(KeyEvent e)	Returns true if the specified key combination was pressed.
static boolean	modifier(KeyEvent e)	Returns true if the pressed key is a modifier key (including 'escape' and 'tab' + control key).
static boolean	sc(InputEvent e)	Returns true if the system's shortcut key was pressed.
String	toString()
static BaseXKeys	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BaseXKeys[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PREVCHAR

public static final BaseXKeys PREVCHAR

Left.

NEXTCHAR

public static final BaseXKeys NEXTCHAR

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.

TAB

public static final BaseXKeys TAB

Tab key.

PREVPAGE_RO

public static final BaseXKeys PREVPAGE_RO

Page up (read-only).

NEXTPAGE_RO

public static final BaseXKeys NEXTPAGE_RO

Page down (read-only).

DELPREV

public static final BaseXKeys DELPREV

Delete backwards.

DELNEXT

public static final BaseXKeys DELNEXT

Delete.

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.

MOVEDOWN

public static final BaseXKeys MOVEDOWN

Move line(s) down.

MOVEUP

public static final BaseXKeys MOVEUP

Move line(s) up.

COMPLETE

public static final BaseXKeys COMPLETE

Code completion.

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.

DELLINES

public static final BaseXKeys DELLINES

Delete complete line.

DUPLLINES

public static final BaseXKeys DUPLLINES

Duplicate line(s).

FOCUSINPUT

public static final BaseXKeys FOCUSINPUT

Jump to input bar.

FOCUSEDITOR

public static final BaseXKeys FOCUSEDITOR

Jump to editor.

NEXTTAB

public static final BaseXKeys NEXTTAB

Next tab.

PREVTAB

public static final BaseXKeys PREVTAB

Previous tab.

CLOSETAB

public static final BaseXKeys CLOSETAB

Close tab.

GOBACK

public static final BaseXKeys GOBACK

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.

GOTOLINE

public static final BaseXKeys GOTOLINE

Go to line.

FIND

public static final BaseXKeys FIND

Find search term.

FINDNEXT1

public static final BaseXKeys FINDNEXT1

Find next hit.

FINDNEXT2

public static final BaseXKeys FINDNEXT2

Find next hit.

FINDPREV1

public static final BaseXKeys FINDPREV1

Find previous hit.

FINDPREV2

public static final BaseXKeys FINDPREV2

Find previous hit.

MATCHCASE

public static final BaseXKeys MATCHCASE

Match case.

WHOLEWORD

public static final BaseXKeys WHOLEWORD

Whole word.

REGEX

public static final BaseXKeys REGEX

Regular expression.

MULTILINE

public static final BaseXKeys MULTILINE

Multi-line.

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.

EXEC1

public static final BaseXKeys EXEC1

Execute.

UNIT

public static final BaseXKeys UNIT

Test.

ESCAPE

public static final BaseXKeys ESCAPE

Escape.

CONTEXT

public static final BaseXKeys CONTEXT

Context menu.

COPYPATH

public static final BaseXKeys COPYPATH

Copy path.

REFRESH

public static final BaseXKeys REFRESH

Refresh.

RENAME

public static final BaseXKeys RENAME

Rename.

NEWDIR

public static final BaseXKeys NEWDIR

New directory.

SPACE

public static final BaseXKeys SPACE

Space key.

ENTER

public static final BaseXKeys ENTER

Enter.

SHIFT_ENTER

public static final BaseXKeys SHIFT_ENTER

Shift Enter.

Method Details

values

public static BaseXKeys[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static BaseXKeys valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

is

public boolean is(KeyEvent e)

Returns true if the specified key combination was pressed.

Parameters:

e - key event

Returns:

result of check

sc

public static boolean sc(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(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(KeyEvent e)

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

Parameters:

e - key event

Returns:

result of check

toString

public String toString()

Overrides:

toString in class Enum<BaseXKeys>