Package 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 Description CmsVfsImageWidget()
Creates a new image widget.CmsVfsImageWidget(java.lang.String configuration)
Creates an image widget with the specified configuration options.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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
processed according to the output rules of this widget and the given widget dialog.I_CmsWidgetParameter.getStringValue(CmsObject)
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 interfaceI_CmsWidget
- Overrides:
getDialogIncludes
in classA_CmsWidget
- Parameters:
cms
- the current users OpenCms contextwidgetDialog
- 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 interfaceI_CmsWidget
- Overrides:
getDialogWidget
in classA_CmsAdeGalleryWidget
- Parameters:
cms
- an initialized instance of a CmsObjectwidgetDialog
- the dialog where the widget is used onparam
- 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 interfaceI_CmsADEWidget
- Overrides:
getWidgetName
in classCmsAdeImageGalleryWidget
- 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
processed according to the output rules of this widget and the given widget dialog.I_CmsWidgetParameter.getStringValue(CmsObject)
- Specified by:
getWidgetStringValue
in interfaceI_CmsWidget
- Overrides:
getWidgetStringValue
in classA_CmsWidget
- Parameters:
cms
- the current users OpenCms contextwidgetDialog
- the dialog where the widget is used onparam
- the widget parameter to generate the widget for- Returns:
- the
processed according to the output rules of this widgetI_CmsWidgetParameter.getStringValue(CmsObject)
- 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 interfaceI_CmsWidget
- Overrides:
newInstance
in classCmsAdeImageGalleryWidget
- 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 interfaceI_CmsWidget
- Overrides:
setEditorValue
in classA_CmsWidget
- Parameters:
cms
- the current users OpenCms contextformParameters
- the map of parameters to get the value fromwidgetDialog
- the dialog where the widget is used onparam
- 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 classCmsAdeImageGalleryWidget
- Parameters:
cms
- an initialized instance of a CmsObjectresource
- the edited resourcemessages
- the dialog messagesparam
- 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 classA_CmsAdeGalleryWidget
- Parameters:
cms
- an initialized instance of a CmsObjectwidgetDialog
- the dialog messagesparam
- the widget parameter to generate the widget forresource
- the resource being editedhashId
- 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 contextselectOptions
- the available select optionscurrentValue
- the current value that is selected- Returns:
- the currently selected value of the select widget
-
-