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.client;
029
030import org.opencms.gwt.client.util.CmsDebugLog;
031
032import com.vaadin.client.ui.VUI;
033
034/**
035 * UI widget overriding some functionality from the Vaadin implementation.<p>
036 */
037public class CmsVUI extends VUI {
038
039    /** The current instance. */
040    public static CmsVUI INSTANCE;
041
042    /** Boolean flag which indicates whether the stored focus should be cleared. */
043    private boolean m_clearedStoredFocus;
044
045    /**
046     * Clears the stored focus for the current UI instance.<p>
047     *
048     * Useful when you want more explicit control over the focus after closing a window.<p>
049     */
050    public static void clearStoredFocusForCurrentInstance() {
051
052        if (INSTANCE != null) {
053            INSTANCE.clearStoredFocus();
054        } else {
055            CmsDebugLog.consoleLog("clearStoredFocus called, but UI instance not set.");
056        }
057
058    }
059
060    /**
061     * Clears the stored focus.<p>
062     *
063     * Use this when you want to set the focus explicitly after closing a Vaadin window.
064     */
065    public void clearStoredFocus() {
066
067        m_clearedStoredFocus = true;
068    }
069
070    /**
071     * @see com.vaadin.client.ui.VUI#focusStoredElement()
072     */
073    @Override
074    public void focusStoredElement() {
075
076        if (!m_clearedStoredFocus) {
077            super.focusStoredElement();
078        }
079    }
080
081    /**
082     * @see com.vaadin.client.ui.VUI#storeFocus()
083     */
084    @Override
085    public void storeFocus() {
086
087        m_clearedStoredFocus = false;
088        super.storeFocus();
089    }
090
091    /**
092     * @see com.vaadin.client.ui.VUI#onLoad()
093     */
094    @Override
095    protected void onLoad() {
096
097        super.onLoad();
098        INSTANCE = this;
099    }
100}