org.opencms.widgets

类 CmsVfsImageWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsAdeGalleryWidget

org.opencms.widgets.CmsAdeImageGalleryWidget

org.opencms.widgets.CmsVfsImageWidget

所有已实现的接口:

I_CmsADEWidget, I_CmsWidget

public class CmsVfsImageWidget
extends CmsAdeImageGalleryWidget

Provides a widget for an extended image selection using the advanced gallery dialog.

从以下版本开始:

7.5.0

嵌套类概要

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

A_CmsWidget.CmsDummyWidgetDialog

字段概要

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

PATH_GALLERY_JSP

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

HELP_POSTFIX, LABEL_PREFIX

构造器概要

构造器

构造器和说明
CmsVfsImageWidget() Creates a new image widget.
CmsVfsImageWidget(java.lang.String configuration) Creates an image widget with the specified configuration options.

方法概要

方法

限定符和类型	方法和说明
protected 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	getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the necessary JavaScript inclusion code for this widget.
java.lang.String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
protected java.util.Map<java.lang.String,java.lang.String>	getGalleryOpenParams(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param, java.lang.String resource, long hashId) Returns the required gallery open parameters.
protected java.lang.String	getSelectedValue(CmsObject cms, java.util.List<CmsSelectWidgetOption> selectOptions, java.lang.String currentValue) Returns the currently selected value of the select widget.
java.lang.String	getWidgetName() Returns the class name of the widget.
java.lang.String	getWidgetStringValue(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Returns the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget and the given widget dialog.
I_CmsWidget	newInstance() Creates a duplicate of this widget instance.
void	setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

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

getGalleryName, getGalleryTypes, getOpenPreviewCall, getWidgetConfiguration

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

getConfiguration, getCssResourceLinks, getDefaultDisplayType, getInitCall, getJavaScriptResourceLinks, getJSONConfig, getOpenGalleryCall, isCompactViewEnabled, isInternal

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

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

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

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

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

getConfiguration, getDialogHtmlEnd, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, setConfiguration

构造器详细资料

CmsVfsImageWidget

public CmsVfsImageWidget()

Creates a new image widget.

CmsVfsImageWidget

public CmsVfsImageWidget(java.lang.String configuration)

Creates an image widget with the specified configuration options.

参数:

configuration - the configuration (possible options) for the image widget

方法详细资料

getDialogIncludes

public java.lang.String getDialogIncludes(CmsObject cms,
                                 I_CmsWidgetDialog widgetDialog)

从接口复制的说明: I_CmsWidget

Generates the necessary JavaScript inclusion code for this widget.

指定者:

getDialogIncludes 在接口中 I_CmsWidget

覆盖:

getDialogIncludes 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

返回:

the JavaScript inclusion code

另请参阅:

I_CmsWidget.getDialogIncludes(org.opencms.file.CmsObject,org.opencms.widgets.I_CmsWidgetDialog)

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

覆盖:

getDialogWidget 在类中 A_CmsAdeGalleryWidget

参数:

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)

getWidgetName

public java.lang.String getWidgetName()

从接口复制的说明: I_CmsADEWidget

Returns the class name of the widget.

指定者:

getWidgetName 在接口中 I_CmsADEWidget

覆盖:

getWidgetName 在类中 CmsAdeImageGalleryWidget

返回:

the class name

另请参阅:

I_CmsADEWidget.getWidgetName()

getWidgetStringValue

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

从接口复制的说明: I_CmsWidget

Returns the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget and the given widget dialog.

指定者:

getWidgetStringValue 在接口中 I_CmsWidget

覆盖:

getWidgetStringValue 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

返回:

the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget

另请参阅:

A_CmsWidget.getWidgetStringValue(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

newInstance

public I_CmsWidget newInstance()

从接口复制的说明: I_CmsWidget

Creates a duplicate of this widget instance.

指定者:

newInstance 在接口中 I_CmsWidget

覆盖:

newInstance 在类中 CmsAdeImageGalleryWidget

返回:

a duplicate of this widget instance

另请参阅:

I_CmsWidget.newInstance()

setEditorValue

public void setEditorValue(CmsObject cms,
                  java.util.Map<java.lang.String,java.lang.String[]> formParameters,
                  I_CmsWidgetDialog widgetDialog,
                  I_CmsWidgetParameter param)

从接口复制的说明: I_CmsWidget

Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

指定者:

setEditorValue 在接口中 I_CmsWidget

覆盖:

setEditorValue 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

formParameters - the map of parameters to get the value from

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

另请参阅:

I_CmsWidget.setEditorValue(org.opencms.file.CmsObject, java.util.Map, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

getAdditionalGalleryInfo

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

从类复制的说明: A_CmsAdeGalleryWidget

Returns additional widget information encapsulated in a JSON object.

May be null.

覆盖:

getAdditionalGalleryInfo 在类中 CmsAdeImageGalleryWidget

参数:

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

另请参阅:

CmsAdeImageGalleryWidget.getAdditionalGalleryInfo(org.opencms.file.CmsObject, java.lang.String, org.opencms.i18n.CmsMessages, org.opencms.widgets.I_CmsWidgetParameter)

getGalleryOpenParams

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

从类复制的说明: A_CmsAdeGalleryWidget

Returns the required gallery open parameters.

覆盖:

getGalleryOpenParams 在类中 A_CmsAdeGalleryWidget

参数:

cms - an initialized instance of a CmsObject

widgetDialog - 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

另请参阅:

A_CmsAdeGalleryWidget.getGalleryOpenParams(org.opencms.file.CmsObject, org.opencms.i18n.CmsMessages, org.opencms.widgets.I_CmsWidgetParameter, java.lang.String, long)

getSelectedValue

protected java.lang.String getSelectedValue(CmsObject cms,
                                java.util.List<CmsSelectWidgetOption> selectOptions,
                                java.lang.String currentValue)

Returns the currently selected value of the select widget.

If a value is found in the given parameter, this is used. Otherwise the default value of the select options are used. If there is neither a parameter value nor a default value, null is returned.

参数:

cms - the current users OpenCms context

selectOptions - the available select options

currentValue - the current value that is selected

返回:

the currently selected value of the select widget