Package org.opencms.widgets

Class A_CmsHtmlWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsHtmlWidget

All Implemented Interfaces:

I_CmsWidget

Direct Known Subclasses:

CmsHtmlWidget

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.

Since:

6.0.1

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.widgets.A_CmsWidget

A_CmsWidget.CmsDummyWidgetDialog

Field Summary

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

Constructors

Constructor	Description
A_CmsHtmlWidget()	Creates a new html editing widget.
A_CmsHtmlWidget(String configuration)	Creates a new html editing widget with the given configuration.

Method Summary

Modifier and Type	Method	Description
String	getConfiguration()	Returns the configuration string.
CmsHtmlWidgetOption	parseWidgetOptions(CmsObject cms)	Creates a CmsHtmlWidgetOption instance from the configuration string.
void	setConfiguration(String configuration)	Sets the configuration of this widget.
void	setEditorValue(CmsObject cms, Map<String,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.

Methods inherited from class org.opencms.widgets.A_CmsWidget

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.widgets.I_CmsWidget

getDialogWidget, newInstance

Constructor Details

A_CmsHtmlWidget

public A_CmsHtmlWidget()

Creates a new html editing widget.

A_CmsHtmlWidget

public A_CmsHtmlWidget(String configuration)

Creates a new html editing widget with the given configuration.

Parameters:

configuration - the configuration to use

Method Details

getConfiguration

public String getConfiguration()

Description copied from class: A_CmsWidget

Returns the configuration string.

Specified by:

getConfiguration in interface I_CmsWidget

Overrides:

getConfiguration in class A_CmsWidget

Returns:

the configuration string

See Also:

• A_CmsWidget.getConfiguration()

parseWidgetOptions

public CmsHtmlWidgetOption parseWidgetOptions(CmsObject cms)

Creates a CmsHtmlWidgetOption instance from the configuration string.

Parameters:

cms - the current CMS context

Returns:

the parsed option bean

setConfiguration

public void setConfiguration(String configuration)

Description copied from interface: 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.

Specified by:

setConfiguration in interface I_CmsWidget

Overrides:

setConfiguration in class A_CmsWidget

Parameters:

configuration - the configuration to set

See Also:

• I_CmsWidget.setConfiguration(java.lang.String)

setEditorValue

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

Description copied from interface: I_CmsWidget

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

Specified by:

setEditorValue in interface I_CmsWidget

Overrides:

setEditorValue in class A_CmsWidget

Parameters:

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

See Also:

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