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.components.extensions;
029
030import org.opencms.ui.components.CmsUploadButton.I_UploadListener;
031import org.opencms.ui.shared.components.CmsUploadAreaState;
032import org.opencms.ui.shared.rpc.I_CmsUploadRpc;
033
034import java.util.ArrayList;
035import java.util.List;
036
037import com.vaadin.server.AbstractExtension;
038import com.vaadin.ui.AbstractComponent;
039
040/**
041 * Extends the given component to be an upload drop area.<p>
042 */
043public class CmsUploadAreaExtension extends AbstractExtension implements I_CmsUploadRpc {
044
045    /** The serial version id. */
046    private static final long serialVersionUID = 3978957151754705873L;
047
048    /** The registered window close listeners. */
049    private List<I_UploadListener> m_listeners;
050
051    /**
052     * Constructor.<p>
053     *
054     * @param component the component to extend
055     */
056    public CmsUploadAreaExtension(AbstractComponent component) {
057
058        extend(component);
059        registerRpc(this);
060        m_listeners = new ArrayList<I_UploadListener>();
061    }
062
063    /**
064     * Adds a window close listener.<p>
065     *
066     * @param listener the listener to add
067     */
068    public void addUploadListener(I_UploadListener listener) {
069
070        m_listeners.add(listener);
071    }
072
073    /**
074     * @see org.opencms.ui.shared.rpc.I_CmsUploadRpc#onUploadFinished(java.util.List)
075     */
076    public void onUploadFinished(List<String> files) {
077
078        for (I_UploadListener listener : m_listeners) {
079            listener.onUploadFinished(files);
080        }
081    }
082
083    /**
084     * Removes the given window close listener.<p>
085     *
086     * @param listener the listener to remove
087     */
088    public void removeUploadListener(I_UploadListener listener) {
089
090        m_listeners.remove(listener);
091    }
092
093    /**
094     * Sets the upload target folder.<p>
095     *
096     * @param targetFolder the folder root path
097     */
098    public void setTargetFolder(String targetFolder) {
099
100        getState().setTargetFolderRootPath(targetFolder);
101    }
102
103    /**
104     * @see com.vaadin.server.AbstractClientConnector#getState()
105     */
106    @Override
107    protected CmsUploadAreaState getState() {
108
109        return (CmsUploadAreaState)super.getState();
110    }
111}