org.vishia.util

Class KeyCode

java.lang.Object

org.vishia.util.KeyCode

public class KeyCode
extends java.lang.Object

This class helps to present key codes and other events in combination with shift, alt, control in a maybe readable form. It defines unique integer representations for all keys and events. The key code consist of 2 blocks, which are able to read in hexa view:

• The lower 16 bit usual are the character code of the key, whereby typically only 8 bit are used if the key is presented by a ASCII-code. It may be the number of a special key too. The key code pressed on keyboard depends on the language-specific keyboard layout.
• The middle bits 19..16 respectively the middle hex digit is set to a b e f, see mSpecialKeys.
• The higher 12 bit, 3 hex digits are set with hexa-readable digits 5, c, a and f whereby 5 means 'S' for shift. See the codings alt, ctrl, shift and #F,

Mouse button
The mouse buttons are coded here too. Concept:

• The left, right and middle button is designated as 'first', 'second' because a mouse may be set to left hand mode. Then the left button is the 'second'. The middle button may be supported or not. Depending on driver, hardware it is designated as third button.
• The code contains the hex digit 'b' in bits 19..16 and a character 'D', 'U', 'C' for 'up', 'down' and 'doubleClick' of the first button (right hand mouse: the left button). Furthermore 'd', 'u' and 'c' for the other button and '3' and '4' for the third button up and down.
• A pressed alt, control and/or shift key is presented in the bits 31..20

Selection events
The class defines constants which are used to determine which cause calls a user method.

Field Summary

Fields

Modifier and Type	Field and Description
static int	activated Key code for anything activated.
static int	alphanum Alpha-numeric keys in mSpecialKeys.
static int	alt
static int	altDigit
static int	back
int	code
static int	ctrl
static int	ctrlAlt Use the 7.6. digit looks line "ca" for "control alt".
static int	ctrlDigit
static int	defaultSelect Determines that a line of a table is selected per default.
static int	del
static int	dn
static int	dragFiles
static int	dragText
static int	dropFiles
static int	dropText
static int	end
static int	enter
static int	Entered Determines that a menu item is entered.
static int	esc
static int	F1
static int	F10
static int	F11
static int	F12
static int	F2
static int	F3
static int	F4
static int	F5
static int	F6
static int	F7
static int	F8
static int	F9
static int	focusGained Determines that a field has got a focus.
static int	focusLost
static int	function Function keys in mSpecialKeys.
static int	functionDigit
static int	home
static int	ins
static int	left
static int	mAddKeys Mask for the additional ctrl, alt and shift key.
static int	mCtrlAlt Any of control or alt is pressed.
static int	mCtrlAltDigit
static int	menuEntered Determines that a menu item is entered.
static int	mouse1Double Doubleclick on mouse button.
static int	mouse1Down
static int	mouse1Up
static int	mouse1UpMoved The mouse button is released, but at another position where pressed.
static int	mouse2Double
static int	mouse2Down The mouse button 2 is usual the right button.
static int	mouse2Up
static int	mouse2UpMoved The mouse button is released, but at another position where pressed.
static int	mouse3Down The mouse button 3 is usual the middle button.
static int	mouse3Up
static int	mouseBothDown Both mouse buttons left and right are pressed down.
static int	mouseWheelDn
static int	mouseWheelUp
static int	mSpecialKeyDigit
static int	mSpecialKeys Bits to designate special keys.
static int	nonAlphanum Non-alpha-numeric keys in mSpecialKeys.
static int	pgdn
static int	pgup
static int	removed Key code for anything removed.
static int	right
static int	shift Use the 8. digit looks line "S" for "shift", value "5".
static int	shiftAlt
static int	shiftCtrl
static int	shiftCtrlAlt
static int	shiftDigit
java.lang.String	str
static java.lang.String	sVersion The version 2013-11-23 Hartmut new: Masks for shiftDigit etc, Definition of tab 2013-11-23 Hartmut chg: userSelect and defaultSelect instead tableLineSelect 2012-07-15 Hartmut new: isAsciiTextKey(int) 2012-06-17 new isControlFunctionMouseUpOrMenu(int) etc. cluster of keys and actions.
static int	tab
static int	undefined
static int	up
static int	userSelect Determines that a line of a table is selected by user actions.
static int	valueChanged A textfields content is changed.

Constructor Summary

Constructors

Constructor and Description
KeyCode(int code)
KeyCode(java.lang.String src)

Method Summary

