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.dialogs.CmsEmbeddedDialogsUI;
031import org.opencms.ui.shared.rpc.I_CmsEmbeddedDialogClientRPC;
032import org.opencms.ui.shared.rpc.I_CmsEmbeddingServerRpc;
033
034import com.vaadin.server.AbstractExtension;
035
036/**
037 * The extension that provides RPC communication between the client and server side of embedded VAADIN dialogs.
038 */
039public class CmsEmbeddedDialogExtension extends AbstractExtension {
040
041    /** Serial version id. */
042    private static final long serialVersionUID = 1L;
043
044    /**
045     * Creates a new instance.
046     * @param ui the UI instance to use
047     *
048     */
049    public CmsEmbeddedDialogExtension(CmsEmbeddedDialogsUI ui) {
050
051        super(ui);
052        registerRpc(ui, I_CmsEmbeddingServerRpc.class);
053    }
054
055    /**
056     * Gets the client RPC instance.
057     *
058     * @return the client RPC instance
059     */
060    public I_CmsEmbeddedDialogClientRPC getClientRPC() {
061
062        return getRpcProxy(I_CmsEmbeddedDialogClientRPC.class);
063    }
064
065}