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.Action;
031import com.vaadin.event.Action.Handler;
032import com.vaadin.event.ShortcutAction;
033
034/**
035 * Shortcut handler triggered on 'Enter' and 'Esc' to trigger OK and Cancel actions.<p>
036 */
037public abstract class CmsOkCancelActionHandler implements Handler {
038
039    /** The serial version id. */
040    private static final long serialVersionUID = 6114433920380720290L;
041
042    /** The enter action. */
043    protected static final ShortcutAction ENTER_ACTION = new ShortcutAction(
044        "Enter",
045        ShortcutAction.KeyCode.ENTER,
046        null);
047
048    /** The escape action. */
049    protected static final ShortcutAction ESC_ACTION = new ShortcutAction(
050        "Escape",
051        ShortcutAction.KeyCode.ESCAPE,
052        null);
053
054    /** The shortcut actions. */
055    private static final ShortcutAction[] SHORTCUT_ACTIONS = new ShortcutAction[] {ENTER_ACTION, ESC_ACTION};
056
057    /**
058     * @see com.vaadin.event.Action.Handler#getActions(java.lang.Object, java.lang.Object)
059     */
060    public Action[] getActions(Object target, Object sender) {
061
062        return SHORTCUT_ACTIONS;
063    }
064
065    /**
066     * @see com.vaadin.event.Action.Handler#handleAction(com.vaadin.event.Action, java.lang.Object, java.lang.Object)
067     */
068    public void handleAction(Action action, Object sender, Object target) {
069
070        if (ENTER_ACTION.equals(action)) {
071            ok();
072        } else if (ESC_ACTION.equals(action)) {
073            cancel();
074        }
075    }
076
077    /**
078     * Called on key press 'Esc'.<p>
079     */
080    protected abstract void cancel();
081
082    /**
083     * Called on key press 'Enter'.<p>
084     */
085    protected abstract void ok();
086
087}