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.dialogs.permissions;
029
030import org.opencms.ui.A_CmsUI;
031import org.opencms.ui.shared.rpc.I_CmsPrincipalSelectRpc;
032
033import com.vaadin.server.AbstractExtension;
034import com.vaadin.ui.UI;
035
036/**
037 * The principal select extension. Handles communication between the select dialog iframe and the server.<p>
038 */
039public class CmsPrincipalSelectExtension extends AbstractExtension implements I_CmsPrincipalSelectRpc {
040
041    /** The serial version id. */
042    private static final long serialVersionUID = -38736017917448694L;
043
044    /** The select widget. */
045    private CmsPrincipalSelect m_select;
046
047    /**
048     * Constructor.<p>
049     *
050     * @param ui the select widget
051     */
052    private CmsPrincipalSelectExtension(UI ui) {
053
054        extend(ui);
055        registerRpc(this);
056    }
057
058    /**
059     * Returns the principal select extension instance for the current UI.<p>
060     *
061     * @return the instance
062     */
063    protected static CmsPrincipalSelectExtension getInstance() {
064
065        A_CmsUI ui = A_CmsUI.get();
066        CmsPrincipalSelectExtension instance = (CmsPrincipalSelectExtension)ui.getAttribute(
067            CmsPrincipalSelectExtension.class.getName());
068        if (instance == null) {
069            instance = new CmsPrincipalSelectExtension(ui);
070            ui.setAttribute(CmsPrincipalSelectExtension.class.getName(), instance);
071        }
072        return instance;
073    }
074
075    /**
076     * Sets the current select widget.<p>
077     * This needs to be called, when the select window is opened.<p>
078     *
079     * @param select the select widget
080     */
081    public void setCurrentSelect(CmsPrincipalSelect select) {
082
083        m_select = select;
084    }
085
086    /**
087     * @see org.opencms.ui.shared.rpc.I_CmsPrincipalSelectRpc#setPrincipal(int, java.lang.String)
088     */
089    public void setPrincipal(int type, String principalName) {
090
091        if (m_select != null) {
092            m_select.setPrincipal(type, principalName);
093            m_select.closeWindow();
094            m_select = null;
095        }
096    }
097}