org.opencms.widgets
Class CmsRadioSelectWidget

java.lang.Object
  org.opencms.widgets.A_CmsWidget
      org.opencms.widgets.A_CmsSelectWidget
          org.opencms.widgets.CmsRadioSelectWidget

All Implemented Interfaces:

I_CmsWidget

public class CmsRadioSelectWidget
extends A_CmsSelectWidget

Provides a widget for a standard HTML form for a group of radio buttons.

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

The multi select widget does use the following select options:

• CmsSelectWidgetOption.getValue() for the value of the option
• CmsSelectWidgetOption.isDefault() for pre-selecting a specific value
• CmsSelectWidgetOption.getOption() for the display name of the option

Since:

6.9.1

Version:

$Revision: 1.6 $

Author:

Peter Bonrad

Field Summary

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

CmsRadioSelectWidget()
Creates a new select widget.

CmsRadioSelectWidget(java.util.List configuration)
Creates a select widget with the select options specified in the given configuration List.

CmsRadioSelectWidget(java.lang.String configuration)
Creates a select widget with the specified select options.

Method Summary

java.lang.String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
I_CmsWidget	newInstance() Creates a duplicate of this widget instance.

Methods inherited from class org.opencms.widgets.A_CmsSelectWidget

addSelectOption, getConfiguration, getSelectedValue, getSelectedValues, getSelectOptions, parseSelectOptions, setSelectOptions

Methods inherited from class org.opencms.widgets.A_CmsWidget

equals, 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

CmsRadioSelectWidget

public CmsRadioSelectWidget()

Creates a new select widget.

CmsRadioSelectWidget

public CmsRadioSelectWidget(java.util.List 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

CmsRadioSelectWidget

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

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)

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