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.widgets;
029
030import org.opencms.ade.contenteditor.shared.CmsComplexWidgetData;
031import org.opencms.file.CmsObject;
032
033/**
034 * Interface for complex widgets which are used in the Acacia editor to render whole nested contents.<p>
035 */
036public interface I_CmsComplexWidget {
037
038    /**
039     * Returns a copy of this widget which has been configured with the given configuration string.<p>
040     *
041     * @param configuration the configuration string
042     *
043     * @return the configured copy of the widget
044     */
045    I_CmsComplexWidget configure(String configuration);
046
047    /**
048     * Gets the name of the complex widget.<p>
049     *
050     * The string returned by this function should be a valid Javascript identifier.
051     *
052     * @return the name of the complex widget
053     */
054    String getName();
055
056    /**
057     * Gets the data needed for the editor to render the complex widget.<p>
058     *
059     * @param cms The CMS object to use for VFS operations
060     *
061     * @return the data for the complex widget
062     */
063    CmsComplexWidgetData getWidgetData(CmsObject cms);
064}