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
,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
,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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getConfiguration(CmsObject cms, A_CmsXmlContentValue contentValue, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
Returns the configuration string for the ADE content editor widget.java.util.List<java.lang.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.java.lang.String
getInitCall()
Returns the java script initialization call.java.util.List<java.lang.String>
getJavaScriptResourceLinks(CmsObject cms)
Returns a list of java script resources required by the widget.java.lang.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 Detail
-
getConfiguration
java.lang.String getConfiguration(CmsObject cms, A_CmsXmlContentValue contentValue, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
Returns the configuration string for the ADE content editor widget.- Parameters:
cms
- the OpenCms contextcontentValue
- the schema typemessages
- the messagesresource
- the edited resourcecontentLocale
- the content locale- Returns:
- the configuration string
-
getCssResourceLinks
java.util.List<java.lang.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
java.lang.String getInitCall()
Returns the java script initialization call.- Returns:
- the java script initialization call
-
getJavaScriptResourceLinks
java.util.List<java.lang.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
java.lang.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
-
-