org.opencms.ui.dialogs.CmsEmbeddedDialogContext Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* 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.ui.dialogs;
import org.opencms.ade.configuration.CmsADEManager;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsProject;
import org.opencms.file.CmsResource;
import org.opencms.main.OpenCms;
import org.opencms.ui.A_CmsUI;
import org.opencms.ui.I_CmsDialogContext;
import org.opencms.ui.apps.CmsQuickLaunchLocationCache;
import org.opencms.ui.components.CmsBasicDialog;
import org.opencms.ui.components.CmsBasicDialog.DialogWidth;
import org.opencms.ui.components.CmsErrorDialog;
import org.opencms.ui.shared.rpc.I_CmsEmbeddedDialogClientRPC;
import org.opencms.util.CmsStringUtil;
import org.opencms.util.CmsUUID;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.regex.Pattern;
import com.vaadin.server.AbstractExtension;
import com.vaadin.ui.Component;
import com.vaadin.ui.UI;
import com.vaadin.ui.Window;
import com.vaadin.ui.Window.CloseEvent;
import com.vaadin.ui.Window.CloseListener;
/**
* Context for dialogs embedded into plain GWT modules.
*/
public class CmsEmbeddedDialogContext extends AbstractExtension implements I_CmsDialogContext {
/** Pattern to check if a given server link starts with with a protocol string. */
private static Pattern PROTOCOL_PATTERN = Pattern.compile("^http.?://.*");
/** The serial version id. */
private static final long serialVersionUID = -7446784547935775629L;
/** The context type. */
private ContextType m_contextType;
/** Keeps the dialog frame on window close. */
private boolean m_keepFrameOnClose;
/** The list of resources. */
private List m_resources;
/** The window used to display the dialog. */
private Window m_window;
/** The app id. */
private String m_appId;
/**
* Constructor.
*
* @param appId the app id
* @param contextType the context type
* @param resources the resources
*/
public CmsEmbeddedDialogContext(String appId, ContextType contextType, List resources) {
extend(UI.getCurrent());
m_appId = appId;
m_contextType = contextType;
m_resources = resources != null ? resources : Collections. emptyList();
}
/**
* Closes the dialog window.
*
* @param keepFrame true to keep the embedded iFrame.
*/
public void closeWindow(boolean keepFrame) {
if (m_window != null) {
m_keepFrameOnClose = keepFrame;
m_window.close();
m_window = null;
}
}
/**
* @see org.opencms.ui.I_CmsDialogContext#error(java.lang.Throwable)
*/
public void error(Throwable error) {
closeWindow(true);
CmsErrorDialog.showErrorDialog(error, new Runnable() {
public void run() {
removeDialogFrame();
}
});
}
/**
* @see org.opencms.ui.I_CmsDialogContext#finish(org.opencms.file.CmsProject, java.lang.String)
*/
public void finish(CmsProject project, String siteRoot) {
if ((project != null) || (siteRoot != null)) {
String sitePath = null;
if (siteRoot != null) {
CmsQuickLaunchLocationCache locationCache = CmsQuickLaunchLocationCache.getLocationCache(
A_CmsUI.get().getHttpSession());
sitePath = locationCache.getPageEditorLocation(siteRoot);
if (sitePath == null) {
sitePath = locationCache.getFileExplorerLocation(siteRoot);
if (sitePath != null) {
int index = sitePath.indexOf("/" + CmsADEManager.CONTENT_FOLDER_NAME);
if (index >= 0) {
sitePath = sitePath.substring(0, index);
}
}
}
} else if ((m_resources != null) && !m_resources.isEmpty()) {
sitePath = A_CmsUI.getCmsObject().getSitePath(m_resources.get(0));
}
if (CmsStringUtil.isEmptyOrWhitespaceOnly(sitePath)) {
sitePath = "/";
}
String serverLink = OpenCms.getLinkManager().getServerLink(getCms(), sitePath);
if (!PROTOCOL_PATTERN.matcher(serverLink).matches()) {
serverLink = "http://" + serverLink;
}
getClientRPC().finishForProjectOrSiteChange(sitePath, serverLink);
} else {
finish(null);
}
}
/**
* @see org.opencms.ui.I_CmsDialogContext#finish(java.util.Collection)
*/
public void finish(Collection result) {
closeWindow(true);
String resources = "";
if (result != null) {
for (CmsUUID id : result) {
resources += id.toString() + ";";
}
}
getClientRPC().finish(resources);
}
/**
* @see org.opencms.ui.I_CmsDialogContext#focus(org.opencms.util.CmsUUID)
*/
public void focus(CmsUUID structureId) {
// does not apply
}
/**
* @see org.opencms.ui.I_CmsDialogContext#getAllStructureIdsInView()
*/
public List getAllStructureIdsInView() {
return Collections.emptyList();
}
/**
* @see org.opencms.ui.I_CmsDialogContext#getAppId()
*/
public String getAppId() {
return m_appId;
}
/**
* @see org.opencms.ui.I_CmsDialogContext#getCms()
*/
public CmsObject getCms() {
return A_CmsUI.getCmsObject();
}
/**
* @see org.opencms.ui.I_CmsDialogContext#getContextType()
*/
public ContextType getContextType() {
return m_contextType;
}
/**
* @see org.opencms.ui.I_CmsDialogContext#getResources()
*/
public List getResources() {
return m_resources;
}
/**
* @see org.opencms.ui.I_CmsDialogContext#navigateTo(java.lang.String)
*/
public void navigateTo(String appId) {
String targetUri = OpenCms.getSystemInfo().getWorkplaceContext() + "#!" + appId;
getClientRPC().leavePage(targetUri);
}
/**
* @see org.opencms.ui.I_CmsDialogContext#onViewChange()
*/
public void onViewChange() {
if (m_window != null) {
m_window.center();
}
}
/**
* @see org.opencms.ui.I_CmsDialogContext#reload()
*/
public void reload() {
closeWindow(true);
reloadParent();
}
/**
* @see org.opencms.ui.I_CmsDialogContext#setWindow(com.vaadin.ui.Window)
*/
public void setWindow(Window window) {
m_window = window;
m_window.addCloseListener(new CloseListener() {
private static final long serialVersionUID = 1L;
public void windowClose(CloseEvent e) {
handleWindowClose();
}
});
}
/**
* @see org.opencms.ui.I_CmsDialogContext#start(java.lang.String, com.vaadin.ui.Component)
*/
public void start(String title, Component dialog) {
start(title, dialog, DialogWidth.narrow);
}
/**
* @see org.opencms.ui.I_CmsDialogContext#start(java.lang.String, com.vaadin.ui.Component, org.opencms.ui.components.CmsBasicDialog.DialogWidth)
*/
public void start(String title, Component dialog, DialogWidth width) {
if (dialog != null) {
m_keepFrameOnClose = false;
m_window = CmsBasicDialog.prepareWindow(width);
m_window.setCaption(title);
m_window.setContent(dialog);
UI.getCurrent().addWindow(m_window);
m_window.addCloseListener(new CloseListener() {
private static final long serialVersionUID = 1L;
public void windowClose(CloseEvent e) {
handleWindowClose();
}
});
if (dialog instanceof CmsBasicDialog) {
((CmsBasicDialog)dialog).initActionHandler(m_window);
}
}
}
/**
* @see org.opencms.ui.I_CmsDialogContext#updateUserInfo()
*/
public void updateUserInfo() {
getClientRPC().reloadParent();
}
/**
* Returns the client RPC.
*
* @return the client RPC
*/
protected I_CmsEmbeddedDialogClientRPC getClientRPC() {
return getRpcProxy(I_CmsEmbeddedDialogClientRPC.class);
}
/**
* Handles the window close event.
*/
void handleWindowClose() {
if (!m_keepFrameOnClose) {
removeDialogFrame();
}
}
/**
* Removes the dialog iFrame.
*/
void removeDialogFrame() {
getClientRPC().finish(null);
}
/**
* Reloads the parent window.
*/
private void reloadParent() {
getClientRPC().reloadParent();
}
}