com.google.gwt.user.client.ui
Class KeyboardListenerCollection

java.lang.Object
  java.util.AbstractCollection
      java.util.AbstractList
          java.util.Vector
              com.google.gwt.user.client.ui.KeyboardListenerCollection

All Implemented Interfaces:

Cloneable, Collection, List, RandomAccess

public class KeyboardListenerCollection

extends Vector

A helper class for implementers of the SourcesKeyboardEvents interface. This subclass of Vector assumes that all objects added to it will be of type KeyboardListener.

Field Summary

Fields inherited from class java.lang.Object

typeId, typeName

Constructor Summary

KeyboardListenerCollection()

Method Summary

void	fireKeyboardEvent(Widget sender, Event event) Automatically fires the appropriate keyboard event to all listeners.
void	fireKeyDown(Widget sender, char keyCode, int modifiers) Fires a keyDown event to all listeners.
void	fireKeyPress(Widget sender, char key, int modifiers) Fires a keyDown event to all listeners.
void	fireKeyUp(Widget sender, char keyCode, int modifiers) Fires a keyDown event to all listeners.
static int	getKeyboardModifiers(Event event) Gets the keyboard modifiers associated with a DOMEvent.

Methods inherited from class java.util.Vector

add, add, addAll, addAll, addElement, clear, clone, contains, containsAll, copyInto, elementAt, equals, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeRange, retainAll, set, setElementAt, setSize, size, toArray, toString

Methods inherited from class java.util.AbstractList

iterator

Methods inherited from class java.lang.Object

finalize

Methods inherited from interface java.util.List

iterator

Constructor Detail

KeyboardListenerCollection

public KeyboardListenerCollection()

Method Detail

getKeyboardModifiers

public static int getKeyboardModifiers(Event event)

Gets the keyboard modifiers associated with a DOMEvent.

Parameters:

event - the event.

Returns:

the modifiers as defined in KeyboardListener.

fireKeyboardEvent

public void fireKeyboardEvent(Widget sender,
                              Event event)

Automatically fires the appropriate keyboard event to all listeners. If the given event is not a keyboard event, no action will be performed.

Parameters:

sender - the widget sending the event.

event - the Event received by the widget.

fireKeyDown

public void fireKeyDown(Widget sender,
                        char keyCode,
                        int modifiers)

Fires a keyDown event to all listeners.

Parameters:

sender - the widget sending the event.

keyCode - the keyCode to send with the event.

modifiers - the modifier keys pressed at when the event occurred. This value is a combination of the bits defined by KeyboardListener.MODIFIER_SHIFT, KeyboardListener.MODIFIER_CTRL, and KeyboardListener.MODIFIER_ALT.

fireKeyPress

public void fireKeyPress(Widget sender,
                         char key,
                         int modifiers)

Fires a keyDown event to all listeners.

Parameters:

sender - the widget sending the event.

key - the key to send with the event.

modifiers - the modifier keys pressed at when the event occurred. This value is a combination of the bits defined by KeyboardListener.MODIFIER_SHIFT, KeyboardListener.MODIFIER_CTRL, and KeyboardListener.MODIFIER_ALT.

fireKeyUp

public void fireKeyUp(Widget sender,
                      char keyCode,
                      int modifiers)

Fires a keyDown event to all listeners.

Parameters:

sender - the widget sending the event.

keyCode - the keyCode to send with the event.

modifiers - the modifier keys pressed at when the event occurred. This value is a combination of the bits defined by KeyboardListener.MODIFIER_SHIFT, KeyboardListener.MODIFIER_CTRL, and KeyboardListener.MODIFIER_ALT.