001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://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: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://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.ui.report;
029
030import org.opencms.report.A_CmsReportThread;
031import org.opencms.ui.A_CmsUI;
032import org.opencms.ui.components.CmsBasicDialog;
033
034import com.vaadin.ui.Button;
035import com.vaadin.ui.Button.ClickEvent;
036import com.vaadin.ui.Button.ClickListener;
037import com.vaadin.ui.VerticalLayout;
038import com.vaadin.ui.Window;
039
040/**
041 * Simple dialog for displaying a report.
042 */
043public class CmsReportDialog extends CmsBasicDialog {
044
045    /** Vaadin serial id.*/
046    private static final long serialVersionUID = 1L;
047
048    /**
049     * Public constructor.<p>
050     *
051     * @param thread to be run
052     * @param window holds the dialog
053     */
054    public CmsReportDialog(A_CmsReportThread thread, final Window window) {
055
056        this(thread, window, null);
057    }
058
059    /**
060     * Public constructor with an optional close action.<p>
061     *
062     * @param thread to be run
063     * @param window holds the dialog
064     * @param closeAction the action to run after closing the dialog, or {@code null}
065     */
066    public CmsReportDialog(A_CmsReportThread thread, final Window window, final Runnable closeAction) {
067
068        Button close = createButtonClose();
069        close.addClickListener(new ClickListener() {
070
071            private static final long serialVersionUID = 1L;
072
073            public void buttonClick(ClickEvent event) {
074
075                window.close();
076                if (closeAction != null) {
077                    closeAction.run();
078                }
079            }
080
081        });
082        addButton(close, true);
083        CmsReportWidget report = new CmsReportWidget(thread);
084        setHeight("100%");
085        report.setWidth("100%");
086        report.setHeight("100%");
087        VerticalLayout container = new VerticalLayout();
088        container.setHeight("100%");
089        container.addComponent(report);
090        setContent(container);
091    }
092
093    /**
094     * Creates a new window and displays the given report thread's output in it.
095     *
096     * <p>Does <i>not</i> start the thread.
097     *
098     * @param title the title for the window
099     * @param thread the thread whose report should be displayed
100     */
101    public static void showReportDialog(String title, A_CmsReportThread thread) {
102
103        showReportDialog(title, thread, null);
104    }
105
106    /**
107     * Creates a new window and displays the given report thread's output in it.<p>
108     *
109     * @param title the title for the window
110     * @param thread the thread whose report should be displayed
111     * @param closeAction the action to run after closing the report, or {@code null}
112     */
113    public static void showReportDialog(String title, A_CmsReportThread thread, Runnable closeAction) {
114
115        Window window = CmsBasicDialog.prepareWindow(DialogWidth.wide);
116        window.setCaption(title);
117        window.setHeight("500px");
118        window.setContent(new CmsReportDialog(thread, window, closeAction));
119        A_CmsUI.get().addWindow(window);
120        thread.start();
121    }
122
123}