org.opencms.widgets
Class CmsHtmlWidget

java.lang.Object
  org.opencms.widgets.A_CmsWidget
      org.opencms.widgets.A_CmsHtmlWidget
          org.opencms.widgets.CmsHtmlWidget

All Implemented Interfaces:

I_CmsWidget

public class CmsHtmlWidget
extends A_CmsHtmlWidget

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

Field Summary

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

CmsHtmlWidget()
Creates a new html editing widget.

CmsHtmlWidget(CmsHtmlWidgetOption configuration)
Creates a new html editing widget with the given configuration.

CmsHtmlWidget(String configuration)
Creates a new html editing widget with the given configuration.

Method Summary

String	getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the necessary JavaScript inclusion code for this widget.
String	getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the initialisation method JavaScript code for this widget.
String	getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the initialization method JavaScript code for this widget.
String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
I_CmsWidget	newInstance() Creates a duplicate of this widget instance.
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_CmsHtmlWidget

buildOpenCmsButtonRow, buildOpenCmsButtonRow, getConfiguration, getHtmlWidgetOption, setConfiguration, setHtmlWidgetOption

Methods inherited from class org.opencms.widgets.A_CmsWidget

equals, getDialogHtmlEnd, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsHtmlWidget

public CmsHtmlWidget()

Creates a new html editing widget.

CmsHtmlWidget

public CmsHtmlWidget(CmsHtmlWidgetOption configuration)

Creates a new html editing widget with the given configuration.

Parameters:

configuration - the configuration to use

CmsHtmlWidget

public CmsHtmlWidget(String configuration)

Creates a new html editing widget with the given configuration.

Parameters:

configuration - the configuration to use

Method Detail

getDialogIncludes

public String getDialogIncludes(CmsObject cms,
                                I_CmsWidgetDialog widgetDialog)

Description copied from interface: I_CmsWidget

Generates the necessary JavaScript inclusion code for this widget.

Specified by:

getDialogIncludes in interface I_CmsWidget

Overrides:

getDialogIncludes in class A_CmsWidget

Parameters:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

Returns:

the JavaScript inclusion code

See Also:

I_CmsWidget.getDialogIncludes(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)

getDialogInitCall

public String getDialogInitCall(CmsObject cms,
                                I_CmsWidgetDialog widgetDialog)

Description copied from interface: I_CmsWidget

Generates the initialisation method JavaScript code for this widget.

Specified by:

getDialogInitCall in interface I_CmsWidget

Overrides:

getDialogInitCall in class A_CmsWidget

Parameters:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

Returns:

the initialisation method JavaScript code

See Also:

I_CmsWidget.getDialogInitCall(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)

getDialogInitMethod

public String getDialogInitMethod(CmsObject cms,
                                  I_CmsWidgetDialog widgetDialog)

Description copied from interface: I_CmsWidget

Generates the initialization method JavaScript code for this widget.

Specified by:

getDialogInitMethod in interface I_CmsWidget

Overrides:

getDialogInitMethod in class A_CmsWidget

Parameters:

cms - an initialized instance of a CmsObject

widgetDialog - the dialog where the widget is used on

Returns:

the initialization method JavaScript code

See Also:

I_CmsWidget.getDialogInitMethod(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)

getDialogWidget

public String getDialogWidget(CmsObject cms,
                              I_CmsWidgetDialog widgetDialog,
                              I_CmsWidgetParameter param)

Description copied from interface: I_CmsWidget

Generates the widget HTML for the provided widget parameter.

Parameters:

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

Returns:

the widget HTML for the provided widget parameter

See Also:

I_CmsWidget.getDialogWidget(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

newInstance

public I_CmsWidget newInstance()

Description copied from interface: I_CmsWidget

Creates a duplicate of this widget instance.

Returns:

a duplicate of this widget instance

See Also:

I_CmsWidget.newInstance()

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_CmsHtmlWidget

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)