Package org.opencms.widgets

Interface I_CmsADEWidget

All Superinterfaces:

I_CmsWidget

All Known Implementing Classes:

A_CmsAdeGalleryWidget, A_CmsCategorizedSelectWidget, A_CmsFormatterWidget, A_CmsGalleryWidget, A_CmsSelectWidget, CmsAccessRestrictionWidget, CmsAddFormatterWidget, CmsAdeDownloadGalleryWidget, CmsAdeImageGalleryWidget, CmsCalendarWidget, CmsCategoryWidget, CmsCheckboxWidget, CmsCodeWidget, CmsColorpickerWidget, CmsComboWidget, CmsDependentSelectWidget, CmsDisplayTypeSelectWidget, CmsDisplayWidget, CmsDownloadGalleryWidget, CmsElementViewSelectWidget, CmsFilterSelectWidget, CmsGroupWidget, CmsHtmlWidget, CmsImageGalleryWidget, CmsInputWidget, CmsInputWidgetPlaintext, CmsLinkGalleryWidget, CmsLocalizationWidget, CmsLocationPickerWidget, CmsMultiSelectGroupWidget, CmsMultiSelectWidget, CmsOrgUnitWidget, CmsPasswordWidget, CmsPrincipalWidget, CmsRadioSelectWidget, CmsRemoveFormatterWidget, CmsSelectComboWidget, CmsSelectGroupWidget, CmsSelectOnChangeReloadWidget, CmsSelectWidget, CmsSerialDateWidget, CmsTextareaWidget, CmsTextareaWidgetPlaintext, CmsTypeComboWidget, CmsTypeFilterWidget, CmsUserWidget, CmsVfsFileWidget, CmsVfsImageWidget

public interface I_CmsADEWidget
extends I_CmsWidget

Widgets to be used with the new XML content editor are required to implement this interface.

Method Summary

Modifier and Type	Method	Description
String	getConfiguration(CmsObject cms, A_CmsXmlContentValue contentValue, CmsMessages messages, CmsResource resource, Locale contentLocale)	Returns the configuration string for the ADE content editor widget.
List<String>	getCssResourceLinks(CmsObject cms)	Returns a list of CSS resources required by the widget.
I_CmsXmlContentHandler.DisplayType	getDefaultDisplayType()	Returns the default display type of this widget.
String	getInitCall()	Returns the java script initialization call.
List<String>	getJavaScriptResourceLinks(CmsObject cms)	Returns a list of java script resources required by the widget.
String	getWidgetName()	Returns the class name of the widget.
boolean	isInternal()	Returns if this is an internal widget.

Methods inherited from interface org.opencms.widgets.I_CmsWidget

getConfiguration, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getDialogWidget, getHelpBubble, getHelpText, getWidgetStringValue, isCompactViewEnabled, newInstance, setConfiguration, setEditorValue

Method Details

getConfiguration

String getConfiguration(CmsObject cms,
 A_CmsXmlContentValue contentValue,
 CmsMessages messages,
 CmsResource resource,
 Locale contentLocale)

Returns the configuration string for the ADE content editor widget.

Parameters:

cms - the OpenCms context

contentValue - the schema type

messages - the messages

resource - the edited resource

contentLocale - the content locale

Returns:

the configuration string

getCssResourceLinks

List<String> getCssResourceLinks(CmsObject cms)

Returns a list of CSS resources required by the widget.

Parameters:

cms - the current OpenCms context

Returns:

the required CSS resource links

getDefaultDisplayType

I_CmsXmlContentHandler.DisplayType getDefaultDisplayType()

Returns the default display type of this widget.

Returns:

the default display type

getInitCall

String getInitCall()

Returns the java script initialization call.

Returns:

the java script initialization call

getJavaScriptResourceLinks

List<String> getJavaScriptResourceLinks(CmsObject cms)

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

Parameters:

cms - the current OpenCms context

Returns:

the required java script resource links

getWidgetName

String getWidgetName()

Returns the class name of the widget.

Returns:

the class name

isInternal

boolean isInternal()

Returns if this is an internal widget.

Only widgets belonging to the OpenCms core should be marked as internal.

Returns:

true if this is an internal widget