Package 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_CmsADEWidget
,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
for a description about the configuration String syntax for the select options.CmsSelectWidgetOption
The multi select widget does use the following select options:
for the value of the optionCmsSelectWidgetOption.getValue()
for pre-selecting a specific valueCmsSelectWidgetOption.isDefault()
for the display name of the optionCmsSelectWidgetOption.getOption()
- Since:
- 6.9.1
-
-
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 Description CmsRadioSelectWidget()
Creates a new select widget.CmsRadioSelectWidget(java.lang.String configuration)
Creates a select widget with the specified select options.CmsRadioSelectWidget(java.util.List<CmsSelectWidgetOption> configuration)
Creates a select widget with the select options specified in the given configuration List.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description I_CmsXmlContentHandler.DisplayType
getDefaultDisplayType()
Returns the default display type of this widget.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.I_CmsWidget
newInstance()
Creates a duplicate of this widget instance.-
Methods inherited from class org.opencms.widgets.A_CmsSelectWidget
addSelectOption, getConfiguration, getConfiguration, getCssResourceLinks, 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, getWidgetStringValue, 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, getWidgetStringValue, isCompactViewEnabled, setEditorValue
-
-
-
-
Constructor Detail
-
CmsRadioSelectWidget
public CmsRadioSelectWidget()
Creates a new select widget.
-
CmsRadioSelectWidget
public CmsRadioSelectWidget(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
-
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
-
getDefaultDisplayType
public I_CmsXmlContentHandler.DisplayType getDefaultDisplayType()
Description copied from interface:I_CmsADEWidget
Returns the default display type of this widget.- Specified by:
getDefaultDisplayType
in interfaceI_CmsADEWidget
- Overrides:
getDefaultDisplayType
in classA_CmsSelectWidget
- Returns:
- the default display type
- See Also:
I_CmsADEWidget.getDefaultDisplayType()
-
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 CmsObjectwidgetDialog
- the dialog where the widget is used onparam
- 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 interfaceI_CmsADEWidget
- Overrides:
getWidgetName
in classA_CmsSelectWidget
- Returns:
- the class name
- See Also:
I_CmsADEWidget.getWidgetName()
-
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()
-
-