org.opencms.widgets

类 A_CmsHtmlWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsHtmlWidget

所有已实现的接口:

I_CmsWidget

直接已知子类:

CmsHtmlWidget, CmsTinyMCEWidget

public abstract class A_CmsHtmlWidget
extends A_CmsWidget

Provides a widget that creates a rich input field using the matching component, for use on a widget dialog.

The matching component is determined by checking the installed editors for the best matching component to use.

从以下版本开始:

6.0.1

嵌套类概要

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

A_CmsWidget.CmsDummyWidgetDialog

字段概要

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

HELP_POSTFIX, LABEL_PREFIX

构造器概要

构造器

构造器和说明
A_CmsHtmlWidget() Creates a new html editing widget.
A_CmsHtmlWidget(CmsHtmlWidgetOption configuration) Creates a new html editing widget with the given configuration.
A_CmsHtmlWidget(java.lang.String configuration) Creates a new html editing widget with the given configuration.

方法概要

方法

限定符和类型	方法和说明
protected java.lang.String	buildOpenCmsButtonRow(I_CmsWidgetDialog widgetDialog, java.lang.String paramId) Returns the HTML for the OpenCms specific button row for galleries and links.
protected java.lang.String	buildOpenCmsButtonRow(int segment, I_CmsWidgetDialog widgetDialog) Returns the start or end HTML for the OpenCms specific button row.
java.lang.String	getConfiguration() Returns the configuration string.
CmsHtmlWidgetOption	getHtmlWidgetOption() Returns the configured Html widget options.
void	setConfiguration(java.lang.String configuration) Sets the configuration of this widget.
void	setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.
void	setHtmlWidgetOption(CmsHtmlWidgetOption htmlWidgetOption) Sets the configured Html widget options.

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

equals, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, hashCode, isCompactViewEnabled

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

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

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

getDialogWidget, newInstance

构造器详细资料

A_CmsHtmlWidget

public A_CmsHtmlWidget()

Creates a new html editing widget.

A_CmsHtmlWidget

public A_CmsHtmlWidget(CmsHtmlWidgetOption configuration)

Creates a new html editing widget with the given configuration.

参数:

configuration - the configuration to use

A_CmsHtmlWidget

public A_CmsHtmlWidget(java.lang.String configuration)

Creates a new html editing widget with the given configuration.

参数:

configuration - the configuration to use

方法详细资料

getConfiguration

public java.lang.String getConfiguration()

从类复制的说明: A_CmsWidget

Returns the configuration string.

指定者:

getConfiguration 在接口中 I_CmsWidget

覆盖:

getConfiguration 在类中 A_CmsWidget

返回:

the configuration string

另请参阅:

A_CmsWidget.getConfiguration()

getHtmlWidgetOption

public CmsHtmlWidgetOption getHtmlWidgetOption()

Returns the configured Html widget options.

返回:

the configured Html widget options

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

另请参阅:

I_CmsWidget.setConfiguration(java.lang.String)

setEditorValue

public void setEditorValue(CmsObject cms,
                  java.util.Map<java.lang.String,java.lang.String[]> formParameters,
                  I_CmsWidgetDialog widgetDialog,
                  I_CmsWidgetParameter param)

从接口复制的说明: I_CmsWidget

Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

指定者:

setEditorValue 在接口中 I_CmsWidget

覆盖:

setEditorValue 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

formParameters - the map of parameters to get the value from

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

另请参阅:

I_CmsWidget.setEditorValue(org.opencms.file.CmsObject, java.util.Map, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

setHtmlWidgetOption

public void setHtmlWidgetOption(CmsHtmlWidgetOption htmlWidgetOption)

Sets the configured Html widget options.

参数:

htmlWidgetOption - the configured Html widget options

buildOpenCmsButtonRow

protected java.lang.String buildOpenCmsButtonRow(I_CmsWidgetDialog widgetDialog,
                                     java.lang.String paramId)

Returns the HTML for the OpenCms specific button row for galleries and links.

Use this method to generate a button row with OpenCms specific dialog buttons in the I_CmsWidget.getDialogWidget(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter) method to obtain the buttons.

Overwrite the method if the integrated editor needs a specific button generation (e.g. add format select or toggle source code button) or if some buttons should not be available.

参数:

widgetDialog - the dialog where the widget is used on

paramId - the id of the current widget

返回:

the html String for the OpenCms specific button row

buildOpenCmsButtonRow

protected java.lang.String buildOpenCmsButtonRow(int segment,
                                     I_CmsWidgetDialog widgetDialog)

Returns the start or end HTML for the OpenCms specific button row.

Use this method to generate the start and end html for the button row.

Overwrite the method if the integrated editor needs a specific layout for the button row start or end html.

参数:

segment - the HTML segment (START / END)

widgetDialog - the dialog where the widget is used on

返回:

the html String for the OpenCms specific button row