org.xwiki.gwt.user.client
Class ShortcutKeyManager

java.lang.Object
  extended by java.util.AbstractMap<K,V>
      extended by java.util.HashMap<ShortcutKey,ShortcutKeyCommand>
          extended by org.xwiki.gwt.user.client.ShortcutKeyManager
All Implemented Interfaces:
com.google.gwt.event.dom.client.KeyDownHandler, com.google.gwt.event.dom.client.KeyPressHandler, com.google.gwt.event.dom.client.KeyUpHandler, com.google.gwt.event.shared.EventHandler, Serializable, Cloneable, Map<ShortcutKey,ShortcutKeyCommand>

public class ShortcutKeyManager
extends HashMap<ShortcutKey,ShortcutKeyCommand>
implements com.google.gwt.event.dom.client.KeyDownHandler, com.google.gwt.event.dom.client.KeyPressHandler, com.google.gwt.event.dom.client.KeyUpHandler

Associates ShortcutKeyCommands to shortcut keys.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
 
Constructor Summary
ShortcutKeyManager()
           
 
Method Summary
 List<com.google.gwt.event.shared.HandlerRegistration> addHandlers(com.google.gwt.event.dom.client.HasAllKeyHandlers source)
          Adds the necessary key handlers to be able to catch shortcut keys.
static EnumSet<ShortcutKey.ModifierKey> getModifiers(com.google.gwt.event.dom.client.KeyDownEvent event)
           
 void onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent event)
           
 void onKeyPress(com.google.gwt.event.dom.client.KeyPressEvent event)
           
 void onKeyUp(com.google.gwt.event.dom.client.KeyUpEvent event)
           
 
Methods inherited from class java.util.HashMap
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class java.util.AbstractMap
equals, hashCode, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Constructor Detail

ShortcutKeyManager

public ShortcutKeyManager()
Method Detail

addHandlers

public List<com.google.gwt.event.shared.HandlerRegistration> addHandlers(com.google.gwt.event.dom.client.HasAllKeyHandlers source)
Adds the necessary key handlers to be able to catch shortcut keys.

Parameters:
source - an object that fires keyboard events
Returns:
a list of handler registrations that can be used to remove the added key handlers

onKeyDown

public void onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent event)
Specified by:
onKeyDown in interface com.google.gwt.event.dom.client.KeyDownHandler

onKeyPress

public void onKeyPress(com.google.gwt.event.dom.client.KeyPressEvent event)
Specified by:
onKeyPress in interface com.google.gwt.event.dom.client.KeyPressHandler

onKeyUp

public void onKeyUp(com.google.gwt.event.dom.client.KeyUpEvent event)
Specified by:
onKeyUp in interface com.google.gwt.event.dom.client.KeyUpHandler

getModifiers

public static EnumSet<ShortcutKey.ModifierKey> getModifiers(com.google.gwt.event.dom.client.KeyDownEvent event)
Parameters:
event - a key down event
Returns:
the set of modifier keys pressed when the event was triggered