org.opencms.widgets
Class CmsAdeImageGalleryWidget

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

public class CmsAdeImageGalleryWidget
extends A_CmsAdeGalleryWidget

ADE image gallery widget implementations.

Since:
8.0.0

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
  CmsAdeImageGalleryWidget()
          Constructor.
protected CmsAdeImageGalleryWidget(java.lang.String configuration)
          Creates a new gallery widget with the given configuration.
 
Method Summary
protected  JSONObject getAdditionalGalleryInfo(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param, java.lang.String configurationParam)
          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.
protected  java.lang.String getOpenPreviewCall(I_CmsWidgetDialog widgetDialog, java.lang.String id)
          Returns the javascript call to open the preview dialog.
 I_CmsWidget newInstance()
          Creates a duplicate of this widget instance.
 
Methods inherited from class org.opencms.widgets.A_CmsAdeGalleryWidget
getDialogWidget, getOpenGalleryCall
 
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
 

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 class A_CmsAdeGalleryWidget
Returns:
the lower case name of the gallery
See Also:
A_CmsAdeGalleryWidget.getGalleryName()

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,
                                              I_CmsWidgetDialog widgetDialog,
                                              I_CmsWidgetParameter param,
                                              java.lang.String configurationParam)
                                       throws JSONException
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
widgetDialog - the dialog where the widget is used on
param - the widget parameter to generate the widget for
configurationParam - the widget configuration string
Returns:
additional widget information
Throws:
JSONException
See Also:
A_CmsAdeGalleryWidget.getAdditionalGalleryInfo(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter, java.lang.String)

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()

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 class A_CmsAdeGalleryWidget
Parameters:
widgetDialog - the dialog where the widget is used on
id - 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)