Modifier and Type	Method and Description
static int	convert(java.lang.String src)
static boolean	isAsciiTextKey(int key) Any key between the codes 0x20 .. 0x7e, it is an ASCII text key.
static boolean	isControlFunctionMouseUpOrMenu(int key) Returns true if it is a control, function or graphical control key.
static boolean	isControlOrFunction(int key) returns true if it is a control or function key.
static boolean	isTextKey(int key) Any text key, in UTF16 range but not a ASCII control key (0x0 .. 0x1f)
static boolean	isWritingKey(int key) A key which is used in an text field to write something.
static boolean	isWritingOrTextNavigationKey(int key)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

sVersion

public static final java.lang.String sVersion

The version

• 2013-11-23 Hartmut new: Masks for shiftDigit etc, Definition of tab
• 2013-11-23 Hartmut chg: userSelect and defaultSelect instead tableLineSelect
• 2012-07-15 Hartmut new: isAsciiTextKey(int)
• 2012-06-17 new isControlFunctionMouseUpOrMenu(int) etc. cluster of keys and actions.
• 2011-11-18 new mouse1UpMoved
• 2011-09-30 improved

See Also:

Constant Field Values

altDigit

public static final int altDigit

See Also:

Constant Field Values

alt

public static final int alt

See Also:

Constant Field Values

ctrlDigit

public static final int ctrlDigit

See Also:

Constant Field Values

ctrl

public static final int ctrl

See Also:

Constant Field Values

shiftDigit

public static final int shiftDigit

See Also:

Constant Field Values

shift

public static final int shift

Use the 8. digit looks line "S" for "shift", value "5".

See Also:

Constant Field Values

ctrlAlt

public static final int ctrlAlt

Use the 7.6. digit looks line "ca" for "control alt".

See Also:

Constant Field Values

shiftAlt

public static final int shiftAlt

See Also:

Constant Field Values

shiftCtrl

public static final int shiftCtrl

See Also:

Constant Field Values

shiftCtrlAlt

public static final int shiftCtrlAlt

See Also:

Constant Field Values

mSpecialKeys

public static final int mSpecialKeys

Bits to designate special keys.

• a: arrow
• b: mouse button, menu
• d: drag and drop
• e: enter, esc etc.
• f: function key #F
• Use letter, not digits to recognize it well.
• Don't use a, e, 5 to distinguish with the alt, control, shift

See Also:

Constant Field Values

mSpecialKeyDigit

public static final int mSpecialKeyDigit

See Also:

Constant Field Values

mAddKeys

public static final int mAddKeys

Mask for the additional ctrl, alt and shift key. If a key code is mask with them, it can be compared with #alt, #ctrl. #shift, #ctrlAlt, #shiftAlt, shiftCtrl, shiftCtrlAlt.

See Also:

Constant Field Values

mCtrlAlt

public static final int mCtrlAlt

Any of control or alt is pressed.

See Also:

Constant Field Values

mCtrlAltDigit

public static final int mCtrlAltDigit

See Also:

Constant Field Values

function

public static final int function

Function keys in mSpecialKeys.

See Also:

Constant Field Values

functionDigit

public static final int functionDigit

See Also:

Constant Field Values

nonAlphanum

public static final int nonAlphanum

Non-alpha-numeric keys in mSpecialKeys.

See Also:

Constant Field Values

alphanum

public static final int alphanum

Alpha-numeric keys in mSpecialKeys.

See Also:

Constant Field Values

F1

public static final int F1

See Also:

Constant Field Values

F2

public static final int F2

See Also:

Constant Field Values

F3

public static final int F3

See Also:

Constant Field Values

F4

public static final int F4

See Also:

Constant Field Values

F5

public static final int F5

See Also:

Constant Field Values

F6

public static final int F6

See Also:

Constant Field Values

F7

public static final int F7

See Also:

Constant Field Values

F8

public static final int F8

See Also:

Constant Field Values

F9

public static final int F9

See Also:

Constant Field Values

F10

public static final int F10

See Also:

Constant Field Values

F11

public static final int F11

See Also:

Constant Field Values

F12

public static final int F12

See Also:

Constant Field Values

left

public static final int left

See Also:

Constant Field Values

right

public static final int right

See Also:

Constant Field Values

up

public static final int up

See Also:

Constant Field Values

dn

public static final int dn

See Also:

Constant Field Values

pgup

public static final int pgup

See Also:

Constant Field Values

pgdn

public static final int pgdn

See Also:

Constant Field Values

home

public static final int home

See Also:

Constant Field Values

end

public static final int end

See Also:

Constant Field Values

back

public static final int back

See Also:

Constant Field Values

enter

public static final int enter

See Also:

Constant Field Values

ins

