org.opencms.widgets

类 A_CmsAdeGalleryWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsAdeGalleryWidget

所有已实现的接口:

I_CmsADEWidget, I_CmsWidget

直接已知子类:

CmsAdeDownloadGalleryWidget, CmsAdeImageGalleryWidget

public abstract class A_CmsAdeGalleryWidget
extends A_CmsWidget
implements I_CmsADEWidget

Base class for all ADE gallery widget implementations.

从以下版本开始:

8.0.0

嵌套类概要

从类继承的嵌套类/接口 org.opencms.widgets.A_CmsWidget

A_CmsWidget.CmsDummyWidgetDialog

字段概要

字段

限定符和类型	字段和说明
protected static java.lang.String	PATH_GALLERY_JSP The gallery JSP path.

从类继承的字段 org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

构造器概要

构造器

限定符	构造器和说明
	A_CmsAdeGalleryWidget() Constructor.
protected	A_CmsAdeGalleryWidget(java.lang.String configuration) Creates a new gallery widget with the given configuration.

方法概要

方法

限定符和类型	方法和说明
protected abstract JSONObject	getAdditionalGalleryInfo(CmsObject cms, java.lang.String resource, CmsMessages messages, I_CmsWidgetParameter param) Returns additional widget information encapsulated in a JSON object.
java.lang.String	getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, 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	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
abstract java.lang.String	getGalleryName() Returns the lower case name of the gallery, for example "html".
protected java.util.Map<java.lang.String,java.lang.String>	getGalleryOpenParams(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param, java.lang.String resource, long hashId) Returns the required gallery open parameters.
protected abstract java.lang.String	getGalleryTypes() Returns the resource type names available within this gallery 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.
protected JSONObject	getJSONConfig(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale) Returns the gallery widget configuration as a JSON object.
protected java.lang.String	getOpenGalleryCall(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param, long hashId) Returns the javascript call to open the gallery widget dialog.
protected java.lang.String	getOpenPreviewCall(I_CmsWidgetDialog widgetDialog, java.lang.String id) Returns the javascript call to open the preview dialog.
protected CmsGalleryWidgetConfiguration	getWidgetConfiguration(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param) Returns the widget configuration.
java.lang.String	getWidgetName() Returns the class name of the widget.
boolean	isCompactViewEnabled() Returns if the widget is compact view enabled.
boolean	isInternal() Returns if this is an internal widget.

从类继承的方法 org.opencms.widgets.A_CmsWidget

equals, getConfiguration, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, hashCode, setConfiguration, setEditorValue

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

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

字段详细资料

PATH_GALLERY_JSP

protected static final java.lang.String PATH_GALLERY_JSP

The gallery JSP path.

另请参阅:

常量字段值

构造器详细资料

A_CmsAdeGalleryWidget

public A_CmsAdeGalleryWidget()

Constructor.

A_CmsAdeGalleryWidget

protected A_CmsAdeGalleryWidget(java.lang.String configuration)

Creates a new gallery widget with the given configuration.

参数:

configuration - the configuration to use

方法详细资料

getConfiguration

public java.lang.String getConfiguration(CmsObject cms,
                                A_CmsXmlContentValue schemaType,
                                CmsMessages messages,
                                CmsResource resource,
                                java.util.Locale contentLocale)

从接口复制的说明: I_CmsADEWidget

Returns the configuration string for the ADE content editor widget.

指定者:

getConfiguration 在接口中 I_CmsADEWidget

参数:

cms - the OpenCms context

schemaType - the schema type

messages - the messages

resource - the edited resource

contentLocale - the content locale

返回:

the configuration string

另请参阅:

I_CmsADEWidget.getConfiguration(org.opencms.file.CmsObject, org.opencms.xml.types.A_CmsXmlContentValue, org.opencms.i18n.CmsMessages, org.opencms.file.CmsResource, java.util.Locale)

getCssResourceLinks

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

从接口复制的说明: I_CmsADEWidget

Returns a list of CSS resources required by the widget.

指定者:

getCssResourceLinks 在接口中 I_CmsADEWidget

参数:

cms - the current OpenCms context

返回:

the required CSS resource links

另请参阅:

I_CmsADEWidget.getCssResourceLinks(org.opencms.file.CmsObject)

getDefaultDisplayType

public I_CmsXmlContentHandler.DisplayType getDefaultDisplayType()

从接口复制的说明: I_CmsADEWidget

Returns the default display type of this widget.

指定者:

getDefaultDisplayType 在接口中 I_CmsADEWidget

返回:

the default display type

另请参阅:

I_CmsADEWidget.getDefaultDisplayType()

getDialogWidget

public java.lang.String getDialogWidget(CmsObject cms,
                               I_CmsWidgetDialog widgetDialog,
                               I_CmsWidgetParameter param)

从接口复制的说明: I_CmsWidget

