com.xdev.ui.action

Class Shortcut

java.lang.Object

com.xdev.ui.action.Shortcut

All Implemented Interfaces:

ShortcutAction.KeyCode, ShortcutAction.ModifierKey, Serializable

public class Shortcut
extends Object
implements ShortcutAction.KeyCode, ShortcutAction.ModifierKey

Holds information for a keyboard shortcut which is associated with an Action.

It consists of a keyCode and modifiers, e.g. ShortcutAction.KeyCode.S and ShortcutAction.ModifierKey.CTRL.

Author:

XDEV Software

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.vaadin.event.ShortcutAction.KeyCode

A, ARROW_DOWN, ARROW_LEFT, ARROW_RIGHT, ARROW_UP, B, BACKSPACE, C, D, DELETE, E, END, ENTER, ESCAPE, F, F1, F10, F11, F12, F2, F3, F4, F5, F6, F7, F8, F9, G, H, HOME, I, INSERT, J, K, L, M, N, NUM0, NUM1, NUM2, NUM3, NUM4, NUM5, NUM6, NUM7, NUM8, NUM9, O, P, PAGE_DOWN, PAGE_UP, Q, R, S, SPACEBAR, T, TAB, U, V, W, X, Y, Z

Fields inherited from interface com.vaadin.event.ShortcutAction.ModifierKey

ALT, CTRL, META, SHIFT

Constructor Summary

Constructors

Constructor and Description
Shortcut(int keyCode, int... modifiers) Creates a shortcut object with the given key code and optional modifiers.

Method Summary

Modifier and Type	Method and Description
int	getKeyCode() Get the ShortcutAction.KeyCode that this shortcut reacts to (in combination with the ShortcutAction.ModifierKeys).
int[]	getModifiers() Get the ShortcutAction.ModifierKeys required for the shortcut to react.

Methods inherited from class java.lang.Object

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

Constructor Detail

Shortcut

public Shortcut(int keyCode,
                int... modifiers)

Creates a shortcut object with the given key code and optional modifiers.

Parameters:

keyCode - ShortcutAction.KeyCode that the shortcut reacts to

modifiers - optional ShortcutAction.ModifierKeys

Method Detail

getKeyCode

public int getKeyCode()

Get the ShortcutAction.KeyCode that this shortcut reacts to (in combination with the ShortcutAction.ModifierKeys).

Returns:

keycode for this shortcut

getModifiers

public int[] getModifiers()

Get the ShortcutAction.ModifierKeys required for the shortcut to react.

Returns:

modifier keys for this shortcut