public static final int ins

See Also:

Constant Field Values

del

public static final int del

See Also:

Constant Field Values

esc

public static final int esc

See Also:

Constant Field Values

tab

public static final int tab

See Also:

Constant Field Values

mouse1Down

public static final int mouse1Down

See Also:

Constant Field Values

mouse1Up

public static final int mouse1Up

See Also:

Constant Field Values

mouse1UpMoved

public static final int mouse1UpMoved

The mouse button is released, but at another position where pressed.

See Also:

Constant Field Values

mouse1Double

public static final int mouse1Double

Doubleclick on mouse button.

See Also:

Constant Field Values

mouse2Down

public static final int mouse2Down

The mouse button 2 is usual the right button.

See Also:

Constant Field Values

mouse2Up

public static final int mouse2Up

See Also:

Constant Field Values

mouse2UpMoved

public static final int mouse2UpMoved

The mouse button is released, but at another position where pressed.

See Also:

Constant Field Values

mouse2Double

public static final int mouse2Double

See Also:

Constant Field Values

mouseBothDown

public static final int mouseBothDown

Both mouse buttons left and right are pressed down.

See Also:

Constant Field Values

mouseWheelUp

public static final int mouseWheelUp

See Also:

Constant Field Values

mouseWheelDn

public static final int mouseWheelDn

See Also:

Constant Field Values

mouse3Down

public static final int mouse3Down

The mouse button 3 is usual the middle button.

See Also:

Constant Field Values

mouse3Up

public static final int mouse3Up

See Also:

Constant Field Values

menuEntered

public static final int menuEntered

Determines that a menu item is entered.

See Also:

Constant Field Values

Entered

public static final int Entered

Determines that a menu item is entered.

See Also:

Constant Field Values

userSelect

public static final int userSelect

Determines that a line of a table is selected by user actions.

See Also:

Constant Field Values

defaultSelect

public static final int defaultSelect

Determines that a line of a table is selected per default.

See Also:

Constant Field Values

focusGained

public static final int focusGained

Determines that a field has got a focus.

See Also:

Constant Field Values

focusLost

public static final int focusLost

See Also:

Constant Field Values

valueChanged

public static final int valueChanged

A textfields content is changed.

See Also:

Constant Field Values

activated

public static final int activated

Key code for anything activated.

See Also:

Constant Field Values

removed

public static final int removed

Key code for anything removed.

See Also:

Constant Field Values

dropFiles

public static final int dropFiles

See Also:

Constant Field Values

dropText

public static final int dropText

See Also:

Constant Field Values

dragFiles

public static final int dragFiles

See Also:

Constant Field Values

dragText

public static final int dragText

See Also:

Constant Field Values

undefined

public static final int undefined

See Also:

Constant Field Values

code

public final int code

str

public final java.lang.String str

Constructor Detail

KeyCode

public KeyCode(java.lang.String src)

KeyCode

public KeyCode(int code)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

convert

public static int convert(java.lang.String src)

isWritingKey

public static boolean isWritingKey(int key)

A key which is used in an text field to write something. It includes the del key.

Parameters:

key -

Returns:

isAsciiTextKey

public static boolean isAsciiTextKey(int key)

Any key between the codes 0x20 .. 0x7e, it is an ASCII text key.

Parameters:

key -

Returns:

isTextKey

public static boolean isTextKey(int key)

Any text key, in UTF16 range but not a ASCII control key (0x0 .. 0x1f)

Parameters:

key -

Returns:

isControlOrFunction

public static boolean isControlOrFunction(int key)

returns true if it is a control or function key. Either function or ctrl combination. A control key controls actions of the user. The original control keys in the 1960-80 age were associated with the control key button. On PCs the function keys enhances this concept. Usual keys with ctrl-button and all function keys maybe in combination with ctrl, shift, alt are used for user-control of an application via keyboard. This combinations returns true.
A alphanumeric key only in combination with alt is not a control key. It is intended for menu actions.

Parameters:

key -

Returns:

isControlFunctionMouseUpOrMenu

public static boolean isControlFunctionMouseUpOrMenu(int key)

Returns true if it is a control, function or graphical control key. It supports the typical situation for an action which should be invoked by a control or function key from the keyboard or only on mouse-up in any widget, or from an menu click. Usual a graphical button should act on mouse-up, not on mouse-down. That is because on touch screen a mouse down shows maybe a fault position or fault button activation. If the cursor will be move away, the button is not activated.

Parameters:

key -

Returns:

isWritingOrTextNavigationKey

public static boolean isWritingOrTextNavigationKey(int key)