org.opencms.widgets
Class A_CmsAdeGalleryWidget

java.lang.Object
  org.opencms.widgets.A_CmsWidget
      org.opencms.widgets.A_CmsAdeGalleryWidget

All Implemented Interfaces:

I_CmsWidget

Direct Known Subclasses:

CmsAdeDownloadGalleryWidget, CmsAdeImageGalleryWidget

public abstract class A_CmsAdeGalleryWidget
extends A_CmsWidget

Base class for all ADE gallery widget implementations.

Since:

8.0.0

Nested Class Summary

static class

A_CmsAdeGalleryWidget.GALLERY_PARAM Enumeration of the gallery open parameters.

Field Summary

protected static String

PATH_GALLERY_JSP The gallery JSP path.

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

	A_CmsAdeGalleryWidget() Constructor.
protected	A_CmsAdeGalleryWidget(String configuration) Creates a new gallery widget with the given configuration.

Method Summary

protected abstract JSONObject	getAdditionalGalleryInfo(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Returns additional widget information encapsulated in a JSON object.
String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
abstract String	getGalleryName() Returns the lower case name of the gallery, for example "html".
protected Map<String,String>	getGalleryOpenParams(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param, long hashId) Returns the required gallery open parameters.
protected abstract String	getGalleryTypes() Returns the resource type names available within this gallery widget.
protected String	getOpenGalleryCall(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param, long hashId) Returns the javascript call to open the gallery widget dialog.
protected String	getOpenPreviewCall(I_CmsWidgetDialog widgetDialog, String id) Returns the javascript call to open the preview dialog.
protected CmsGalleryWidgetConfiguration	getWidgetConfiguration(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Returns the widget configuration.

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

newInstance

Field Detail

PATH_GALLERY_JSP

protected static final String PATH_GALLERY_JSP

The gallery JSP path.

See Also:

Constant Field Values

Constructor Detail

A_CmsAdeGalleryWidget

public A_CmsAdeGalleryWidget()

Constructor.

A_CmsAdeGalleryWidget

protected A_CmsAdeGalleryWidget(String configuration)

Creates a new gallery widget with the given configuration.

Parameters:

configuration - the configuration to use

Method Detail

getDialogWidget

public 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.

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)

getGalleryName

public abstract String getGalleryName()

Returns the lower case name of the gallery, for example "html".

Returns:

the lower case name of the gallery

getAdditionalGalleryInfo

protected abstract JSONObject getAdditionalGalleryInfo(CmsObject cms,
                                                       I_CmsWidgetDialog widgetDialog,
                                                       I_CmsWidgetParameter param)
                                                throws JSONException

Returns additional widget information encapsulated in a JSON object.

May be null.

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:

additional widget information

Throws:

JSONException - if something goes wrong generating the JSON object

getGalleryOpenParams

protected Map<String,String> getGalleryOpenParams(CmsObject cms,
                                                  I_CmsWidgetDialog widgetDialog,
                                                  I_CmsWidgetParameter param,
                                                  long hashId)

Returns the required gallery open parameters.

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

hashId - the field id hash

Returns:

the gallery open parameters

getGalleryTypes

protected abstract String getGalleryTypes()

Returns the resource type names available within this gallery widget.

Returns:

the resource type names

getOpenGalleryCall

protected String getOpenGalleryCall(CmsObject cms,
                                    I_CmsWidgetDialog widgetDialog,
                                    I_CmsWidgetParameter param,
                                    long hashId)

Returns the javascript call to open the gallery widget dialog.

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

hashId - the field id hash

Returns:

the javascript call to open the gallery widget dialog

getOpenPreviewCall

protected String getOpenPreviewCall(I_CmsWidgetDialog widgetDialog,
                                    String id)

Returns the javascript call to open the preview dialog.

Parameters:

widgetDialog - the dialog where the widget is used on

id - the field id

Returns:

the javascript call to open the preview dialog

getWidgetConfiguration

protected CmsGalleryWidgetConfiguration getWidgetConfiguration(CmsObject cms,
                                                               I_CmsWidgetDialog widgetDialog,
                                                               I_CmsWidgetParameter param)

Returns the widget configuration.

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 configuration