org.opencms.widgets

类 CmsAddFormatterWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsSelectWidget

org.opencms.widgets.CmsSelectWidget

org.opencms.widgets.A_CmsFormatterWidget

org.opencms.widgets.CmsAddFormatterWidget

所有已实现的接口:

I_CmsADEWidget, I_CmsWidget

public class CmsAddFormatterWidget
extends A_CmsFormatterWidget

Widget used to select a formatter to add.

Please note that this widget assumes the resource being edited is a sitemap configuration, and will not work correctly in a different context.

嵌套类概要

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

A_CmsFormatterWidget.FormatterSelectComparator

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

A_CmsWidget.CmsDummyWidgetDialog

字段概要

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

CONFIGURATION_HEIGHT

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

HELP_POSTFIX, LABEL_PREFIX

构造器概要

构造器

构造器和说明
CmsAddFormatterWidget() Default constructor.
CmsAddFormatterWidget(java.lang.String config) Constructor with a configuration parameter.

方法概要

方法

限定符和类型	方法和说明
java.util.List<java.lang.String>	getCssResourceLinks(CmsObject cms) Returns a list of CSS resources required by the widget.
protected java.util.List<CmsSelectWidgetOption>	getFormatterOptions(CmsObject cms, CmsADEConfigData config) Gets the options corresponding to external (non-schema) formatters.
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.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 java.util.List<CmsSelectWidgetOption>	getTypeOptions(CmsObject cms, CmsADEConfigData adeConfig) Gets the options corresponding to the schemas which define formatters.
boolean	isInternal() Returns if this is an internal widget.
I_CmsWidget	newInstance() Creates a duplicate of this widget instance.

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

getWidgetOptionForFormatter, getWidgetOptionForType, parseSelectOptions

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

getDialogWidget, getWidgetName, getWidgetStringValue

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

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

构造器详细资料

CmsAddFormatterWidget

public CmsAddFormatterWidget()

Default constructor.

CmsAddFormatterWidget

public CmsAddFormatterWidget(java.lang.String config)

Constructor with a configuration parameter.

参数:

config - the configuration string

方法详细资料

getCssResourceLinks

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

从类复制的说明: A_CmsSelectWidget

Returns a list of CSS resources required by the widget.

指定者:

getCssResourceLinks 在接口中 I_CmsADEWidget

覆盖:

getCssResourceLinks 在类中 A_CmsSelectWidget

参数:

cms - the current OpenCms context

返回:

the required CSS resource links

另请参阅:

I_CmsADEWidget.getCssResourceLinks(org.opencms.file.CmsObject)

getInitCall

public java.lang.String getInitCall()

从类复制的说明: A_CmsSelectWidget

Returns the java script initialization call.

指定者:

getInitCall 在接口中 I_CmsADEWidget

覆盖:

getInitCall 在类中 A_CmsSelectWidget

返回:

the java script initialization call

另请参阅:

I_CmsADEWidget.getInitCall()

getJavaScriptResourceLinks

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

从类复制的说明: A_CmsSelectWidget

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

指定者:

getJavaScriptResourceLinks 在接口中 I_CmsADEWidget

覆盖:

getJavaScriptResourceLinks 在类中 A_CmsSelectWidget

参数:

cms - the current OpenCms context

返回:

the required java script resource links

另请参阅:

I_CmsADEWidget.getJavaScriptResourceLinks(org.opencms.file.CmsObject)

isInternal

public boolean isInternal()

从类复制的说明: A_CmsSelectWidget

Returns if this is an internal widget.

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

指定者:

isInternal 在接口中 I_CmsADEWidget

覆盖:

isInternal 在类中 A_CmsSelectWidget

返回:

true if this is an internal widget

另请参阅:

I_CmsADEWidget.isInternal()

newInstance

public I_CmsWidget newInstance()

从接口复制的说明: I_CmsWidget

Creates a duplicate of this widget instance.

指定者:

newInstance 在接口中 I_CmsWidget

覆盖:

newInstance 在类中 CmsSelectWidget

返回:

a duplicate of this widget instance

另请参阅:

CmsSelectWidget.newInstance()

getFormatterOptions

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

从类复制的说明: A_CmsFormatterWidget

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

指定者:

getFormatterOptions 在类中 A_CmsFormatterWidget

参数:

cms - the CMS context

config - the ADE configuration

返回:

the select widget options for the external formatters

另请参阅:

A_CmsFormatterWidget.getFormatterOptions(org.opencms.file.CmsObject, org.opencms.ade.configuration.CmsADEConfigData)

getSelectedInFile

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

从类复制的说明: A_CmsFormatterWidget

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

指定者:

getSelectedInFile 在类中 A_CmsFormatterWidget

参数:

reader - a sitemap configuration reader

content - the unmarshalled content

返回:

the set of values which have already been selected

另请参阅:

A_CmsFormatterWidget.getSelectedInFile(org.opencms.ade.configuration.CmsConfigurationReader, org.opencms.xml.content.CmsXmlContent)

getTypeOptions

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

从类复制的说明: A_CmsFormatterWidget

Gets the options corresponding to the schemas which define formatters.

指定者:

getTypeOptions 在类中 A_CmsFormatterWidget

参数:

cms - the current CMS context

adeConfig - the ADE configuration

返回:

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

另请参阅:

A_CmsFormatterWidget.getTypeOptions(org.opencms.file.CmsObject, org.opencms.ade.configuration.CmsADEConfigData)