001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (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.ade.contenteditor.shared;
029
030import com.google.gwt.user.client.rpc.IsSerializable;
031
032/**
033 * Bean which holds the necessary data for complex value widgets in the Acacia editor.<p>
034 */
035public class CmsComplexWidgetData implements IsSerializable {
036
037    /** The renderer configuration string. */
038    private String m_configuration;
039
040    /**
041     * Information about external resources needed by the complex widget.
042     */
043    private CmsExternalWidgetConfiguration m_externalWidgetConfiguration;
044
045    /** The name of the renderer to use for the complex widget. */
046    private String m_rendererName;
047
048    /**
049     * Creates a new instance.<p>
050     *
051     * @param rendererName the renderer name
052     * @param config the renderer configuration
053     * @param extConfig the external resource configuration for the widget
054     */
055    public CmsComplexWidgetData(String rendererName, String config, CmsExternalWidgetConfiguration extConfig) {
056
057        m_rendererName = rendererName;
058        m_configuration = config;
059        m_externalWidgetConfiguration = extConfig;
060    }
061
062    /**
063     * Defaul constructor for serialization.<p>
064     */
065    protected CmsComplexWidgetData() {
066
067        // do  nothing
068    }
069
070    /**
071     * Gets the renderer configuration string.<p>
072     *
073     * @return the renderer configuration string
074     */
075    public String getConfiguration() {
076
077        return m_configuration;
078    }
079
080    /**
081     * Gets information about the external resources which are needed by this widget.<p>
082     *
083     * @return the information about the required external resources
084     */
085    public CmsExternalWidgetConfiguration getExternalWidgetConfiguration() {
086
087        return m_externalWidgetConfiguration;
088    }
089
090    /**
091     * Gets the renderer name.<p>
092     *
093     * @return the renderer name
094     */
095    public String getRendererName() {
096
097        return m_rendererName;
098    }
099}