1 /**
2 * This file Copyright (c) 2014 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.ui.vaadin.extension;
35
36 import info.magnolia.ui.vaadin.gwt.client.extension.ShortcutProtectorState;
37
38 import java.util.List;
39
40 import com.vaadin.server.AbstractClientConnector;
41 import com.vaadin.server.AbstractExtension;
42
43 /**
44 * An extension that prevents keyboard events from propagating out of the extended component.
45 * This is helpful when we want to bypass the usual Vaadin shortcut handling mechanism.
46 */
47 public class ShortcutProtector extends AbstractExtension {
48
49 public ShortcutProtector(AbstractClientConnector target, List<Integer> keys) {
50 super.extend(target);
51 getState().keys = keys;
52 }
53
54 /**
55 * Applies "shortcut protection" to the given component for the given list of key codes.
56 *
57 * @param component the component to apply keyboard shortcut protection to
58 * @param keys a list of {@link com.vaadin.event.ShortcutAction.KeyCode KeyCodes} for which events shouldn't be propagated.
59 */
60 public static void extend(AbstractClientConnector component, List<Integer> keys) {
61 new ShortcutProtector(component, keys);
62 }
63
64 @Override
65 protected ShortcutProtectorState getState() {
66 return (ShortcutProtectorState) super.getState();
67 }
68 }