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.client;
029
030import org.opencms.ui.dialogs.permissions.CmsPrincipalSelectExtension;
031import org.opencms.ui.shared.rpc.I_CmsPrincipalSelectRpc;
032
033import com.vaadin.client.ServerConnector;
034import com.vaadin.client.extensions.AbstractExtensionConnector;
035import com.vaadin.shared.ui.Connect;
036
037/**
038 * The client principal select dialog connector.<p>
039 */
040@Connect(CmsPrincipalSelectExtension.class)
041public class CmsPrincipalSelectConnector extends AbstractExtensionConnector {
042
043    /** The serial version id. */
044    private static final long serialVersionUID = -4612206679727401825L;
045
046    /** The select service instance. */
047    private I_CmsPrincipalSelectRpc m_rpc;
048
049    /**
050     * Constructor.<p>
051     */
052    public CmsPrincipalSelectConnector() {
053
054        m_rpc = getRpcProxy(I_CmsPrincipalSelectRpc.class);
055    }
056
057    /**
058     * @see com.vaadin.client.ui.AbstractConnector#onUnregister()
059     */
060    @Override
061    public void onUnregister() {
062
063        super.onUnregister();
064        removeExportedFunctions();
065    }
066
067    /**
068     * @see com.vaadin.client.extensions.AbstractExtensionConnector#extend(com.vaadin.client.ServerConnector)
069     */
070    @Override
071    protected void extend(ServerConnector target) {
072
073        exportFunctions();
074    }
075
076    /**
077     * Sets the principal.<p>
078     *
079     * @param type the principal type
080     * @param principalName the principal name
081     */
082    void setPrincipal(int type, String principalName) {
083
084        m_rpc.setPrincipal(type, principalName);
085        // forcing the RPC to be executed immediately
086        getConnection().getHeartbeat().send();
087    }
088
089    /**
090     * Exports the setPrincipalFormValue function to the window context.<p>
091     */
092    private native void exportFunctions()/*-{
093        var self = this;
094        $wnd.setPrincipalFormValue = function(type, name) {
095            self.@org.opencms.ui.client.CmsPrincipalSelectConnector::setPrincipal(ILjava/lang/String;)(type,name);
096        };
097
098    }-*/;
099
100    /**
101     * Removes the setPrincipalFormValue function from the window context.<p>
102     */
103    private native void removeExportedFunctions()/*-{
104        $wnd.setPrincipalFormValue = null;
105
106    }-*/;
107
108}