org.opencms.widgets
Class CmsMultiSelectWidget

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

All Implemented Interfaces:

I_CmsWidget

public class CmsMultiSelectWidget
extends A_CmsSelectWidget

Provides a widget for a standard HTML form multi select list or a group of check boxes.

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.0.0

Field Summary

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

CmsMultiSelectWidget()
Creates a new select widget.

CmsMultiSelectWidget(List<CmsSelectWidgetOption> configuration)
Creates a select widget with the select options specified in the given configuration List.

CmsMultiSelectWidget(List<CmsSelectWidgetOption> configuration, boolean asCheckboxes)
Creates a select widget with the select options specified in the given configuration List.

CmsMultiSelectWidget(String configuration)
Creates a select widget with the specified select options.

Method Summary

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.
void	setEditorValue(CmsObject cms, Map<String,String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CmsMultiSelectWidget

public CmsMultiSelectWidget()

Creates a new select widget.

CmsMultiSelectWidget

public CmsMultiSelectWidget(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

CmsMultiSelectWidget

public CmsMultiSelectWidget(List<CmsSelectWidgetOption> configuration,
                            boolean asCheckboxes)

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

asCheckboxes - indicates if used html code is a multi selection list or a list of checkboxes

See Also:

CmsSelectWidgetOption

CmsMultiSelectWidget

public CmsMultiSelectWidget(String configuration)

Creates a select widget with the specified select options.

Parameters:

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

Method Detail

setEditorValue

public void setEditorValue(CmsObject cms,
                           Map<String,String[]> formParameters,
                           I_CmsWidgetDialog widgetDialog,
                           I_CmsWidgetParameter param)

Description copied from interface: I_CmsWidget

Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

Specified by:

setEditorValue in interface I_CmsWidget

Overrides:

setEditorValue in class A_CmsWidget

Parameters:

cms - the current users OpenCms context

formParameters - the map of parameters to get the value from

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

See Also:

I_CmsWidget.setEditorValue(org.opencms.file.CmsObject, java.util.Map, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

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)

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