org.opencms.widgets
Class CmsAdeDownloadGalleryWidget

java.lang.Object
  extended by org.opencms.widgets.A_CmsWidget
      extended by org.opencms.widgets.A_CmsAdeGalleryWidget
          extended by org.opencms.widgets.CmsAdeDownloadGalleryWidget
All Implemented Interfaces:
I_CmsADEWidget, I_CmsWidget

public class CmsAdeDownloadGalleryWidget
extends A_CmsAdeGalleryWidget

ADE download 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
  CmsAdeDownloadGalleryWidget()
          Constructor.
protected CmsAdeDownloadGalleryWidget(java.lang.String configuration)
          Creates a new gallery widget with the given configuration.
 
Method Summary
protected  JSONObject getAdditionalGalleryInfo(CmsObject cms, 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 getGalleryTypes()
          Returns the resource type names available within this gallery widget.
 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, getDialogWidget, getGalleryOpenParams, getInitCall, getJavaScriptResourceLinks, getJSONConfig, getOpenGalleryCall, getOpenPreviewCall, getWidgetConfiguration, 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

CmsAdeDownloadGalleryWidget

public CmsAdeDownloadGalleryWidget()
Constructor.


CmsAdeDownloadGalleryWidget

protected CmsAdeDownloadGalleryWidget(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 class A_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 interface I_CmsADEWidget
Overrides:
getWidgetName in class A_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,
                                              CmsMessages messages,
                                              I_CmsWidgetParameter param)
Description copied from class: A_CmsAdeGalleryWidget
Returns additional widget information encapsulated in a JSON object.

May be null.

Specified by:
getAdditionalGalleryInfo in class A_CmsAdeGalleryWidget
Parameters:
cms - an initialized instance of a CmsObject
messages - the dialog messages
param - the widget parameter to generate the widget for
Returns:
additional widget information
See Also:
A_CmsAdeGalleryWidget.getAdditionalGalleryInfo(org.opencms.file.CmsObject, org.opencms.i18n.CmsMessages, org.opencms.widgets.I_CmsWidgetParameter)

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 class A_CmsAdeGalleryWidget
Returns:
the resource type names
See Also:
A_CmsAdeGalleryWidget.getGalleryTypes()