org.opencms.widgets

类 CmsComboWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsSelectWidget

org.opencms.widgets.CmsComboWidget

所有已实现的接口:

I_CmsADEWidget, I_CmsWidget

直接已知子类:

CmsTypeComboWidget

public class CmsComboWidget
extends A_CmsSelectWidget

Provides a HTML text input field with optional values to select in a combo box, for use on a widget dialog.

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

The combo widget does use the following select options:

• CmsSelectWidgetOption.getValue() for the texts to be displayed in the combo selector
• CmsSelectWidgetOption.isDefault() to fill the input with a preselected text
• CmsSelectWidgetOption.getHelp() to display an (optional) help text for the combo option

从以下版本开始:

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

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getDialogHtmlEnd(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the html to include at the end of the dialog for this widget.
java.lang.String	getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the necessary JavaScript inclusion code for this widget.
java.lang.String	getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the initialisation method JavaScript 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.

从类继承的方法 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, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, hashCode, isCompactViewEnabled, setEditorValue

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

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

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

getDialogInitMethod, getHelpBubble, getHelpText, getWidgetStringValue, isCompactViewEnabled, setEditorValue

构造器详细资料

CmsComboWidget

public CmsComboWidget()

Creates a new combo widget.

CmsComboWidget

public CmsComboWidget(java.util.List<CmsSelectWidgetOption> configuration)

Creates a combo 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

CmsComboWidget

public CmsComboWidget(java.lang.String configuration)

Creates a combo widget with the specified combo options.

参数:

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

方法详细资料

getDialogHtmlEnd

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

从接口复制的说明: I_CmsWidget

Generates the html to include at the end of the dialog for this widget.

The "help bubble" text div's are added using this method.

指定者:

getDialogHtmlEnd 在接口中 I_CmsWidget

覆盖:

getDialogHtmlEnd 在类中 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 html to include at the end of the dialog for this widget

另请参阅:

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

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)

getDialogInitCall

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

从接口复制的说明: I_CmsWidget

Generates the initialisation method JavaScript code for this widget.

指定者:

getDialogInitCall 在接口中 I_CmsWidget

覆盖:

getDialogInitCall 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

返回:

the initialisation method JavaScript code

另请参阅:

I_CmsWidget.getDialogInitCall(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

另请参阅:

A_CmsSelectWidget.getWidgetName()

newInstance

public I_CmsWidget newInstance()

从接口复制的说明: I_CmsWidget

Creates a duplicate of this widget instance.

返回:

a duplicate of this widget instance

另请参阅:

I_CmsWidget.newInstance()