Package org.opencms.workplace.editors

Class CmsTinyMceToolbarHelper

java.lang.Object

org.opencms.workplace.editors.CmsTinyMceToolbarHelper

public final class CmsTinyMceToolbarHelper
extends Object

This class is used to help constructing the TinyMCE toolbar configuration, both for client-side and server-side code.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUTTON_TRANSLATION	The translation of the generic widget button names to TinyMCE specific button names.
static final Map<String,String>	BUTTON_TRANSLATION_MAP	The map containing the translation of the generic widget button names to TinyMCE specific button names.

Method Summary

Modifier and Type	Method	Description
static String	createTinyMceToolbarStringFromGenericToolbarItems(List<String> barItems)	Helper method to generate a TinyMCE-specific toolbar configuration string from a list of generic toolbar button names.
static String	getContextMenuEntries(List<String> barItems)	Returns the context menu entries according to the configured tool-bar items.
static String	translateButton(String cmsButtonName)	Translates a generic button name to a TinyMCE-specific button name (or a comma-separated list of button names).

Methods inherited from class java.lang.Object

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

Field Details

BUTTON_TRANSLATION

public static final String BUTTON_TRANSLATION

The translation of the generic widget button names to TinyMCE specific button names.

See Also:

• Constant Field Values

BUTTON_TRANSLATION_MAP

public static final Map<String,String> BUTTON_TRANSLATION_MAP

The map containing the translation of the generic widget button names to TinyMCE specific button names.

Method Details

createTinyMceToolbarStringFromGenericToolbarItems

public static String createTinyMceToolbarStringFromGenericToolbarItems(List<String> barItems)

Helper method to generate a TinyMCE-specific toolbar configuration string from a list of generic toolbar button names.

Parameters:

barItems - the generic toolbar items

Returns:

the TinyMCE toolbar configuration string

getContextMenuEntries

public static String getContextMenuEntries(List<String> barItems)

Returns the context menu entries according to the configured tool-bar items.

Parameters:

barItems - the tool-bar items

Returns:

the context menu entries

translateButton

public static String translateButton(String cmsButtonName)

Translates a generic button name to a TinyMCE-specific button name (or a comma-separated list of button names).

Parameters:

cmsButtonName - the generic button name

Returns:

the TinyMCE button name(s)