org.opencms.ui.A_CmsUI 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 (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.CmsResource;
import org.opencms.main.CmsUIServlet;
import org.opencms.ui.components.CmsBasicDialog;
import org.opencms.ui.components.CmsBasicDialog.DialogWidth;
import org.opencms.ui.components.extensions.CmsWindowExtension;
import org.opencms.ui.util.CmsDisplayType;
import com.vaadin.server.VaadinRequest;
import com.vaadin.server.VaadinServlet;
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.
*/
public abstract class A_CmsUI extends UI {
/** Serial version id. */
private static final long serialVersionUID = 989182479322461838L;
/** 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.
*/
public A_CmsUI() {
m_windowExtension = new CmsWindowExtension(this);
}
/**
* Returns the current UI.
*
* @return the current UI
*/
public static A_CmsUI get() {
return (A_CmsUI)(UI.getCurrent());
}
/**
* Returns the current cms context.
*
* @return the current cms context
*/
public static CmsObject getCmsObject() {
return ((CmsUIServlet)VaadinServlet.getCurrent()).getCmsObject();
}
/**
* Gets the display type from the time when the UI was initialized.
*
* @return the display type
*/
public CmsDisplayType getDisplayType() {
return m_displayType;
}
/**
* Gets the stored folder.
*
* @return the stored folder
*/
public CmsResource getStoredFolder() {
return (CmsResource)(getSession().getAttribute("WP_FOLDER"));
}
/**
* Tries to open a new browser window, and shows a warning if opening the window fails (usually because of popup blockers).
*
* @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).
*
* @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);
}
});
}
/**
* Replaces the ui content with a single dialog.
*
* 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.
*
* @param error the error message to display
*/
public void setError(String error) {
setContentToDialog("Error", new Label(error));
}
/**
* Stores the current folder.
*
* @param folder the current folder
*/
public void storeCurrentFolder(CmsResource folder) {
getSession().setAttribute("WP_FOLDER", folder);
}
/**
* @see com.vaadin.ui.UI#init(com.vaadin.server.VaadinRequest)
*/
@Override
protected void init(VaadinRequest request) {
m_displayType = CmsDisplayType.getDisplayType(getPage().getBrowserWindowWidth());
}
}