org.opencms.widgets

类 A_CmsFormatterWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsSelectWidget

org.opencms.widgets.CmsSelectWidget

org.opencms.widgets.A_CmsFormatterWidget

所有已实现的接口:

I_CmsADEWidget, I_CmsWidget

直接已知子类:

CmsAddFormatterWidget, CmsRemoveFormatterWidget

public abstract class A_CmsFormatterWidget
extends CmsSelectWidget

Abstract superclass for widgets used to enable or disable formatters.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	A_CmsFormatterWidget.FormatterSelectComparator Comparator used to sort formatter beans in the order in which they should be displayed in the selection.

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

A_CmsWidget.CmsDummyWidgetDialog

字段概要

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

CONFIGURATION_HEIGHT

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

HELP_POSTFIX, LABEL_PREFIX

构造器概要

构造器

构造器和说明
A_CmsFormatterWidget()

方法概要

方法

限定符和类型	方法和说明
protected abstract java.util.List<CmsSelectWidgetOption>	getFormatterOptions(CmsObject cms, CmsADEConfigData config) Gets the options corresponding to external (non-schema) formatters.
protected abstract java.util.Set<java.lang.String>	getSelectedInFile(CmsConfigurationReader reader, CmsXmlContent content) Gets the values which have already been selected in the edited resource on the VFS.
protected abstract java.util.List<CmsSelectWidgetOption>	getTypeOptions(CmsObject cms, CmsADEConfigData config) Gets the options corresponding to the schemas which define formatters.
static CmsSelectWidgetOption	getWidgetOptionForFormatter(CmsObject cms, I_CmsFormatterBean formatter) Creates a widget option corresponding to a formatter bean for an external formatter.
static CmsSelectWidgetOption	getWidgetOptionForType(CmsObject cms, java.lang.String typeName) Creates a widget option for a resource type.
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.

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

getDialogWidget, getWidgetName, getWidgetStringValue, newInstance

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

addSelectOption, getConfiguration, getConfiguration, getCssResourceLinks, getDefaultDisplayType, getHeight, getInitCall, getJavaScriptResourceLinks, getResourcePath, getSelectedValue, getSelectedValues, getSelectOptions, isInternal, 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

构造器详细资料

A_CmsFormatterWidget

public A_CmsFormatterWidget()

方法详细资料

getWidgetOptionForFormatter

public static CmsSelectWidgetOption getWidgetOptionForFormatter(CmsObject cms,
                                                I_CmsFormatterBean formatter)

Creates a widget option corresponding to a formatter bean for an external formatter.

参数:

cms - the current CMS context

formatter - the formatter bean

返回:

the select option which was created

getWidgetOptionForType

public static CmsSelectWidgetOption getWidgetOptionForType(CmsObject cms,
                                           java.lang.String typeName)

Creates a widget option for a resource type.

参数:

cms - the current CMS context

typeName - the type for which we want a widget option

返回:

the created widget option

getFormatterOptions

protected abstract java.util.List<CmsSelectWidgetOption> getFormatterOptions(CmsObject cms,
                                                        CmsADEConfigData config)

Gets the options corresponding to external (non-schema) formatters.

参数:

cms - the CMS context

config - the ADE configuration

返回:

the select widget options for the external formatters

getSelectedInFile

protected abstract java.util.Set<java.lang.String> getSelectedInFile(CmsConfigurationReader reader,
                                                CmsXmlContent content)

Gets the values which have already been selected in the edited resource on the VFS.

参数:

reader - a sitemap configuration reader

content - the unmarshalled content

返回:

the set of values which have already been selected

getTypeOptions

protected abstract java.util.List<CmsSelectWidgetOption> getTypeOptions(CmsObject cms,
                                                   CmsADEConfigData config)

Gets the options corresponding to the schemas which define formatters.

参数:

cms - the current CMS context

config - the ADE configuration

返回:

the select widget options for the content types with formatters in the schema

parseSelectOptions

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

从类复制的说明: A_CmsSelectWidget

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.

覆盖:

parseSelectOptions 在类中 A_CmsSelectWidget

参数:

cms - the current users OpenCms context

widgetDialog - the dialog of this widget

param - the widget parameter of this dialog

返回:

the list of select options

另请参阅:

A_CmsSelectWidget.parseSelectOptions(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)