001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://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: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://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.client;
029
030import org.opencms.ui.report.CmsReportWidget;
031import org.opencms.ui.shared.rpc.I_CmsReportClientRpc;
032import org.opencms.ui.shared.rpc.I_CmsReportServerRpc;
033
034import com.google.gwt.core.client.Scheduler;
035import com.google.gwt.core.client.Scheduler.RepeatingCommand;
036import com.google.gwt.user.client.ui.Widget;
037import com.vaadin.client.ui.AbstractComponentConnector;
038import com.vaadin.shared.ui.Connect;
039
040/**
041 * Connector for the report widget.<p>
042 */
043@Connect(CmsReportWidget.class)
044public class CmsReportWidgetConnector extends AbstractComponentConnector implements I_CmsReportClientRpc {
045
046    /** Serial version id. */
047    private static final long serialVersionUID = 1L;
048
049    /** True if we know the report is finished (i.e. the last report update (null) has been received. */
050    private boolean m_reportFinished;
051
052    /** True if the connector has been unregistered. */
053    private boolean m_unregistered;
054
055    /**
056     * Creates a new instance.<p>
057     */
058    public CmsReportWidgetConnector() {
059
060        registerRpc(I_CmsReportClientRpc.class, this);
061        RepeatingCommand command = new RepeatingCommand() {
062
063            @SuppressWarnings("synthetic-access")
064            public boolean execute() {
065
066                if (m_unregistered || m_reportFinished) {
067                    return false;
068                }
069
070                getRpcProxy(I_CmsReportServerRpc.class).requestReportUpdate();
071                return true;
072            }
073
074        };
075        Scheduler.get().scheduleFixedDelay(command, 750);
076
077    }
078
079    /**
080     * @see org.opencms.ui.shared.rpc.I_CmsReportClientRpc#handleReportUpdate(java.lang.String)
081     */
082    public void handleReportUpdate(String reportUpdate) {
083
084        if (reportUpdate == null) {
085            m_reportFinished = true;
086        } else {
087            CmsClientReportWidget widget = (CmsClientReportWidget)getWidget();
088            widget.append(reportUpdate);
089        }
090    }
091
092    /**
093     * @see com.vaadin.client.ui.AbstractComponentConnector#onUnregister()
094     */
095    @Override
096    public void onUnregister() {
097
098        m_unregistered = true;
099        super.onUnregister();
100    }
101
102    /**
103     * @see com.vaadin.client.ui.AbstractComponentConnector#createWidget()
104     */
105    @Override
106    protected Widget createWidget() {
107
108        return new CmsClientReportWidget();
109    }
110
111}