org.opencms.widgets

Class CmsSelectOnChangeReloadWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsSelectWidget

org.opencms.widgets.CmsSelectWidget

org.opencms.widgets.CmsSelectOnChangeReloadWidget

All Implemented Interfaces:

I_CmsADEWidget, I_CmsWidget

public class CmsSelectOnChangeReloadWidget
extends CmsSelectWidget

Provides a widget for a standard HTML form select box with. The jsp where this widget is used is reloaded, when the select box value is changed.

Please see the documentation of CmsSelectWidgetOption for a description about the configuration String syntax for the select options.

The select widget does use the following select options:

• CmsSelectWidgetOption.getValue() for the value of the HTML select box
• CmsSelectWidgetOption.isDefault() for pre-selecting a specific value
• CmsSelectWidgetOption.getOption() for the option of the HTML select box

Since:

7.5.3

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_CmsSelectWidget

CONFIGURATION_HEIGHT

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

Constructors

Constructor and Description
CmsSelectOnChangeReloadWidget() Creates a new select widget.
CmsSelectOnChangeReloadWidget(java.util.List<CmsSelectWidgetOption> configuration) Creates a select widget with the select options specified in the given configuration List.
CmsSelectOnChangeReloadWidget(java.lang.String configuration) Creates a select widget with the specified select options.

Method Summary

Methods

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.

Methods inherited from class org.opencms.widgets.CmsSelectWidget

getWidgetName, getWidgetStringValue, newInstance

Methods inherited from class org.opencms.widgets.A_CmsSelectWidget

addSelectOption, getConfiguration, getConfiguration, getCssResourceLinks, getDefaultDisplayType, getHeight, getInitCall, getJavaScriptResourceLinks, getResourcePath, getSelectedValue, getSelectedValues, getSelectOptions, isInternal, parseSelectOptions, setConfiguration, setSelectOptions

Methods inherited from class org.opencms.widgets.A_CmsWidget

equals, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, hashCode, isCompactViewEnabled, 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

getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, isCompactViewEnabled, setEditorValue

Constructor Detail

CmsSelectOnChangeReloadWidget

public CmsSelectOnChangeReloadWidget()

Creates a new select widget.

CmsSelectOnChangeReloadWidget

public CmsSelectOnChangeReloadWidget(java.util.List<CmsSelectWidgetOption> configuration)

Creates a select widget with the select options specified in the given configuration List.

The list elements must be of type CmsSelectWidgetOption.

Parameters:

configuration - the configuration (possible options) for the select widget

See Also:

CmsSelectWidgetOption

CmsSelectOnChangeReloadWidget

public CmsSelectOnChangeReloadWidget(java.lang.String configuration)

Creates a select widget with the specified select options.

Parameters:

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

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 CmsSelectWidget

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)