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;
029
030import com.vaadin.navigator.View;
031import com.vaadin.ui.Component;
032
033/**
034 * Factory to create components.<p>
035 */
036public interface I_CmsAppView extends View {
037
038    /**
039     * Disables the global keyboard shortcuts.<p>
040     */
041    void disableGlobalShortcuts();
042
043    /**
044     * Enables the global keyboard shortcuts.<p>
045     */
046    void enableGlobalShortcuts();
047
048    /**
049     * Enters the view.<p>
050     *
051     * @param state the state to set
052     */
053    void enter(String state);
054
055    /**
056     * Returns the app component, initializes it if required.<p>
057     *
058     * @return the component
059     */
060    Component getComponent();
061
062    /**
063     * Returns the view name.<p>
064     *
065     * @return the view name
066     */
067    String getName();
068
069    /**
070     * Returns whether this view should be cached within the user session.<p>
071     *
072     * @return <code>true</code> if the view is cachable
073     */
074    boolean isCachable();
075
076    /**
077     * Creates a new component instance.<p>
078     *
079     * @return the new component
080     */
081    Component reinitComponent();
082
083    /**
084     * Returns whether this view needs to be restored from cache.<p>
085     *
086     * @return <code>true</code> if this view needs to be restored from cache
087     */
088    boolean requiresRestore();
089
090    /**
091     * Restores the view from cache.<p>
092     */
093    void restoreFromCache();
094
095    /**
096     * Sets the requires restore from cache flag.<p>
097     *
098     * @param restored the requires restore from cache flag
099     */
100    void setRequiresRestore(boolean restored);
101}