001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.ui.components;
029
030import com.vaadin.event.FieldEvents.BlurEvent;
031import com.vaadin.event.FieldEvents.BlurListener;
032import com.vaadin.event.FieldEvents.FocusEvent;
033import com.vaadin.event.FieldEvents.FocusListener;
034import com.vaadin.event.ShortcutListener;
035import com.vaadin.v7.ui.TextField;
036
037/**
038 * Shortcut listener that will only be active, while the given text field has the keyboard focus.<p>
039 */
040public abstract class A_CmsFocusShortcutListener extends ShortcutListener implements BlurListener, FocusListener {
041
042    /** The serial version id. */
043    private static final long serialVersionUID = -4768641299003694650L;
044
045    /** The text field. */
046    private TextField m_field;
047
048    /**
049     * Constructor.<p>
050     *
051     * @see com.vaadin.event.ShortcutAction#ShortcutAction(String, int, int...)
052     */
053    public A_CmsFocusShortcutListener(String caption, int keyCode, int[] modifierKeys) {
054        super(caption, keyCode, modifierKeys);
055    }
056
057    /**
058     * @see com.vaadin.event.FieldEvents.BlurListener#blur(com.vaadin.event.FieldEvents.BlurEvent)
059     */
060    public void blur(BlurEvent event) {
061
062        m_field.removeShortcutListener(this);
063    }
064
065    /**
066     * @see com.vaadin.event.FieldEvents.FocusListener#focus(com.vaadin.event.FieldEvents.FocusEvent)
067     */
068    public void focus(FocusEvent event) {
069
070        m_field.addShortcutListener(this);
071    }
072
073    /**
074     * Install the listener on the given text field
075     *
076     * @param field the txt field
077     */
078    public void installOn(TextField field) {
079
080        m_field = field;
081        m_field.addFocusListener(this);
082        m_field.addBlurListener(this);
083    }
084
085}