org.opencms.widgets

接口 I_CmsADEWidget

所有超级接口:

I_CmsWidget

所有已知实现类:

A_CmsAdeGalleryWidget, A_CmsFormatterWidget, A_CmsGalleryWidget, A_CmsHtmlGalleryWidget, A_CmsSelectWidget, CmsAddFormatterWidget, CmsAdeDownloadGalleryWidget, CmsAdeImageGalleryWidget, CmsCalendarWidget, CmsCategoryWidget, CmsCheckboxWidget, CmsColorpickerWidget, CmsComboWidget, CmsDisplayWidget, CmsDownloadGalleryWidget, CmsGroupWidget, CmsHtmlGalleryWidget, CmsHtmlWidget, CmsImageGalleryWidget, CmsInputWidget, CmsInputWidgetPlaintext, CmsLinkGalleryWidget, CmsLocalizationWidget, CmsMultiSelectGroupWidget, CmsMultiSelectWidget, CmsOrgUnitWidget, CmsPasswordWidget, CmsPrincipalWidget, CmsRadioSelectWidget, CmsRemoveFormatterWidget, CmsSelectGroupWidget, CmsSelectOnChangeReloadWidget, CmsSelectWidget, CmsTableGalleryWidget, 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.

方法概要

方法

限定符和类型	方法和说明
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.

从接口继承的方法 org.opencms.widgets.I_CmsWidget

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

方法详细资料

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.

参数:

cms - the OpenCms context

contentValue - the schema type

messages - the messages

resource - the edited resource

contentLocale - the content locale

返回:

the configuration string

getCssResourceLinks

java.util.List<java.lang.String> getCssResourceLinks(CmsObject cms)

Returns a list of CSS resources required by the widget.

参数:

cms - the current OpenCms context

返回:

the required CSS resource links

getDefaultDisplayType

I_CmsXmlContentHandler.DisplayType getDefaultDisplayType()

Returns the default display type of this widget.

返回:

the default display type

getInitCall

java.lang.String getInitCall()

Returns the java script initialization call.

返回:

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.

参数:

cms - the current OpenCms context

返回:

the required java script resource links

getWidgetName

java.lang.String getWidgetName()

Returns the class name of the widget.

返回:

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.

返回:

true if this is an internal widget