org.opencms.gwt.client.util.CmsEmbeddedDialogFrame Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opencms-gwt Show documentation
OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.
The newest version!
/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.gwt.client.util;

import org.opencms.gwt.client.CmsCoreProvider;
import org.opencms.gwt.client.ui.CmsIFrame;
import org.opencms.gwt.client.ui.css.I_CmsLayoutBundle;

import com.google.gwt.user.client.Timer;
import com.google.gwt.user.client.ui.RootPanel;

/**
 * Singleton that creates and manages access to the shared iframe used for embedded Vaadin dialogs, mainly in the page editor.
 */
public class CmsEmbeddedDialogFrame implements I_CmsEmbeddedDialogFrame {

    /** The loader used to load dialogs - this is set by the Javascript code in the iframe. */
    private I_CmsEmbeddedDialogLoader m_loader = null;

    /** The actual iframe. */
    private CmsIFrame m_frame;

    private String m_frameName;

    /**
     * Hidden default constructor.
     */
    protected CmsEmbeddedDialogFrame() {

    }

    /**
     * Gets the singleton instance.
     *
     * @return the instance
     */
    public static I_CmsEmbeddedDialogFrame get() {

        CmsEmbeddedDialogFrameWrapper currentWindow = CmsEmbeddedDialogFrameWrapper.window;
        if (currentWindow.embeddedDialogFrameInstance == null) {
            currentWindow.embeddedDialogFrameInstance = new CmsEmbeddedDialogFrame();
        }
        I_CmsEmbeddedDialogFrame result = currentWindow.embeddedDialogFrameInstance;
        return result;

    }

    /**
     * @see org.opencms.gwt.client.util.I_CmsEmbeddedDialogFrame#hide()
     */
    @Override
    public void hide() {

        if (m_frame != null) {
            setFrameVisible(false);
        }

    }

    /**
     * Sets the dialog loader.
     *
     * This is called by the Javascript code in the iframe.
     *
     * @param loader the class used to load dialogs in the iframe itself
     */
    @Override
    public void installEmbeddedDialogLoader(I_CmsEmbeddedDialogLoader loader) {

        m_loader = loader;
    }

    /**
     * @see org.opencms.gwt.client.util.I_CmsEmbeddedDialogFrame#loadDialog(java.lang.String, org.opencms.gwt.client.util.I_CmsEmbeddedDialogHandlerJsCallbacks)
     */
    @Override
    public void loadDialog(String dialogInfoJson, I_CmsEmbeddedDialogHandlerJsCallbacks handler) {

        waitUntilReady(() -> {
            setDialogHandlerCallbacks(m_frameName, handler);
            setFrameVisible(true);
            m_loader.loadDialog(dialogInfoJson);
        });
    }

    /**
     * @see org.opencms.gwt.client.util.I_CmsEmbeddedDialogFrame#preload()
     */
    @Override
    public void preload() {

        waitUntilReady(() -> {/*do nothing*/});
    }

    /**
     * Initializes the iframe if it isn't  already, and executes the given action afterwards.
     *
     * @param action the action to execute after the iframe is initialized
     */
    protected void waitUntilReady(Runnable action) {

        if (m_loader != null) {
            action.run();
            return;
        }
        if (m_frame == null) {
            String url = CmsCoreProvider.get().getEmbeddedDialogsUrl();
            m_frameName = "embeddedDialogFrame-" + Math.random();
            m_frame = new CmsIFrame(m_frameName, url);
            m_frame.addStyleName(I_CmsLayoutBundle.INSTANCE.dialogCss().embeddedDialogFrame());
            setFrameVisible(false);
            RootPanel.get().add(m_frame);
        }
        Timer timer = new Timer() {

            @Override
            public void run() {

                waitUntilReady(action);
            }
        };
        timer.schedule(200);
    }

    /**
     * Sets the dialog handler callbacks in the iframe context.
     *
     * @param handler the handler to set
     */
    private native void setDialogHandlerCallbacks(String frameName, I_CmsEmbeddedDialogHandlerJsCallbacks handler) /*-{
        $wnd.frames[frameName].connector = handler;
    }-*/;

    /**
     * Shows / hides the frame.
     *
     * @param visible true if the frame should be shown
     */
    private void setFrameVisible(boolean visible) {

        if (m_frame != null) {
            String className = I_CmsLayoutBundle.INSTANCE.dialogCss().embeddedDialogFrameHidden();
            if (visible) {
                m_frame.removeStyleName(className);
            } else {
                m_frame.addStyleName(className);
            }
        }
    }

}