Package org.opencms.widgets
Class CmsAdeImageGalleryWidget
- java.lang.Object
-
- org.opencms.widgets.A_CmsWidget
-
- org.opencms.widgets.A_CmsAdeGalleryWidget
-
- org.opencms.widgets.CmsAdeImageGalleryWidget
-
- All Implemented Interfaces:
I_CmsADEWidget
,I_CmsWidget
- Direct Known Subclasses:
CmsVfsImageWidget
public class CmsAdeImageGalleryWidget extends A_CmsAdeGalleryWidget
ADE image gallery widget implementations.- Since:
- 8.0.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 Modifier Constructor Description CmsAdeImageGalleryWidget()
Constructor.protected
CmsAdeImageGalleryWidget(java.lang.String configuration)
Creates a new gallery widget with the given configuration.
-
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
getGalleryName()
Returns the lower case name of the gallery, for example"html"
.protected java.lang.String
getGalleryStoragePrefix()
Gets the prefix for the key used to store the last selected gallery.protected java.lang.String
getGalleryTypes()
Returns the resource type names available within this gallery widget.protected java.lang.String
getOpenPreviewCall(I_CmsWidgetDialog widgetDialog, java.lang.String id)
Returns the javascript call to open the preview dialog.protected CmsVfsImageWidgetConfiguration
getWidgetConfiguration(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param)
Returns the widget configuration.java.lang.String
getWidgetName()
Returns the class name of the widget.I_CmsWidget
newInstance()
Creates a duplicate of this widget instance.-
Methods inherited from class org.opencms.widgets.A_CmsAdeGalleryWidget
getConfiguration, getCssResourceLinks, getDefaultDisplayType, getDialogWidget, getGalleryOpenParams, getInitCall, getJavaScriptResourceLinks, getJSONConfig, getOpenGalleryCall, isCompactViewEnabled, isInternal
-
Methods inherited from class org.opencms.widgets.A_CmsWidget
equals, getConfiguration, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, hashCode, setConfiguration, setEditorValue
-
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, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, getWidgetStringValue, setConfiguration, setEditorValue
-
-
-
-
Constructor Detail
-
CmsAdeImageGalleryWidget
public CmsAdeImageGalleryWidget()
Constructor.
-
CmsAdeImageGalleryWidget
protected CmsAdeImageGalleryWidget(java.lang.String configuration)
Creates a new gallery widget with the given configuration.- Parameters:
configuration
- the configuration to use
-
-
Method Detail
-
getGalleryName
public java.lang.String getGalleryName()
Description copied from class:A_CmsAdeGalleryWidget
Returns the lower case name of the gallery, for example"html"
.- Specified by:
getGalleryName
in classA_CmsAdeGalleryWidget
- Returns:
- the lower case name of the gallery
- See Also:
A_CmsAdeGalleryWidget.getGalleryName()
-
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 classA_CmsAdeGalleryWidget
- Returns:
- the class name
- See Also:
I_CmsADEWidget.getWidgetName()
-
newInstance
public I_CmsWidget newInstance()
Description copied from interface:I_CmsWidget
Creates a duplicate of this widget instance.- Returns:
- a duplicate of this widget instance
- See Also:
I_CmsWidget.newInstance()
-
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
.- Specified by:
getAdditionalGalleryInfo
in classA_CmsAdeGalleryWidget
- 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:
A_CmsAdeGalleryWidget.getAdditionalGalleryInfo(org.opencms.file.CmsObject, java.lang.String, org.opencms.i18n.CmsMessages, org.opencms.widgets.I_CmsWidgetParameter)
-
getGalleryStoragePrefix
protected java.lang.String getGalleryStoragePrefix()
Description copied from class:A_CmsAdeGalleryWidget
Gets the prefix for the key used to store the last selected gallery.- Overrides:
getGalleryStoragePrefix
in classA_CmsAdeGalleryWidget
- Returns:
- the key prefix
- See Also:
A_CmsAdeGalleryWidget.getGalleryStoragePrefix()
-
getGalleryTypes
protected java.lang.String getGalleryTypes()
Description copied from class:A_CmsAdeGalleryWidget
Returns the resource type names available within this gallery widget.- Specified by:
getGalleryTypes
in classA_CmsAdeGalleryWidget
- Returns:
- the resource type names
- See Also:
A_CmsAdeGalleryWidget.getGalleryTypes()
-
getOpenPreviewCall
protected java.lang.String getOpenPreviewCall(I_CmsWidgetDialog widgetDialog, java.lang.String id)
Description copied from class:A_CmsAdeGalleryWidget
Returns the javascript call to open the preview dialog.- Overrides:
getOpenPreviewCall
in classA_CmsAdeGalleryWidget
- Parameters:
widgetDialog
- the dialog where the widget is used onid
- the field id- Returns:
- the javascript call to open the preview dialog
- See Also:
A_CmsAdeGalleryWidget.getOpenPreviewCall(org.opencms.widgets.I_CmsWidgetDialog, java.lang.String)
-
getWidgetConfiguration
protected CmsVfsImageWidgetConfiguration getWidgetConfiguration(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param)
Description copied from class:A_CmsAdeGalleryWidget
Returns the widget configuration.- Overrides:
getWidgetConfiguration
in classA_CmsAdeGalleryWidget
- Parameters:
cms
- an initialized instance of a CmsObjectmessages
- the dialog where the widget is used onparam
- the widget parameter to generate the widget for- Returns:
- the widget configuration
- See Also:
A_CmsAdeGalleryWidget.getWidgetConfiguration(org.opencms.file.CmsObject, org.opencms.i18n.CmsMessages, org.opencms.widgets.I_CmsWidgetParameter)
-
-