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 java.util.Map<java.lang.String,java.lang.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(java.lang.String configuration)
Creates a new html editing widget with the given configuration.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addEmbeddedGalleryOptions(JSONObject result, CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
Adds the configuration for embedded gallery widgets the the JSON object.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
getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
Generates the necessary JavaScript inclusion code for this widget.java.lang.String
getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog)
Generates the initialisation method JavaScript code for this widget.java.lang.String
getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog)
Generates the initialization method JavaScript code for 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
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.protected JSONObject
getJSONConfiguration(CmsObject cms, CmsResource resource, java.util.Locale contentLocale)
Returns the WYSIWYG editor configuration as a JSON object.static JSONObject
getJSONConfiguration(CmsHtmlWidgetOption widgetOptions, CmsObject cms, CmsResource resource, java.util.Locale contentLocale)
Returns the WYSIWYG editor configuration as a JSON object.static java.lang.String
getTinyMceBlockFormats(java.lang.String formatSelectOptions)
Gets the block format configuration string for TinyMCE from the configured format select options.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.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.-
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 Detail
-
TINYMCE_DEFAULT_BLOCK_FORMAT_LABELS
public static final java.util.Map<java.lang.String,java.lang.String> TINYMCE_DEFAULT_BLOCK_FORMAT_LABELS
Labels for the default block format options.
-
-
Constructor Detail
-
CmsHtmlWidget
public CmsHtmlWidget()
Creates a new html editing widget.
-
CmsHtmlWidget
public CmsHtmlWidget(java.lang.String configuration)
Creates a new html editing widget with the given configuration.- Parameters:
configuration
- the configuration to use
-
-
Method Detail
-
getJSONConfiguration
public static JSONObject getJSONConfiguration(CmsHtmlWidgetOption widgetOptions, CmsObject cms, CmsResource resource, java.util.Locale contentLocale)
Returns the WYSIWYG editor configuration as a JSON object.- Parameters:
widgetOptions
- the options for the wysiwyg widgetcms
- the OpenCms contextresource
- the edited resourcecontentLocale
- the edited content locale- Returns:
- the configuration
-
getTinyMceBlockFormats
public static java.lang.String getTinyMceBlockFormats(java.lang.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 java.lang.String getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
Description copied from interface:I_CmsADEWidget
Returns the configuration string for the ADE content editor widget.- Specified by:
getConfiguration
in interfaceI_CmsADEWidget
- Parameters:
cms
- the OpenCms contextschemaType
- the schema typemessages
- the messagesresource
- the edited resourcecontentLocale
- 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 java.util.List<java.lang.String> getCssResourceLinks(CmsObject cms)
Description copied from interface:I_CmsADEWidget
Returns a list of CSS resources required by the widget.- Specified by:
getCssResourceLinks
in interfaceI_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 interfaceI_CmsADEWidget
- Returns:
- the default display type
- See Also:
I_CmsADEWidget.getDefaultDisplayType()
-
getDialogIncludes
public java.lang.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 interfaceI_CmsWidget
- Overrides:
getDialogIncludes
in classA_CmsWidget
- Parameters:
cms
- the current users OpenCms contextwidgetDialog
- 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 java.lang.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 interfaceI_CmsWidget
- Overrides:
getDialogInitCall
in classA_CmsWidget
- Parameters:
cms
- the current users OpenCms contextwidgetDialog
- 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 java.lang.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 interfaceI_CmsWidget
- Overrides:
getDialogInitMethod
in classA_CmsWidget
- Parameters:
cms
- an initialized instance of a CmsObjectwidgetDialog
- 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 java.lang.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 interfaceI_CmsWidget
- Parameters:
cms
- an initialized instance of a CmsObjectwidgetDialog
- the dialog where the widget is used onparam
- 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 java.lang.String getInitCall()
Description copied from interface:I_CmsADEWidget
Returns the java script initialization call.- Specified by:
getInitCall
in interfaceI_CmsADEWidget
- Returns:
- the java script initialization call
- See Also:
I_CmsADEWidget.getInitCall()
-
getJavaScriptResourceLinks
public java.util.List<java.lang.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 interfaceI_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 java.lang.String getWidgetName()
Description copied from interface:I_CmsADEWidget
Returns the class name of the widget.- Specified by:
getWidgetName
in interfaceI_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 interfaceI_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 interfaceI_CmsWidget
- Returns:
- a duplicate of this widget instance
- See Also:
I_CmsWidget.newInstance()
-
setEditorValue
public void setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.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 interfaceI_CmsWidget
- Overrides:
setEditorValue
in classA_CmsHtmlWidget
- Parameters:
cms
- the current users OpenCms contextformParameters
- the map of parameters to get the value fromwidgetDialog
- the dialog where the widget is used onparam
- 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, java.util.Locale contentLocale) throws JSONException
Adds the configuration for embedded gallery widgets the the JSON object.- Parameters:
result
- the JSON object to modifycms
- the OpenCms contextschemaType
- the schema typemessages
- the messagesresource
- the edited resourcecontentLocale
- the content locale- Throws:
JSONException
- in case JSON manipulation fails
-
getJSONConfiguration
protected JSONObject getJSONConfiguration(CmsObject cms, CmsResource resource, java.util.Locale contentLocale)
Returns the WYSIWYG editor configuration as a JSON object.- Parameters:
cms
- the OpenCms contextresource
- the edited resourcecontentLocale
- the edited content locale- Returns:
- the configuration
-
-