Generates the widget HTML for the provided widget parameter.

指定者:

getDialogWidget 在接口中 I_CmsWidget

参数:

cms - an initialized instance of a CmsObject

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

返回:

the widget HTML for the provided widget parameter

另请参阅:

I_CmsWidget.getDialogWidget(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

getGalleryName

public abstract java.lang.String getGalleryName()

Returns the lower case name of the gallery, for example "html".

返回:

the lower case name of the gallery

getInitCall

public java.lang.String getInitCall()

从接口复制的说明: I_CmsADEWidget

Returns the java script initialization call.

指定者:

getInitCall 在接口中 I_CmsADEWidget

返回:

the java script initialization call

另请参阅:

I_CmsADEWidget.getInitCall()

getJavaScriptResourceLinks

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

从接口复制的说明: I_CmsADEWidget

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

指定者:

getJavaScriptResourceLinks 在接口中 I_CmsADEWidget

参数:

cms - the current OpenCms context

返回:

the required java script resource links

另请参阅:

I_CmsADEWidget.getJavaScriptResourceLinks(org.opencms.file.CmsObject)

getWidgetName

public java.lang.String getWidgetName()

从接口复制的说明: I_CmsADEWidget

Returns the class name of the widget.

指定者:

getWidgetName 在接口中 I_CmsADEWidget

返回:

the class name

另请参阅:

I_CmsADEWidget.getWidgetName()

isCompactViewEnabled

public boolean isCompactViewEnabled()

从接口复制的说明: I_CmsWidget

Returns if the widget is compact view enabled.

指定者:

isCompactViewEnabled 在接口中 I_CmsWidget

覆盖:

isCompactViewEnabled 在类中 A_CmsWidget

返回:

true if the widget is compact view enabled

另请参阅:

A_CmsWidget.isCompactViewEnabled()

isInternal

public boolean isInternal()

从接口复制的说明: I_CmsADEWidget

Returns if this is an internal widget.

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

指定者:

isInternal 在接口中 I_CmsADEWidget

返回:

true if this is an internal widget

另请参阅:

I_CmsADEWidget.isInternal()

getAdditionalGalleryInfo

protected abstract JSONObject getAdditionalGalleryInfo(CmsObject cms,
                                  java.lang.String resource,
                                  CmsMessages messages,
                                  I_CmsWidgetParameter param)
                                                throws JSONException

Returns additional widget information encapsulated in a JSON object.

May be null.

参数:

cms - an initialized instance of a CmsObject

resource - the edited resource

messages - the dialog messages

param - the widget parameter to generate the widget for

返回:

additional widget information

抛出:

JSONException - if something goes wrong generating the JSON object

getGalleryOpenParams

protected java.util.Map<java.lang.String,java.lang.String> getGalleryOpenParams(CmsObject cms,
                                                                    CmsMessages messages,
                                                                    I_CmsWidgetParameter param,
                                                                    java.lang.String resource,
                                                                    long hashId)

Returns the required gallery open parameters.

参数:

cms - an initialized instance of a CmsObject

messages - the dialog messages

param - the widget parameter to generate the widget for

resource - the resource being edited

hashId - the field id hash

返回:

the gallery open parameters

getGalleryTypes

protected abstract java.lang.String getGalleryTypes()

Returns the resource type names available within this gallery widget.

返回:

the resource type names

getJSONConfig

protected JSONObject getJSONConfig(CmsObject cms,
                       A_CmsXmlContentValue schemaType,
                       CmsMessages messages,
                       CmsResource resource,
                       java.util.Locale contentLocale)

Returns the gallery widget configuration as a JSON object.

参数:

cms - the cms context

schemaType - the schema type

messages - the messages

resource - the edited resource

contentLocale - the content locale

返回:

the gallery widget configuration

getOpenGalleryCall

protected java.lang.String getOpenGalleryCall(CmsObject cms,
                                  I_CmsWidgetDialog widgetDialog,
                                  I_CmsWidgetParameter param,
                                  long hashId)

Returns the javascript call to open the gallery widget dialog.

参数:

cms - an initialized instance of a CmsObject

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

hashId - the field id hash

返回:

the javascript call to open the gallery widget dialog

getOpenPreviewCall

protected java.lang.String getOpenPreviewCall(I_CmsWidgetDialog widgetDialog,
                                  java.lang.String id)

Returns the javascript call to open the preview dialog.

参数:

widgetDialog - the dialog where the widget is used on

id - the field id

返回:

the javascript call to open the preview dialog

getWidgetConfiguration

protected CmsGalleryWidgetConfiguration getWidgetConfiguration(CmsObject cms,
                                                   CmsMessages messages,
                                                   I_CmsWidgetParameter param)

Returns the widget configuration.

参数:

cms - an initialized instance of a CmsObject

messages - the dialog where the widget is used on

param - the widget parameter to generate the widget for

返回:

the widget configuration