org.opencms.widgets

类 A_CmsSelectWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsSelectWidget

所有已实现的接口:

I_CmsADEWidget, I_CmsWidget

直接已知子类:

CmsComboWidget, CmsMultiSelectWidget, CmsRadioSelectWidget, CmsSelectWidget

public abstract class A_CmsSelectWidget
extends A_CmsWidget
implements I_CmsADEWidget

Base class for select widgets.

从以下版本开始:

6.0.0

另请参阅:

CmsSelectWidgetOption

嵌套类概要

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

A_CmsWidget.CmsDummyWidgetDialog

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	CONFIGURATION_HEIGHT Configuration parameter to set the height from the select widget in pixel.

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

HELP_POSTFIX, LABEL_PREFIX

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
void	addSelectOption(CmsSelectWidgetOption option) Adds a new select option to this widget.
java.lang.String	getConfiguration() Returns the configuration string.
java.lang.String	getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale) Returns the configuration string for the ADE content editor widget.
java.util.List<java.lang.String>	getCssResourceLinks(CmsObject cms) Returns a list of CSS resources required by the widget.
I_CmsXmlContentHandler.DisplayType	getDefaultDisplayType() Returns the default display type of this widget.
protected java.lang.String	getHeight() Gets the configured select widget height.
java.lang.String	getInitCall() Returns the java script initialization call.
java.util.List<java.lang.String>	getJavaScriptResourceLinks(CmsObject cms) Returns a list of java script resources required by the widget.
protected java.lang.String	getResourcePath(CmsObject cms, I_CmsWidgetDialog dialog) Gets the resource path for the given dialog.
protected java.lang.String	getSelectedValue(CmsObject cms, I_CmsWidgetParameter param) Returns the currently selected value of the select widget.
protected java.util.List<java.lang.String>	getSelectedValues(CmsObject cms, I_CmsWidgetParameter param) Returns the currently selected values of the select widget.
protected java.util.List<CmsSelectWidgetOption>	getSelectOptions() Returns the list of configured select options.
java.lang.String	getWidgetName() Returns the class name of the widget.
boolean	isInternal() Returns if this is an internal widget.
protected java.util.List<CmsSelectWidgetOption>	parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Returns the list of configured select options, parsing the configuration String if required.
void	setConfiguration(java.lang.String configuration) Sets the configuration of this widget.
protected void	setSelectOptions(java.util.List<CmsSelectWidgetOption> selectOptions) Sets the list of configured select options.

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

equals, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, 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

getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getDialogWidget, getHelpBubble, getHelpText, getWidgetStringValue, isCompactViewEnabled, newInstance, setEditorValue

字段详细资料

CONFIGURATION_HEIGHT

public static final java.lang.String CONFIGURATION_HEIGHT

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

另请参阅:

常量字段值

构造器详细资料

A_CmsSelectWidget

public A_CmsSelectWidget()

Creates a new select widget.

A_CmsSelectWidget

public A_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

A_CmsSelectWidget

public A_CmsSelectWidget(java.lang.String configuration)

Creates a select widget with the select options specified in the given configuration String.

Please see CmsSelectWidgetOption for a description of the syntax of the configuration String.

参数:

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

另请参阅:

CmsSelectWidgetOption

方法详细资料

addSelectOption

public void addSelectOption(CmsSelectWidgetOption option)

Adds a new select option to this widget.

参数:

option - the select option to add

getConfiguration

public java.lang.String getConfiguration()

从类复制的说明: A_CmsWidget

Returns the configuration string.

指定者:

getConfiguration 在接口中 I_CmsWidget

覆盖:

getConfiguration 在类中 A_CmsWidget

返回:

the configuration string

另请参阅:

A_CmsWidget.getConfiguration()

getConfiguration

public java.lang.String getConfiguration(CmsObject cms,
                                A_CmsXmlContentValue schemaType,
                                CmsMessages messages,
                                CmsResource resource,
                                java.util.Locale contentLocale)

从接口复制的说明: I_CmsADEWidget

Returns the configuration string for the ADE content editor widget.

指定者:

getConfiguration 在接口中 I_CmsADEWidget

参数:

cms - the OpenCms context

schemaType - the schema type

messages - the messages

resource - the edited resource

contentLocale - the content locale

返回:

the configuration string

另请参阅:

