org.opencms.widgets

类 CmsDisplayWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.CmsDisplayWidget

所有已实现的接口:

I_CmsADEWidget, I_CmsWidget

public class CmsDisplayWidget
extends A_CmsWidget
implements I_CmsADEWidget

Provides a display only widget, for use on a widget dialog.

从以下版本开始:

6.0.0

嵌套类概要

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

A_CmsWidget.CmsDummyWidgetDialog

字段概要

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

HELP_POSTFIX, LABEL_PREFIX

构造器概要

构造器

构造器和说明
CmsDisplayWidget() Creates a new input widget.
CmsDisplayWidget(java.lang.String configuration) Creates a new input widget with the given configuration.

方法概要

方法

限定符和类型	方法和说明
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.
java.lang.String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
java.lang.String	getHelpBubble(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Creates the HTML code for the help bubble for this widget.
java.lang.String	getHelpText(I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Creates a HTML <div> containing the help text for this widget.
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.
java.lang.String	getWidgetName() Returns the class name of the widget.
boolean	isInternal() Returns if this is an internal widget.
I_CmsWidget	newInstance() Creates a duplicate of this widget instance.

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

equals, getConfiguration, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpKey, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, hashCode, isCompactViewEnabled, setConfiguration, setEditorValue

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

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

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

getConfiguration, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getWidgetStringValue, isCompactViewEnabled, setConfiguration, setEditorValue

构造器详细资料

CmsDisplayWidget

public CmsDisplayWidget()

Creates a new input widget.

CmsDisplayWidget

public CmsDisplayWidget(java.lang.String configuration)

Creates a new input widget with the given configuration.

参数:

configuration - the configuration to use

方法详细资料

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)

从接口复制的说明: I_CmsADEWidget

Returns a list of CSS resources required by the widget.

指定者:

getCssResourceLinks 在接口中 I_CmsADEWidget

参数:

cms - the current OpenCms context

返回:

the required CSS resource links

另请参阅:

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

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

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.

指定者:

getDialogWidget 在接口中 I_CmsWidget

参数:

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)

getHelpBubble

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

从接口复制的说明: I_CmsWidget

Creates the HTML code for the help bubble for this widget.

指定者:

getHelpBubble 在接口中 I_CmsWidget

覆盖:

getHelpBubble 在类中 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 code for the help bubble for this widget

另请参阅:

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

getHelpText

public java.lang.String getHelpText(I_CmsWidgetDialog widgetDialog,
                           I_CmsWidgetParameter param)

从接口复制的说明: I_CmsWidget

Creates a HTML <div> containing the help text for this widget.

指定者:

getHelpText 在接口中 I_CmsWidget

覆盖:

getHelpText 在类中 A_CmsWidget

参数:

widgetDialog - the dialog where the widget is used on

param - the value to create the help bubble for

返回:

a HTML <div> containing the help text for this widget

另请参阅:

A_CmsWidget.getHelpText(org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

getInitCall

public java.lang.String getInitCall()

从接口复制的说明: I_CmsADEWidget

Returns the java script initialization call.

指定者:

getInitCall 在接口中 I_CmsADEWidget

返回:

the java script initialization call

另请参阅:

I_CmsADEWidget.getInitCall()

getJavaScriptResourceLinks

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

从接口复制的说明: I_CmsADEWidget

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

另请参阅:

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

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

从接口复制的说明: I_CmsADEWidget

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

另请参阅:

I_CmsADEWidget.isInternal()

newInstance

public I_CmsWidget newInstance()

从接口复制的说明: I_CmsWidget

Creates a duplicate of this widget instance.

指定者:

newInstance 在接口中 I_CmsWidget

返回:

a duplicate of this widget instance

另请参阅:

I_CmsWidget.newInstance()