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.shared.CmsResourceInfoBean;
031import org.opencms.ade.galleries.shared.I_CmsGalleryProviderConstants.GalleryMode;
032
033import java.util.Map;
034
035/**
036 * Interface for the preview controller.<p>
037 *
038 * @param <T> the resource info bean type
039 *
040 * @since 8.0.0
041 */
042public interface I_CmsPreviewController<T extends CmsResourceInfoBean> {
043
044    /**
045     * Checks if further user input is required and other wise sets the selected resource via the provided integrator functions <code>setLink</code> and <code>setImage</code>.
046     * Returning <code>true</code> when all data has been set and the dialog should be closed.
047     *
048     * @return <code>true</code> when all data has been set and the dialog should be closed
049     */
050    boolean closeGalleryDialog();
051
052    /**
053     * Loads the resource info and displays the retrieved data.<p>
054     *
055     * @param resourcePath the resource path
056     */
057    void loadResourceInfo(String resourcePath);
058
059    /**
060     * Removes the preview.<p>
061     */
062    void removePreview();
063
064    /**
065     * Saves the changed properties.<p>
066     *
067     * @param properties the changed properties
068     */
069    void saveProperties(Map<String, String> properties);
070
071    /**
072     * Sets the current resource within the editor or xml-content.<p>
073     *
074     * @param galleryMode the gallery mode
075     */
076    void setResource(GalleryMode galleryMode);
077
078    /**
079     * Calls the preview handler to display the given data.<p>
080     *
081     * @param resourceInfo the resource info data
082     */
083    void showData(T resourceInfo);
084}