Package 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_CmsADEWidget, I_CmsWidget

public class CmsHtmlWidget
extends A_CmsHtmlWidget
implements I_CmsADEWidget

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

Modifier and Type	Field	Description
static final String	ATTR_TEMPLATE_EDITOR_CONFIGFILE	Sitemap attribute key for configuring the TinyMCE JSON configuration.
static final Map<String,String>	TINYMCE_DEFAULT_BLOCK_FORMAT_LABELS	Labels for the default block format options.

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	addEmbeddedGalleryOptions(JSONObject result, CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)	Adds the configuration for embedded gallery widgets the the JSON object.
String	getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)	Returns the configuration string for the ADE content editor widget.
List<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.
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.
String	getInitCall()	Returns the java script initialization call.
List<String>	getJavaScriptResourceLinks(CmsObject cms)	Returns a list of java script resources required by the widget.
protected JSONObject	getJSONConfiguration(CmsObject cms, CmsResource resource, Locale contentLocale)	Returns the WYSIWYG editor configuration as a JSON object.
static JSONObject	getJSONConfiguration(CmsHtmlWidgetOption widgetOptions, CmsObject cms, CmsResource resource, Locale contentLocale)	Returns the WYSIWYG editor configuration as a JSON object.
static String	getTinyMceBlockFormats(String formatSelectOptions)	Gets the block format configuration string for TinyMCE from the configured format select options.
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.
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

getConfiguration, parseWidgetOptions, setConfiguration

Methods inherited from class org.opencms.widgets.A_CmsWidget

equals, getDialogHtmlEnd, 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

getConfiguration, getDialogHtmlEnd, getHelpBubble, getHelpText, getWidgetStringValue, isCompactViewEnabled, setConfiguration

Field Details

ATTR_TEMPLATE_EDITOR_CONFIGFILE

public static final String ATTR_TEMPLATE_EDITOR_CONFIGFILE

Sitemap attribute key for configuring the TinyMCE JSON configuration.

See Also:

• Constant Field Values

TINYMCE_DEFAULT_BLOCK_FORMAT_LABELS

public static final Map<String,String> TINYMCE_DEFAULT_BLOCK_FORMAT_LABELS

Labels for the default block format options.

Constructor Details

CmsHtmlWidget

public CmsHtmlWidget()

Creates a new html editing widget.

CmsHtmlWidget

public CmsHtmlWidget(String configuration)

Creates a new html editing widget with the given configuration.

Parameters:

configuration - the configuration to use

Method Details

getJSONConfiguration

public static JSONObject getJSONConfiguration(CmsHtmlWidgetOption widgetOptions,
 CmsObject cms,
 CmsResource resource,
 Locale contentLocale)

Returns the WYSIWYG editor configuration as a JSON object.

Parameters:

widgetOptions - the options for the wysiwyg widget

cms - the OpenCms context

resource - the edited resource

contentLocale - the edited content locale

Returns:

the configuration

getTinyMceBlockFormats

public static String getTinyMceBlockFormats(String formatSelectOptions)

Gets the block format configuration string for TinyMCE from the configured format select options.

Parameters:

formatSelectOptions - the format select options

Returns:

the block_formats configuration

getConfiguration

public String getConfiguration(CmsObject cms,
 A_CmsXmlContentValue schemaType,
 CmsMessages messages,
 CmsResource resource,
 Locale contentLocale)

Description copied from interface: I_CmsADEWidget

Returns the configuration string for the ADE content editor widget.

Specified by:

getConfiguration in interface I_CmsADEWidget

Parameters:

cms - the OpenCms context

schemaType - the schema type

messages - the messages

resource - the edited resource

contentLocale - the content locale

Returns:

the configuration string

See Also:

• 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 List<String> getCssResourceLinks(CmsObject cms)

Description copied from interface: I_CmsADEWidget

Returns a list of CSS resources required by the widget.

Specified by:

getCssResourceLinks in interface I_CmsADEWidget

Parameters:

cms - the current OpenCms context

Returns:

the required CSS resource links

See Also:

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

getDefaultDisplayType

public I_CmsXmlContentHandler.DisplayType getDefaultDisplayType()

Description copied from interface: I_CmsADEWidget

Returns the default display type of this widget.

Specified by:

getDefaultDisplayType in interface I_CmsADEWidget

Returns:

the default display type

See Also:

• I_CmsADEWidget.getDefaultDisplayType()

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.

Specified by:

getDialogWidget in interface I_CmsWidget

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)

getInitCall

public String getInitCall()

Description copied from interface: I_CmsADEWidget

Returns the java script initialization call.

Specified by:

getInitCall in interface I_CmsADEWidget

Returns:

the java script initialization call

See Also:

• I_CmsADEWidget.getInitCall()

getJavaScriptResourceLinks

public List<String> getJavaScriptResourceLinks(CmsObject cms)

Description copied from interface: I_CmsADEWidget

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

Specified by:

getJavaScriptResourceLinks in interface I_CmsADEWidget

Parameters:

cms - the current OpenCms context

Returns:

the required java script resource links

See Also:

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

getWidgetName

public String getWidgetName()

Description copied from interface: I_CmsADEWidget

Returns the class name of the widget.

Specified by:

getWidgetName in interface I_CmsADEWidget

Returns:

the class name

See Also:

• I_CmsADEWidget.getWidgetName()

isInternal

public boolean isInternal()

Description copied from interface: I_CmsADEWidget

Returns if this is an internal widget.

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

Specified by:

isInternal in interface I_CmsADEWidget

Returns:

true if this is an internal widget

See Also:

• I_CmsADEWidget.isInternal()

newInstance

public I_CmsWidget newInstance()

Description copied from interface: I_CmsWidget

Creates a duplicate of this widget instance.

Specified by:

newInstance in interface I_CmsWidget

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)

addEmbeddedGalleryOptions

protected void addEmbeddedGalleryOptions(JSONObject result,
 CmsObject cms,
 A_CmsXmlContentValue schemaType,
 CmsMessages messages,
 CmsResource resource,
 Locale contentLocale)
                                  throws JSONException

Adds the configuration for embedded gallery widgets the the JSON object.

Parameters:

result - the JSON object to modify

cms - the OpenCms context

schemaType - the schema type

messages - the messages

resource - the edited resource

contentLocale - the content locale

Throws:

JSONException - in case JSON manipulation fails

getJSONConfiguration

protected JSONObject getJSONConfiguration(CmsObject cms,
 CmsResource resource,
 Locale contentLocale)

Returns the WYSIWYG editor configuration as a JSON object.

Parameters:

cms - the OpenCms context

resource - the edited resource

contentLocale - the edited content locale

Returns:

the configuration