I_CmsADEWidget.getConfiguration(org.opencms.file.CmsObject, org.opencms.xml.types.A_CmsXmlContentValue, org.opencms.i18n.CmsMessages, org.opencms.file.CmsResource, java.util.Locale)

getCssResourceLinks

public java.util.List<java.lang.String> getCssResourceLinks(CmsObject cms)

Returns a list of CSS resources required by the widget.

指定者:

getCssResourceLinks 在接口中 I_CmsADEWidget

参数:

cms - the current OpenCms context

返回:

the required CSS resource links

getDefaultDisplayType

public I_CmsXmlContentHandler.DisplayType getDefaultDisplayType()

从接口复制的说明: I_CmsADEWidget

Returns the default display type of this widget.

指定者:

getDefaultDisplayType 在接口中 I_CmsADEWidget

返回:

the default display type

另请参阅:

I_CmsADEWidget.getDefaultDisplayType()

getInitCall

public java.lang.String getInitCall()

Returns the java script initialization call.

指定者:

getInitCall 在接口中 I_CmsADEWidget

返回:

the java script initialization call

getJavaScriptResourceLinks

public java.util.List<java.lang.String> getJavaScriptResourceLinks(CmsObject cms)

Returns a list of java script resources required by the widget.

指定者:

getJavaScriptResourceLinks 在接口中 I_CmsADEWidget

参数:

cms - the current OpenCms context

返回:

the required java script resource links

getWidgetName

public java.lang.String getWidgetName()

从接口复制的说明: I_CmsADEWidget

Returns the class name of the widget.

指定者:

getWidgetName 在接口中 I_CmsADEWidget

返回:

the class name

另请参阅:

I_CmsADEWidget.getWidgetName()

isInternal

public boolean isInternal()

Returns if this is an internal widget.

Only widgets belonging to the OpenCms core should be marked as internal.

指定者:

isInternal 在接口中 I_CmsADEWidget

返回:

true if this is an internal widget

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_CmsWidget

参数:

configuration - the configuration to set

另请参阅:

A_CmsWidget.setConfiguration(java.lang.String)

getHeight

protected java.lang.String getHeight()

Gets the configured select widget height.

返回:

the configured select widget height

getResourcePath

protected java.lang.String getResourcePath(CmsObject cms,
                               I_CmsWidgetDialog dialog)

Gets the resource path for the given dialog.

参数:

cms - TODO

dialog - the dialog

返回:

the resource path

getSelectedValue

protected java.lang.String getSelectedValue(CmsObject cms,
                                I_CmsWidgetParameter param)

Returns the currently selected value of the select widget.

If a value is found in the given parameter, this is used. Otherwise the default value of the select options are used. If there is neither a parameter value nor a default value, null is returned.

参数:

cms - the current users OpenCms context

param - the widget parameter of this dialog

返回:

the currently selected value of the select widget

getSelectedValues

protected java.util.List<java.lang.String> getSelectedValues(CmsObject cms,
                                                 I_CmsWidgetParameter param)

Returns the currently selected values of the select widget.

If a value is found in the given parameter, this is used. Otherwise the default value of the select options are used. If there is neither a parameter value nor a default value, null is used.

参数:

cms - the current users OpenCms context

param - the widget parameter of this dialog

返回:

a list of the currently selected values of the select widget

getSelectOptions

protected java.util.List<CmsSelectWidgetOption> getSelectOptions()

Returns the list of configured select options.

The list elements are of type CmsSelectWidgetOption.

返回:

the list of select options

parseSelectOptions

protected java.util.List<CmsSelectWidgetOption> parseSelectOptions(CmsObject cms,
                                                       I_CmsWidgetDialog widgetDialog,
                                                       I_CmsWidgetParameter param)

Returns the list of configured select options, parsing the configuration String if required.

The list elements are of type CmsSelectWidgetOption. The configuration String is parsed only once and then stored internally.

参数:

cms - the current users OpenCms context

widgetDialog - the dialog of this widget

param - the widget parameter of this dialog

返回:

the list of select options

另请参阅:

CmsSelectWidgetOption

setSelectOptions

protected void setSelectOptions(java.util.List<CmsSelectWidgetOption> selectOptions)

Sets the list of configured select options.

The list elements must be of type CmsSelectWidgetOption.

参数:

selectOptions - the list of select options to set