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 to expose the embedded frame methods as Javascript methods so they can be called from a different GWT context. 034 */ 035@JsType(isNative = true) 036public interface I_CmsEmbeddedDialogFrame { 037 038 /** 039 * Hides the iframe. 040 */ 041 void hide(); 042 043 /** 044 * Sets the dialog loader. 045 * 046 * <p>This is called by the Javascript code in the iframe. 047 * 048 * @param loader the class used to load dialogs in the iframe itself 049 */ 050 void installEmbeddedDialogLoader(I_CmsEmbeddedDialogLoader loader); 051 052 /** 053 * Triggers loading of a new dialog in the iframe. 054 * 055 * <p>If the iframe has not been created/initialized yet, this will trigger the initialization and load the dialog afterwards. 056 * 057 * @param dialogInfoJson the serialized dialog info JSON from an I_CmsEmbeddedDialogInfo bean 058 * @param handler the embedded dialog handler 059 */ 060 void loadDialog(String dialogInfoJson, I_CmsEmbeddedDialogHandlerJsCallbacks handler); 061 062 /** 063 * Triggers initialization of the iframe. 064 */ 065 void preload(); 066 067}