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.shared.components;
029
030import com.vaadin.shared.communication.ClientRpc;
031
032/**
033 * Server-to-client Interface for the GWT dialog extension.<p>
034 */
035public interface I_CmsGwtDialogClientRpc extends ClientRpc {
036
037    /**
038     * Opens the 'external link' editor dialog for a pointer resource.<p>
039     *
040     * @param structureId the structure id of the resource
041     */
042    void editPointer(String structureId);
043
044    /**
045     * Tells the client to open the property editing dialog for the resource with the given structure id.<p>
046     *
047     * @param structureId the structure id of a resource, as a string
048     * @param editName if true, makes the file name editable
049     */
050    void editProperties(String structureId, boolean editName);
051
052    /**
053     * Opens the categories dialog.<p>
054     *
055     * @param structureId the structure id of the resource to open the dialog for
056     * @param collapsed flag, indicating if all categories should be collapsed when the dialog opens
057     */
058    void openCategoriesDialog(String structureId, boolean collapsed);
059
060    /**
061     * Opens the XML content editor for the resource with the given structure id.<p>
062     *
063     * @param structureId the structure id of a resource
064     * @param fileName the site path to the resource to edit
065     */
066    void openContentEditor(String structureId, String fileName);
067
068    /**
069     * Opens the gallery dialog with the given JSON configuration.<p>
070     *
071     * @param galleryConfiguration the gallery configuration
072     */
073    void openGalleryDialog(String galleryConfiguration);
074
075    /**
076     * Opens the resource info dialog for the resource with the given structure id.<p>
077     *
078     * @param structureId the structure id of a resource, as a string
079     * @param startTab the start tab id
080     */
081    void openInfoDialog(String structureId, String startTab);
082
083    /**
084     * Opens the lock report dialog.<p>
085     *
086     * @param dialogTitle the dialog title
087     * @param structureId the structure id of the resource to open the dialog for
088     */
089    void openLockReport(String dialogTitle, String structureId);
090
091    /**
092     * Opens the publish dialog with the given publish data.<p>
093     *
094     * @param serializedPublishData the publish data, an instance of CmsPublishData serialized with the GWT serialization mechanism
095     */
096    void openPublishDialog(String serializedPublishData);
097
098    /**
099     * Opens the 'replace' dialog for the resource with the given structure id.<p>
100     *
101     * @param structureId the structure id of a resource
102     */
103    void openReplaceDialog(String structureId);
104
105    /**
106     * Shows the OpenCms about dialog.<p>
107     */
108    void showAbout();
109
110    /**
111     * Shows the preview dialog for resource with the given structure id and version string.<p>
112     *
113     * The version string format is defined by the toString() method of org.opencms.gwt.shared.CmsHistoryVersion.
114     *
115     * @param uuid the UUID
116     * @param historyVersion the history version string
117     */
118    void showPreview(String uuid, String historyVersion);
119
120    /**
121     * Shows the user preferences.<p>
122     */
123    void showUserPreferences();
124
125}