org.jowidgets.common.widgets.controller

Interface IKeyEvent

public interface IKeyEvent

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Character	getCharacter() Gets the character representation of the typed key if the key is representable by an character.
java.util.Set<Modifier>	getModifier() Gets the modifiers of the key event as an unmodifiable set
java.lang.Character	getResultingCharacter() Gets the character representation of the typed key after all modifiers have been applied.
VirtualKey	getVirtualKey() Gets the virtual key that was typed.

Method Detail

getVirtualKey

VirtualKey getVirtualKey()

Gets the virtual key that was typed. If the typed key is not defined in the virtual key enumeration, VirtualKey.UNKOWN will be returned.

Returns:

The virtual key of the event, may be VirtualKey.UNKNOWN

getCharacter

java.lang.Character getCharacter()

Gets the character representation of the typed key if the key is representable by an character. Remark: Modifiers have not applied on this character. i.e.: On a German Keyboard 'SHIFT + 1' will return '1' and not '!'. To get the resulting Character use the method 'IKeyEvent#getResultingCharacter()'.

Returns:

The character representation or null, if the key has no character representation.

See Also:

getResultingCharacter()

getResultingCharacter

java.lang.Character getResultingCharacter()

Gets the character representation of the typed key after all modifiers have been applied. Remark: Modifiers have applied on this character. i.e.: On a German Keyboard 'SHIFT + 1' will return '!' and not '1'. To get the character representation of the typed key use the method 'IKeyEvent#getCharacter()'.

Returns:

The character representation or null, if the key has no character representation.

See Also:

getCharacter()

getModifier

java.util.Set<Modifier> getModifier()

Gets the modifiers of the key event as an unmodifiable set

Returns:

The set of the applied modifiers. May be empty but is never null