Java tutorial
/* * 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; import org.opencms.file.CmsObject; import org.opencms.file.CmsProject; import org.opencms.main.CmsUIServlet; import org.opencms.main.OpenCms; import org.opencms.ui.components.CmsBasicDialog; import org.opencms.ui.components.CmsBasicDialog.DialogWidth; import org.opencms.ui.components.extensions.CmsWindowExtension; import org.opencms.ui.login.CmsLoginHelper; import org.opencms.ui.util.CmsDisplayType; import org.opencms.util.CmsRequestUtil; import org.opencms.workplace.CmsWorkplaceManager; import org.opencms.workplace.CmsWorkplaceSettings; import java.io.Serializable; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import javax.servlet.http.HttpSession; import com.google.common.collect.Multimap; import com.vaadin.server.VaadinRequest; import com.vaadin.server.VaadinService; import com.vaadin.server.VaadinServlet; import com.vaadin.server.WrappedHttpSession; import com.vaadin.ui.Button; import com.vaadin.ui.Component; import com.vaadin.ui.Label; import com.vaadin.ui.Notification; import com.vaadin.ui.Notification.Type; import com.vaadin.ui.UI; import com.vaadin.ui.VerticalLayout; import com.vaadin.ui.Window; /** * Abstract UI class providing access to the OpenCms context.<p> */ public abstract class A_CmsUI extends UI { /** The last offline project attribute key. */ public static final String LAST_OFFLINE_PROJECT = "lastOfflineProject"; /** Serial version id. */ private static final long serialVersionUID = 989182479322461838L; /** UI attribute storage. */ private Map<String, Serializable> m_attributes; /** The display type at the time the UI was initialized. */ private CmsDisplayType m_displayType; /** Extension used for opening new browser windows. */ private CmsWindowExtension m_windowExtension; /** * Constructor.<p> */ public A_CmsUI() { m_windowExtension = new CmsWindowExtension(this); m_attributes = new ConcurrentHashMap<String, Serializable>(); getLoadingIndicatorConfiguration().setFirstDelay(600); } /** * Returns the current UI.<p> * * @return the current UI */ public static A_CmsUI get() { return (A_CmsUI) (UI.getCurrent()); } /** * Returns the current cms context.<p> * * @return the current cms context */ public static CmsObject getCmsObject() { return ((CmsUIServlet) VaadinServlet.getCurrent()).getCmsObject(); } /** * Changes to the given project. Will update session and workplace settings.<p> * * @param project the project to change to */ public void changeProject(CmsProject project) { CmsObject cms = getCmsObject(); if (!cms.getRequestContext().getCurrentProject().equals(project)) { cms.getRequestContext().setCurrentProject(project); getWorkplaceSettings().setProject(project.getUuid()); OpenCms.getSessionManager().updateSessionInfo(cms, getHttpSession()); if (!project.isOnlineProject()) { setAttribute(LAST_OFFLINE_PROJECT, project); } } } /** * Changes to the given site. Will update session and workplace settings.<p> * * @param siteRoot the site to change to */ public void changeSite(String siteRoot) { if (!getCmsObject().getRequestContext().getSiteRoot().equals(siteRoot)) { getCmsObject().getRequestContext().setSiteRoot(siteRoot); getWorkplaceSettings().setSite(siteRoot); OpenCms.getSessionManager().updateSessionInfo(getCmsObject(), getHttpSession()); } } /** * Closes all opened dialog windows.<p> */ public void closeWindows() { for (Window window : getWindows()) { window.close(); } } /** * Returns the requested UI attribute.<p> * * @param key the attribute key * * @return the attribute */ public Serializable getAttribute(String key) { return m_attributes.get(key); } /** * Gets the display type from the time when the UI was initialized.<p> * * @return the display type */ public CmsDisplayType getDisplayType() { return m_displayType; } /** * Returns the HTTP session.<p> * * @return the HTTP session */ public HttpSession getHttpSession() { return ((WrappedHttpSession) getSession().getSession()).getHttpSession(); } /** * Returns the last used offline project.<p> * * @return the last used offline project */ public CmsProject getLastOfflineProject() { return (CmsProject) getAttribute(LAST_OFFLINE_PROJECT); } /** * Gets the request parameters with which the application was loaded.<p> * * @return the request parameters */ public Multimap<String, String> getParameters() { return CmsRequestUtil.getParameters(getPage().getLocation()); } /** * Returns the workplace settings.<p> * * @return the workplace settings */ public CmsWorkplaceSettings getWorkplaceSettings() { CmsWorkplaceSettings settings = (CmsWorkplaceSettings) getSession().getSession() .getAttribute(CmsWorkplaceManager.SESSION_WORKPLACE_SETTINGS); if (settings == null) { settings = CmsLoginHelper.initSiteAndProject(getCmsObject()); VaadinService.getCurrentRequest().getWrappedSession() .setAttribute(CmsWorkplaceManager.SESSION_WORKPLACE_SETTINGS, settings); } return settings; } /** * Tries to open a new browser window, and shows a warning if opening the window fails (usually because of popup blockers).<p> * * @param link the URL to open in the new window * @param target the target window name */ public void openPageOrWarn(String link, String target) { openPageOrWarn(link, target, CmsVaadinUtils.getMessageText(org.opencms.ui.Messages.GUI_POPUP_BLOCKED_0)); } /** * Tries to open a new browser window, and shows a warning if opening the window fails (usually because of popup blockers).<p> * * @param link the URL to open in the new window * @param target the target window name * @param warning the warning to show if opening the window fails */ public void openPageOrWarn(String link, String target, final String warning) { m_windowExtension.open(link, target, new Runnable() { public void run() { Notification.show(warning, Type.ERROR_MESSAGE); } }); } /** * Reloads the current UI.<p> */ public void reload() { getPage().reload(); } /** * Sets an UI attribute.<p> * * @param key the attribute key * @param value the attribute value */ public void setAttribute(String key, Serializable value) { m_attributes.put(key, value); } /** * Replaces the ui content with a single dialog.<p> * * @param caption the caption * @param dialog the dialog content */ public void setContentToDialog(String caption, CmsBasicDialog dialog) { setContent(new Label()); Window window = CmsBasicDialog.prepareWindow(DialogWidth.narrow); window.setContent(dialog); window.setCaption(caption); window.setClosable(false); addWindow(window); window.center(); } /** * Replaces the ui content with a single dialog.<p> * * TODO: In the future this should only handle window creation, refactor dialog contents to CmsBasicDialog * * @param caption the caption * @param component the dialog content */ public void setContentToDialog(String caption, Component component) { setContent(new Label()); Window window = CmsBasicDialog.prepareWindow(DialogWidth.narrow); CmsBasicDialog dialog = new CmsBasicDialog(); VerticalLayout result = new VerticalLayout(); dialog.setContent(result); window.setContent(dialog); window.setCaption(caption); window.setClosable(false); addWindow(window); window.center(); if (component instanceof I_CmsHasButtons) { I_CmsHasButtons hasButtons = (I_CmsHasButtons) component; for (Button button : hasButtons.getButtons()) { dialog.addButton(button); } } result.addComponent(component); } /** * Displays an error message in a centered box.<p> * * @param error the error message to display */ public void setError(String error) { setContentToDialog("Error", new Label(error)); } /** * @see com.vaadin.ui.UI#init(com.vaadin.server.VaadinRequest) */ @Override protected void init(VaadinRequest request) { m_displayType = CmsDisplayType.getDisplayType(getPage().getBrowserWindowWidth()); } }