org.opencms.widgets

Class CmsVfsImageWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsAdeGalleryWidget

org.opencms.widgets.CmsAdeImageGalleryWidget

org.opencms.widgets.CmsVfsImageWidget

All Implemented Interfaces:

I_CmsADEWidget, I_CmsWidget

public class CmsVfsImageWidget
extends CmsAdeImageGalleryWidget

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

Since:

7.5.0

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.widgets.A_CmsWidget

A_CmsWidget.CmsDummyWidgetDialog

Field Summary

Fields inherited from class org.opencms.widgets.A_CmsAdeGalleryWidget

PATH_GALLERY_JSP

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

Constructors

Constructor and Description
CmsVfsImageWidget() Creates a new image widget.
CmsVfsImageWidget(java.lang.String configuration) Creates an image widget with the specified configuration options.

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class org.opencms.widgets.CmsAdeImageGalleryWidget

getGalleryName, getGalleryStoragePrefix, getGalleryTypes, getOpenPreviewCall, getWidgetConfiguration

Methods inherited from class org.opencms.widgets.A_CmsAdeGalleryWidget

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

Methods inherited from class org.opencms.widgets.A_CmsWidget

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.widgets.I_CmsWidget

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

Constructor Detail

CmsVfsImageWidget

public CmsVfsImageWidget()

Creates a new image widget.

CmsVfsImageWidget

public CmsVfsImageWidget(java.lang.String configuration)

Creates an image widget with the specified configuration options.

Parameters:

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

Method Detail

getDialogIncludes

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

Description copied from interface: I_CmsWidget

Generates the necessary JavaScript inclusion code for this widget.

Specified by:

getDialogIncludes in interface I_CmsWidget

Overrides:

getDialogIncludes in class A_CmsWidget

Parameters:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

Returns:

the JavaScript inclusion code

See Also:

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)

Description copied from interface: I_CmsWidget

Generates the widget HTML for the provided widget parameter.

Specified by:

getDialogWidget in interface I_CmsWidget

Overrides:

getDialogWidget in class A_CmsAdeGalleryWidget

Parameters:

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

Returns:

the widget HTML for the provided widget parameter

See Also:

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

getWidgetName

public java.lang.String getWidgetName()

Description copied from interface: I_CmsADEWidget

Returns the class name of the widget.

Specified by:

getWidgetName in interface I_CmsADEWidget

Overrides:

getWidgetName in class CmsAdeImageGalleryWidget

Returns:

the class name

See Also:

I_CmsADEWidget.getWidgetName()

getWidgetStringValue

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

Description copied from interface: I_CmsWidget

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

Specified by:

getWidgetStringValue in interface I_CmsWidget

Overrides:

getWidgetStringValue in class A_CmsWidget

Parameters:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

Returns:

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

See Also:

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

newInstance

public I_CmsWidget newInstance()

Description copied from interface: I_CmsWidget

Creates a duplicate of this widget instance.

Specified by:

newInstance in interface I_CmsWidget

Overrides:

newInstance in class CmsAdeImageGalleryWidget

Returns:

a duplicate of this widget instance

See Also:

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)

Description copied from interface: I_CmsWidget

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

Specified by:

setEditorValue in interface I_CmsWidget

Overrides:

setEditorValue in class A_CmsWidget

Parameters:

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

See Also:

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

Description copied from class: A_CmsAdeGalleryWidget

Returns additional widget information encapsulated in a JSON object.

May be null.

Overrides:

getAdditionalGalleryInfo in class CmsAdeImageGalleryWidget

Parameters:

cms - an initialized instance of a CmsObject

resource - the edited resource

messages - the dialog messages

param - the widget parameter to generate the widget for

Returns:

additional widget information

Throws:

JSONException - if something goes wrong generating the JSON object

See Also:

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)

Description copied from class: A_CmsAdeGalleryWidget

Returns the required gallery open parameters.

Overrides:

getGalleryOpenParams in class A_CmsAdeGalleryWidget

Parameters:

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

Returns:

the gallery open parameters

See Also:

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.

Parameters:

cms - the current users OpenCms context

selectOptions - the available select options

currentValue - the current value that is selected

Returns:

the currently selected value of the select widget