Package 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_CmsADEWidget, 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

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.widgets.A_CmsWidget

A_CmsWidget.CmsDummyWidgetDialog

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIGURATION_ASCHECKBOXES	Configuration parameter to set the height from the select widget in pixel.
static final String	CONFIGURATION_REQUIRES_ACTIVATION	Configuration parameter to indicate the multi-select needs to be activated by a check box.

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
CmsMultiSelectWidget()	Creates a new select widget.
CmsMultiSelectWidget(String configuration)	Creates a select widget with the specified select options.
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.

Method Summary

Modifier and Type	Method	Description
String	getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)	Generates the necessary JavaScript inclusion code for this widget.
String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)	Generates the widget HTML for the provided widget parameter.
String	getWidgetName()	Returns the class name of the widget.
I_CmsWidget	newInstance()	Creates a duplicate of this widget instance.
void	setConfiguration(String configuration)	Sets the configuration of this widget.
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.
static void	setMultiSelectEditorValue(CmsObject cms, Map<String,String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)	Sets the value of the widget parameter from the provided form parameters.

Methods inherited from class org.opencms.widgets.A_CmsSelectWidget

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

Methods inherited from class org.opencms.widgets.A_CmsWidget

equals, getDialogHtmlEnd, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, hashCode, isCompactViewEnabled

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, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, getWidgetStringValue, isCompactViewEnabled

Field Details

CONFIGURATION_ASCHECKBOXES

public static final String CONFIGURATION_ASCHECKBOXES

Configuration parameter to set the height from the select widget in pixel.

See Also:

• Constant Field Values

CONFIGURATION_REQUIRES_ACTIVATION

public static final String CONFIGURATION_REQUIRES_ACTIVATION

Configuration parameter to indicate the multi-select needs to be activated by a check box.

See Also:

• Constant Field Values

Constructor Details

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 Details

setMultiSelectEditorValue

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

Sets the value of the widget parameter from the provided form parameters.

Parameters:

cms - the cms context

formParameters - the form parameters

widgetDialog - the widget dialog

param - the widget parameter

getDialogIncludes

public String getDialogIncludes(CmsObject cms,
 I_CmsWidgetDialog widgetDialog)

Description copied from interface: I_CmsWidget

Generates the necessary JavaScript inclusion code for this widget.

Specified by:

getDialogIncludes in interface I_CmsWidget

Overrides:

getDialogIncludes in class A_CmsWidget

Parameters:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

Returns:

the JavaScript inclusion code

See Also:

• I_CmsWidget.getDialogIncludes(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)

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)

getWidgetName

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

setConfiguration

public void setConfiguration(String configuration)

Description copied from interface: I_CmsWidget

Sets the configuration of this widget.

This can be used to enable / disable certain widget features that should not always be available, or to pass specific initialization information to the widget. It depends on the widget implementation on how this information is used.

Specified by:

setConfiguration in interface I_CmsWidget

Overrides:

setConfiguration in class A_CmsSelectWidget

Parameters:

configuration - the configuration to set

See Also:

• A_CmsWidget.setConfiguration(java.lang.String)

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)