org.opencms.widgets

Class A_CmsHtmlGalleryWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsGalleryWidget

org.opencms.widgets.A_CmsHtmlGalleryWidget

All Implemented Interfaces:

I_CmsADEWidget, I_CmsWidget

Direct Known Subclasses:

CmsHtmlGalleryWidget, CmsTableGalleryWidget

public abstract class A_CmsHtmlGalleryWidget
extends A_CmsGalleryWidget

Base class for non-editable "HTML display only" widget implementations.

Since:

6.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_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	A_CmsHtmlGalleryWidget() Creates a new html gallery widget.
	A_CmsHtmlGalleryWidget(java.lang.String configuration) Creates a html gallery widget with the specified combo options.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
java.lang.String	getWidgetName() Returns the class name of the widget.
boolean	showPreview(java.lang.String value) Returns true if the preview button should be shown.

Methods inherited from class org.opencms.widgets.A_CmsGalleryWidget

getConfiguration, getCssResourceLinks, getDefaultDisplayType, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getInitCall, getJavaScriptResourceLinks, getNameLower, getNameUpper, isCompactViewEnabled, isInternal

Methods inherited from class org.opencms.widgets.A_CmsWidget

equals, getConfiguration, getDialogHtmlEnd, 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, getHelpBubble, getHelpText, getWidgetStringValue, newInstance, setConfiguration, setEditorValue

Constructor Detail

A_CmsHtmlGalleryWidget

public A_CmsHtmlGalleryWidget(java.lang.String configuration)

Creates a html gallery widget with the specified combo options.

Parameters:

configuration - the configuration (possible options) for the combo box

A_CmsHtmlGalleryWidget

protected A_CmsHtmlGalleryWidget()

Creates a new html gallery widget.

Method Detail

getDialogWidget

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

Specified by:

getDialogWidget in interface I_CmsWidget

Overrides:

getDialogWidget in class A_CmsGalleryWidget

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)

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_CmsGalleryWidget

Returns:

the class name

See Also:

I_CmsADEWidget.getWidgetName()

showPreview

public boolean showPreview(java.lang.String value)

Description copied from class: A_CmsGalleryWidget

Returns true if the preview button should be shown.

Specified by:

showPreview in class A_CmsGalleryWidget

Parameters:

value - the current widget value

Returns:

true if the preview button should be shown

See Also:

A_CmsGalleryWidget.showPreview(java.lang.String)