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.ade.galleries.client.preview;
029
030import org.opencms.ade.galleries.client.ui.CmsGalleryDialog;
031import org.opencms.ade.galleries.shared.CmsResourceInfoBean;
032
033import com.google.gwt.user.client.ui.Widget;
034
035/**
036 * Preview dialog handler interface.<p>
037 *
038 * Delegates the actions of the preview controller to the preview dialog.<p>
039 *
040 * @param <T> the resource info bean type
041 *
042 * @since 8.0.0
043 */
044public interface I_CmsPreviewHandler<T extends CmsResourceInfoBean> extends I_CmsPropertiesHandler {
045
046    /**
047     * Closes the preview.<p>
048     */
049    void closePreview();
050
051    /**
052     * Gets the additional widget to be displayed in the property tab.<p>
053     *
054     * @return the additional widget to be displayed in the property tab
055     */
056    Widget getAdditionalWidgetForPropertyTab();
057
058    /**
059     * Returns the gallery dialog.<p>
060     *
061     * @return the gallery dialog
062     */
063    CmsGalleryDialog getGalleryDialog();
064
065    /**
066     * Returns false, if the dialog may not be closed due to unsaved properties.<p>
067     *
068     * @return <code>true</code> if the dialog may be closed
069     */
070    boolean setDataInEditor();
071
072    /**
073     * Displays the given resource info data.<p>
074     *
075     * @param resourceInfo the resource info data
076     */
077    void showData(T resourceInfo);
078
079}