org.opencms.widgets

类 CmsMultiSelectWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsSelectWidget

org.opencms.widgets.CmsMultiSelectWidget

所有已实现的接口:

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

从以下版本开始:

6.0.0

嵌套类概要

从类继承的嵌套类/接口 org.opencms.widgets.A_CmsWidget

A_CmsWidget.CmsDummyWidgetDialog

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	CONFIGURATION_ASCHECKBOXES Configuration parameter to set the height from the select widget in pixel.
static java.lang.String	CONFIGURATION_REQUIRES_ACTIVATION Configuration parameter to indicate the multi-select needs to be activated by a check box.

从类继承的字段 org.opencms.widgets.A_CmsSelectWidget

CONFIGURATION_HEIGHT

从类继承的字段 org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

构造器概要

构造器

构造器和说明
CmsMultiSelectWidget() Creates a new select widget.
CmsMultiSelectWidget(java.util.List<CmsSelectWidgetOption> configuration) Creates a select widget with the select options specified in the given configuration List.
CmsMultiSelectWidget(java.util.List<CmsSelectWidgetOption> configuration, boolean asCheckboxes) Creates a select widget with the select options specified in the given configuration List.
CmsMultiSelectWidget(java.lang.String configuration) Creates a select widget with the specified select options.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the necessary JavaScript inclusion code for 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.
void	setConfiguration(java.lang.String configuration) Sets the configuration of this widget.
void	setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.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, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)

从类继承的方法 org.opencms.widgets.A_CmsSelectWidget

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

从类继承的方法 org.opencms.widgets.A_CmsWidget

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

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.opencms.widgets.I_CmsWidget

getDialogHtmlEnd, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, getWidgetStringValue, isCompactViewEnabled

字段详细资料

CONFIGURATION_ASCHECKBOXES

public static final java.lang.String CONFIGURATION_ASCHECKBOXES

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

另请参阅:

常量字段值

CONFIGURATION_REQUIRES_ACTIVATION

public static final java.lang.String CONFIGURATION_REQUIRES_ACTIVATION

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

另请参阅:

常量字段值

构造器详细资料

CmsMultiSelectWidget

public CmsMultiSelectWidget()

Creates a new select widget.

CmsMultiSelectWidget

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

参数:

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

另请参阅:

CmsSelectWidgetOption

CmsMultiSelectWidget

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

参数:

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

另请参阅:

CmsSelectWidgetOption

CmsMultiSelectWidget

public CmsMultiSelectWidget(java.lang.String configuration)

Creates a select widget with the specified select options.

参数:

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

方法详细资料

setMultiSelectEditorValue

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

参数:

cms -

formParameters -

widgetDialog -

param -

getDialogIncludes

public java.lang.String getDialogIncludes(CmsObject cms,
                                 I_CmsWidgetDialog widgetDialog)

从接口复制的说明: I_CmsWidget

Generates the necessary JavaScript inclusion code for this widget.

指定者:

getDialogIncludes 在接口中 I_CmsWidget

覆盖:

getDialogIncludes 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

返回:

the JavaScript inclusion code

另请参阅:

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

getDialogWidget

public java.lang.String getDialogWidget(CmsObject cms,
                               I_CmsWidgetDialog widgetDialog,
                               I_CmsWidgetParameter param)

从接口复制的说明: I_CmsWidget

Generates the widget HTML for the provided widget parameter.

参数:

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

返回:

the widget HTML for the provided widget parameter

另请参阅:

I_CmsWidget.getDialogWidget(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

getWidgetName

public java.lang.String getWidgetName()

从接口复制的说明: I_CmsADEWidget

Returns the class name of the widget.

指定者:

getWidgetName 在接口中 I_CmsADEWidget

覆盖:

getWidgetName 在类中 A_CmsSelectWidget

返回:

the class name

另请参阅:

I_CmsADEWidget.getWidgetName()

newInstance

public I_CmsWidget newInstance()

从接口复制的说明: I_CmsWidget

Creates a duplicate of this widget instance.

返回:

a duplicate of this widget instance

另请参阅:

I_CmsWidget.newInstance()

setConfiguration

public void setConfiguration(java.lang.String configuration)

从接口复制的说明: 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.

指定者:

setConfiguration 在接口中 I_CmsWidget

覆盖:

setConfiguration 在类中 A_CmsSelectWidget

参数:

configuration - the configuration to set

另请参阅:

A_CmsWidget.setConfiguration(java.lang.String)

setEditorValue

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

从接口复制的说明: I_CmsWidget

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

指定者:

setEditorValue 在接口中 I_CmsWidget

覆盖:

setEditorValue 在类中 A_CmsWidget

参数:

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

另请参阅:

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