org.opencms.widgets

类 CmsSelectWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsSelectWidget

org.opencms.widgets.CmsSelectWidget

所有已实现的接口:

I_CmsADEWidget, I_CmsWidget

直接已知子类:

A_CmsFormatterWidget, CmsSelectGroupWidget, CmsSelectOnChangeReloadWidget

public class CmsSelectWidget
extends A_CmsSelectWidget

Provides a widget for a standard HTML form select box.

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

The select widget does use the following select options:

• CmsSelectWidgetOption.getValue() for the value of the HTML select box
• CmsSelectWidgetOption.isDefault() for pre-selecting a specific value
• CmsSelectWidgetOption.getOption() for the option of the HTML select box

从以下版本开始:

6.0.0

嵌套类概要

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

A_CmsWidget.CmsDummyWidgetDialog

字段概要

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

CONFIGURATION_HEIGHT

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

HELP_POSTFIX, LABEL_PREFIX

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
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.
java.lang.String	getWidgetStringValue(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Returns the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget and the given widget dialog.
I_CmsWidget	newInstance() Creates a duplicate of this widget instance.

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

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

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

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

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

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

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

getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, isCompactViewEnabled, setEditorValue

构造器详细资料

CmsSelectWidget

public CmsSelectWidget()

Creates a new select widget.

CmsSelectWidget

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

CmsSelectWidget

public CmsSelectWidget(java.lang.String configuration)

Creates a select widget with the specified select options.

参数:

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

方法详细资料

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

getWidgetStringValue

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

从接口复制的说明: I_CmsWidget

Returns the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget and the given widget dialog.

指定者:

getWidgetStringValue 在接口中 I_CmsWidget

覆盖:

getWidgetStringValue 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

返回:

the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget

另请参阅:

A_CmsWidget.getWidgetStringValue(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

newInstance

public I_CmsWidget newInstance()

从接口复制的说明: I_CmsWidget

Creates a duplicate of this widget instance.

返回:

a duplicate of this widget instance

另请参阅:

I_CmsWidget.newInstance()