info.magnolia.ui.vaadin.extension

Class ShortcutProtector

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

info.magnolia.ui.vaadin.extension.ShortcutProtector

All Implemented Interfaces:

com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Extension, com.vaadin.shared.Connector, Serializable

public class ShortcutProtector
extends com.vaadin.server.AbstractExtension

An extension that prevents keyboard events from propagating out of the extended component. This is helpful when we want to bypass the usual Vaadin shortcut handling mechanism.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Constructor Summary

Constructors

Constructor and Description
ShortcutProtector(com.vaadin.server.AbstractClientConnector target, List<Integer> keys)

Method Summary

Modifier and Type	Method and Description
static void	extend(com.vaadin.server.AbstractClientConnector component, List<Integer> keys) Applies "shortcut protection" to the given component for the given list of key codes.
protected ShortcutProtectorState	getState()

Methods inherited from class com.vaadin.server.AbstractExtension

extend, getParent, getSupportedParentType, remove, setParent

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, attach, beforeClientResponse, createState, detach, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getState, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isConnectorEnabled, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, attach, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, getUI, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Detail

ShortcutProtector

public ShortcutProtector(com.vaadin.server.AbstractClientConnector target,
                         List<Integer> keys)

Method Detail

extend

public static void extend(com.vaadin.server.AbstractClientConnector component,
                          List<Integer> keys)

Applies "shortcut protection" to the given component for the given list of key codes.

Parameters:

component - the component to apply keyboard shortcut protection to

keys - a list of KeyCodes for which events shouldn't be propagated.

getState

protected ShortcutProtectorState getState()

Overrides:

getState in class com.vaadin.server.AbstractClientConnector