org.opencms.widgets
Class A_CmsGalleryWidget

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

All Implemented Interfaces:

I_CmsWidget

Direct Known Subclasses:

A_CmsHtmlGalleryWidget, CmsDownloadGalleryWidget, CmsImageGalleryWidget, CmsLinkGalleryWidget

public abstract class A_CmsGalleryWidget
extends A_CmsWidget

Base class for all gallery widget implementations.

Since:

6.0.0

Version:

$Revision: 1.8 $

Author:

Alexander Kandzior, Andreas Zahner

Constructor Summary

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

Method Summary

String	getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the necessary JavaScript inclusion code for this widget.
String	getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the initialisation method JavaScript code for this widget.
String	getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the initialization method JavaScript code for this widget.
String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
abstract String	getNameLower() Returns the lower case name of the gallery, for example "html".
abstract String	getNameUpper() Returns the upper case name of the gallery, for example "Html".
abstract boolean	showPreview(String value) Returns true if the preview button should be shown.

Methods inherited from class org.opencms.widgets.A_CmsWidget

equals, getConfiguration, getDialogHtmlEnd, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, 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

Constructor Detail

A_CmsGalleryWidget

protected A_CmsGalleryWidget()

Creates a new gallery widget.

A_CmsGalleryWidget

protected A_CmsGalleryWidget(String configuration)

Creates a new gallery widget with the given configuration.

Parameters:

configuration - the configuration to use

Method Detail

getDialogIncludes

public 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 interface I_CmsWidget

Overrides:

getDialogIncludes in class A_CmsWidget

Parameters:

cms - the current users OpenCms context

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

getDialogInitCall

public String getDialogInitCall(CmsObject cms,
                                I_CmsWidgetDialog widgetDialog)

Description copied from interface: I_CmsWidget

Generates the initialisation method JavaScript code for this widget.

Specified by:

getDialogInitCall in interface I_CmsWidget

Overrides:

getDialogInitCall in class A_CmsWidget

Parameters:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

Returns:

the initialisation method JavaScript code

See Also:

I_CmsWidget.getDialogInitCall(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)

getDialogInitMethod

public String getDialogInitMethod(CmsObject cms,
                                  I_CmsWidgetDialog widgetDialog)

Description copied from interface: I_CmsWidget

Generates the initialization method JavaScript code for this widget.

Specified by:

getDialogInitMethod in interface I_CmsWidget

Overrides:

getDialogInitMethod in class A_CmsWidget

Parameters:

cms - an initialized instance of a CmsObject

widgetDialog - the dialog where the widget is used on

Returns:

the initialization method JavaScript code

See Also:

I_CmsWidget.getDialogInitMethod(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)

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)

getNameLower

public abstract String getNameLower()

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

Returns:

the lower case name of the gallery

getNameUpper

public abstract String getNameUpper()

Returns the upper case name of the gallery, for example "Html".

Returns:

the upper case name of the gallery

showPreview

public abstract boolean showPreview(String value)

Returns true if the preview button should be shown.

Parameters:

value - the current widget value

Returns:

true if the preview button should be shown