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.components.extensions;
029
030import org.opencms.ui.components.I_CmsWindowCloseListener;
031import org.opencms.ui.shared.rpc.I_CmsWindowCloseServerRpc;
032
033import java.util.ArrayList;
034import java.util.List;
035
036import com.vaadin.server.AbstractExtension;
037import com.vaadin.ui.UI;
038
039/**
040 * Makes window close events available on the server side.<p>
041 */
042public class CmsWindowCloseExtension extends AbstractExtension implements I_CmsWindowCloseServerRpc {
043
044    /** The serial version id. */
045    private static final long serialVersionUID = 3978957151754705873L;
046
047    /** The registered window close listeners. */
048    private List<I_CmsWindowCloseListener> m_listeners;
049
050    /**
051     * Constructor.<p>
052     *
053     * @param ui the UI to extend
054     */
055    public CmsWindowCloseExtension(UI ui) {
056
057        extend(ui);
058        registerRpc(this);
059        m_listeners = new ArrayList<I_CmsWindowCloseListener>();
060    }
061
062    /**
063     * Adds a window close listener.<p>
064     *
065     * @param listener the listener to add
066     */
067    public void addWindowCloseListener(I_CmsWindowCloseListener listener) {
068
069        m_listeners.add(listener);
070    }
071
072    /**
073     * Removes the given window close listener.<p>
074     *
075     * @param listener the listener to remove
076     */
077    public void removeWindowCloseListener(I_CmsWindowCloseListener listener) {
078
079        m_listeners.remove(listener);
080    }
081
082    /**
083     * @see org.opencms.ui.shared.rpc.I_CmsWindowCloseServerRpc#windowClosed(java.lang.String)
084     */
085    public void windowClosed(String syncToken) {
086
087        for (I_CmsWindowCloseListener listener : m_listeners) {
088            listener.onWindowClose();
089        }
090    }
091}