org.opencms.widgets.I_CmsADEWidget Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.widgets;

import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.i18n.CmsMessages;
import org.opencms.xml.content.I_CmsXmlContentHandler.DisplayType;
import org.opencms.xml.types.A_CmsXmlContentValue;

import java.util.List;
import java.util.Locale;

/**
 * Widgets to be used with the new XML content editor are required to implement this interface.
 */
public interface I_CmsADEWidget extends I_CmsWidget {

    /**
     * Returns the configuration string for the ADE content editor widget.

     *
     * @param cms the OpenCms context
     * @param contentValue the schema type
     * @param messages the messages
     * @param resource the edited resource
     * @param contentLocale the content locale
     *
     * @return the configuration string
     */
    String getConfiguration(
        CmsObject cms,
        A_CmsXmlContentValue contentValue,
        CmsMessages messages,
        CmsResource resource,
        Locale contentLocale);

    /**
     * Returns a list of CSS resources required by the widget.

     *
     * @param cms the current OpenCms context
     *
     * @return the required CSS resource links
     */
    List getCssResourceLinks(CmsObject cms);

    /**
     * Returns the default display type of this widget.

     *
     * @return the default display type
     */
    DisplayType getDefaultDisplayType();

    /**
     * Returns the java script initialization call.

     *
     * @return the java script initialization call
     */
    String getInitCall();

    /**
     * Returns a list of java script resources required by the widget.

     *
     * @param cms the current OpenCms context
     *
     * @return the required java script resource links
     */
    List getJavaScriptResourceLinks(CmsObject cms);

    /**
     * Returns the class name of the widget.

     *
     * @return the class name
     */
    String getWidgetName();

    /**
     * Returns if this is an internal widget.

     * Only widgets belonging to the OpenCms core should be marked as internal.
     *
     * @return true if this is an internal widget
     */
    boolean isInternal();

}