info.magnolia.ui.vaadin.extension.ShortcutProtector.java Source code

Introduction

Here is the source code for info.magnolia.ui.vaadin.extension.ShortcutProtector.java

Source

/**
 * This file Copyright (c) 2014-2015 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package info.magnolia.ui.vaadin.extension;

import info.magnolia.ui.vaadin.gwt.client.extension.ShortcutProtectorState;

import java.util.List;

import com.vaadin.server.AbstractClientConnector;
import 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.
 */
public class ShortcutProtector extends AbstractExtension {

    public ShortcutProtector(AbstractClientConnector target, List<Integer> keys) {
        super.extend(target);
        getState().keys = keys;
    }

    /**
     * Applies "shortcut protection" to the given component for the given list of key codes.
     *
     * @param component the component to apply keyboard shortcut protection to
     * @param keys a list of {@link com.vaadin.event.ShortcutAction.KeyCode KeyCodes} for which events shouldn't be propagated.
     */
    public static void extend(AbstractClientConnector component, List<Integer> keys) {
        new ShortcutProtector(component, keys);
    }

    @Override
    protected ShortcutProtectorState getState() {
        return (ShortcutProtectorState) super.getState();
    }
}