com.vaadin.event.

Class ShortcutAction

java.lang.Object
  com.vaadin.event.Action
      com.vaadin.event.ShortcutAction

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ShortcutListener

extends Action

Shortcuts are a special type of Actions used to create keyboard shortcuts.

The ShortcutAction is triggered when the user presses a given key in combination with the (optional) given modifier keys.

ShortcutActions can be global (by attaching to the Window), or attached to different parts of the UI so that a specific shortcut is only valid in part of the UI. For instance, one can attach shortcuts to a specific Panel - look for ComponentContainers implementing Action.Handler or Action.Notifier.

ShortcutActions have a caption that may be used to display the shortcut visually. This allows the ShortcutAction to be used as a plain Action while still reacting to a keyboard shortcut. Note that this functionality is not very well supported yet, but it might still be a good idea to give a caption to the shortcut.

Since:

4.0.1

Version:

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary
`static interface`	`ShortcutAction.KeyCode` Key codes that can be used for shortcuts
`static interface`	`ShortcutAction.ModifierKey` Modifier key constants

Nested classes/interfaces inherited from class com.vaadin.event.Action
`Action.Container, Action.Handler, Action.Listener, Action.Notifier, Action.ShortcutNotifier`

Field Summary
`static char`	`SHORTHAND_CHAR_ALT` Used in the caption shorthand notation to indicate the ALT modifier.
`static char`	`SHORTHAND_CHAR_CTRL` Used in the caption shorthand notation to indicate the CTRL modifier.
`static char`	`SHORTHAND_CHAR_SHIFT` Used in the caption shorthand notation to indicate the SHIFT modifier.

Constructor Summary
`ShortcutAction(String shorthandCaption)` Constructs a ShortcutAction using a shorthand notation to encode the keycode and modifiers in the caption.
`ShortcutAction(String shorthandCaption, int[] modifierKeys)` Constructs a ShortcutAction using a shorthand notation to encode the keycode a in the caption.
`ShortcutAction(String caption, int kc, int[] m)` Creates a shortcut that reacts to the given `ShortcutAction.KeyCode` and (optionally) `ShortcutAction.ModifierKey`s.
`ShortcutAction(String caption, Resource icon, int kc, int[] m)` Creates a shortcut that reacts to the given `ShortcutAction.KeyCode` and (optionally) `ShortcutAction.ModifierKey`s.

Method Summary
`int`	`getKeyCode()` Get the `ShortcutAction.KeyCode` that this shortcut reacts to (in combination with the `ShortcutAction.ModifierKey`s).
`int[]`	`getModifiers()` Get the `ShortcutAction.ModifierKey`s required for the shortcut to react.

Methods inherited from class com.vaadin.event.Action
`getCaption, getIcon, setCaption, setIcon`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

SHORTHAND_CHAR_ALT

public static final char SHORTHAND_CHAR_ALT

Used in the caption shorthand notation to indicate the ALT modifier.

See Also:: Constant Field Values

SHORTHAND_CHAR_SHIFT

public static final char SHORTHAND_CHAR_SHIFT

Used in the caption shorthand notation to indicate the SHIFT modifier.

See Also:: Constant Field Values

SHORTHAND_CHAR_CTRL

public static final char SHORTHAND_CHAR_CTRL

Used in the caption shorthand notation to indicate the CTRL modifier.

See Also:: Constant Field Values

Constructor Detail

ShortcutAction

public ShortcutAction(String caption,
                      int kc,
                      int[] m)

Creates a shortcut that reacts to the given ShortcutAction.KeyCode and (optionally) ShortcutAction.ModifierKeys.
The shortcut might be shown in the UI (e.g context menu), in which case the caption will be used.

Parameters:: caption - used when displaying the shortcut visually; kc - KeyCode that the shortcut reacts to; m - optional modifier keys

ShortcutAction

public ShortcutAction(String caption,
                      Resource icon,
                      int kc,
                      int[] m)

Parameters:: caption - used when displaying the shortcut visually; icon - used when displaying the shortcut visually; kc - KeyCode that the shortcut reacts to; m - optional modifier keys

ShortcutAction

public ShortcutAction(String shorthandCaption)

Constructs a ShortcutAction using a shorthand notation to encode the keycode and modifiers in the caption.

Insert one or more modifier characters before the character to use as keycode. E.g "&Save" will make a shortcut responding to ALT-S, "E^xit" will respond to CTRL-X.
Multiple modifiers can be used, e.g "&^Delete" will respond to CTRL-ALT-D (the order of the modifier characters is not important).

The modifier characters will be removed from the caption. The modifier character is be escaped by itself: two consecutive characters are turned into the original character w/o the special meaning. E.g "Save&&&close" will respond to ALT-C, and the caption will say "Save&close".

Parameters:: shorthandCaption - the caption in modifier shorthand

ShortcutAction

public ShortcutAction(String shorthandCaption,
                      int[] modifierKeys)

Constructs a ShortcutAction using a shorthand notation to encode the keycode a in the caption.

This works the same way as ShortcutAction(String), with the exception that the modifiers given override those indicated in the caption. I.e use any of the modifier characters in the caption to indicate the keycode, but the modifier will be the given set.
E.g new ShortcutAction("Do &stuff", new int[]{ShortcutAction.ModifierKey.CTRL})); will respond to CTRL-S.

Parameters:: shorthandCaption -; 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