goog.ui.KeyboardShortcutHandler

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched.

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added. If a callback is added to an already disposed Disposable, it will be called immediately.

Removes the listener that was added by link #initializeKeyListener.

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object.

If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

Disposes of the object and its resources.

Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.

Fires all registered listeners in this listenable for the given type and capture mode, passing them the given eventObject. This does not perform actual capture/bubble. Only implementors of the interface should be using this.

Returns whether all shortcuts (including modifier shortcuts) are treated as if the keys had been passed to the setGlobalKeys function.

Returns whether the default action will always be prevented when a shortcut event is fired. The default value is true.

Returns whether the event will always be stopped from propagating beyond its target when a shortcut event is fired. The default value is false.

Returns event type for a specific shortcut.

Gets the goog.events.ListenableKey for the event or null if no such listener is in use.

Gets all listeners in this listenable for the given type and capture mode.

Returns whether shortcuts with modifiers are treated as if the keys had been passed to the setGlobalKeys function. Ignored if you have called setAllShortcutsAreGlobal(true). Applies only to form elements (not content-editable).

Returns the parent of this event target to use for capture/bubble mechanism.

NOTE(chrishenry): The name reflects the original implementation of custom event target (goog.events.EventTarget). We decided that changing the name is not worth it.

Whether there is any active listeners matching the specified signature. If either the type or capture parameters are unspecified, the function will match on the remaining criteria.

Adds a key event listener that triggers #handleKeyDown_ when keys are pressed.

Verifies if a particular keyboard shortcut is registered already. It has the same interface as the unregistering of shortcuts.

param {number} keyCode Numeric code for key param {number=} opt_modifiers Bitmap indicating required modifier keys. goog.ui.KeyboardShortcutHandler.Modifiers.SHIFT, CTRL, ALT, or META.

The two parameters can be repeated any number of times to create a shortcut using a sequence of strokes.

A string representation of the shortcut can be supplied instead see #registerShortcut for syntax. In that case the method only takes one argument.

Adds an event listener. A listener can only be added once to an object and if it is added again the key for the listener is returned. Note that if the existing listener is a one-off listener (registered via listenOnce), it will no longer be a one-off listener after a call to listen().

Adds an event listener that is removed automatically after the listener fired once.

If an existing listener already exists, listenOnce will do nothing. In particular, if the listener was previously registered via listen(), listenOnce() will not turn the listener into a one-off listener. Similarly, if there is already an existing one-off listener, listenOnce does not modify the listeners (it is still a once listener).

Associates a disposable object with this object so that they will be disposed together.

Registers a keyboard shortcut.

Removes all listeners from this listenable. If type is specified, it will only remove listeners of the particular type. otherwise all registered listeners will be removed.

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

Sets whether to treat all shortcuts (including modifier shortcuts) as if the keys had been passed to the setGlobalKeys function.

Sets whether to treat space key as a shortcut when the focused element is a checkbox, radiobutton or button.

Sets whether to always prevent the default action when a shortcut event is fired. If false, the default action is prevented only if preventDefault is called on either of the corresponding SHORTCUT_TRIGGERED or SHORTCUT_PREFIX events. If true, the default action is prevented whenever a shortcut event is fired. The default value is true.

Sets whether to always stop propagation for the event when fired. If false, the propagation is stopped only if stopPropagation is called on either of the corresponding SHORT_CUT_TRIGGERED or SHORTCUT_PREFIX events. If true, the event is prevented from propagating beyond its target whenever it is fired. The default value is false.

Sets the global keys; keys that are safe to always regarded as shortcuts, even if entered in a textarea or input field.

Sets whether to treat shortcuts with modifiers as if the keys had been passed to the setGlobalKeys function. Ignored if you have called setAllShortcutsAreGlobal(true). Applies only to form elements (not content-editable).

Sets the parent of this event target to use for capture/bubble mechanism.

Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.

Removes an event listener which was added with listen() or listenOnce().

Removes an event listener which was added with listen() by the key returned by listen().

Unregisters all keyboard shortcuts.

Unregisters a keyboard shortcut by keyCode and modifiers or string representation of sequence.

param {number} keyCode Numeric code for key param {number=} opt_modifiers Bitmap indicating required modifier keys. goog.ui.KeyboardShortcutHandler.Modifiers.SHIFT, CTRL, ALT, or META.

The two parameters can be repeated any number of times to create a shortcut using a sequence of strokes.

A string representation of the shortcut can be supplied instead see #registerShortcut for syntax. In that case the method only takes one argument.

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

Static method for getting the key code for a given key.

Builds stroke array from string representation of shortcut.

Maximum allowed delay, in milliseconds, allowed between the first and second key in a key sequence.