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.gwt.client.util;
029
030import jsinterop.annotations.JsType;
031
032/**
033 * Interface used to export callback methods from CmsEmbeddedDialogHandler as JavaScript methods.
034 */
035@JsType(isNative = true)
036public interface I_CmsEmbeddedDialogHandlerJsCallbacks {
037
038    /**
039     * Called on dialog close.<p>
040     *
041     * @param resources the resource ids to update as a ';' separated string.<p>
042     */
043    public void finish(String resources);
044
045    /**
046     * Called when site and or project have been changed.<p>
047     *
048     * @param sitePath the site path to the resource to display
049     * @param serverLink the server link to the resource to display
050     */
051    public void finishForProjectOrSiteChange(String sitePath, String serverLink);
052
053    /**
054     * Navigates to the given URI.<p>
055     *
056     * @param targetUri the target URI
057     */
058    public void leavePage(String targetUri);
059
060    /**
061     * Reloads the current page.<p>
062     */
063    public void reload();
064
065    /**
066     * Calls the principle select handler and closes the dialog frame.<p>
067     *
068     * @param principle the principle to select
069     */
070    public void selectString(String principle);
071
072}