com.helger.tinymce4

Class HCTinyMCE4

java.lang.Object

com.helger.tinymce4.HCTinyMCE4

All Implemented Interfaces:

com.helger.html.hc.IHCNodeBuilder

public class HCTinyMCE4
extends Object
implements com.helger.html.hc.IHCNodeBuilder

Wraps TinyMCE4 into an HC node. The only required settings is setSelector(String) but this does not need to be called, as the default value DEFAULT_SELECTOR is used automatically.
Note: all options that are not explicitly wrapped can be set by addCustomOption(String, IJSExpression)

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_BROWSER_SPELLCHECK
static boolean	DEFAULT_CONVERT_FONTS_TO_SPANS
static boolean	DEFAULT_HIDDEN_INPUT
static boolean	DEFAULT_INLINE
static boolean	DEFAULT_MENUBAR_DISABLED
static boolean	DEFAULT_NOWRAP
static boolean	DEFAULT_OBJECT_RESIZING
static boolean	DEFAULT_PREVIEW_STYLES
static String	DEFAULT_SELECTOR
static boolean	DEFAULT_STATUSBAR
static boolean	DEFAULT_TOOLBAR_DISABLED

Constructor Summary

Constructors

Constructor and Description
HCTinyMCE4()

Method Summary

Methods

Modifier and Type	Method and Description
HCTinyMCE4	addAllPlugins() Add all available plugins there are.
HCTinyMCE4	addCustomOption(String sName, BigDecimal aValue)
HCTinyMCE4	addCustomOption(String sName, boolean bValue)
HCTinyMCE4	addCustomOption(String sName, double dValue)
HCTinyMCE4	addCustomOption(String sName, com.helger.html.js.builder.IJSExpression aValue)
HCTinyMCE4	addCustomOption(String sName, int nValue)
HCTinyMCE4	addCustomOption(String sName, String sValue)
HCTinyMCE4	addExternalPlugin(TinyMCE4ExternalPlugin aExternalPlugin) Add an external plugin to the editor.
HCTinyMCE4	addExternalPlugins(Iterable<? extends TinyMCE4ExternalPlugin> aExternalPlugins) Add multiple external plugins at once.
HCTinyMCE4	addExternalPlugins(TinyMCE4ExternalPlugin... aExternalPlugins) Add multiple external plugins at once.
HCTinyMCE4	addPlugin(ETinyMCE4Plugin ePlugin) Add a TinyMCE plugin to use.
HCTinyMCE4	addPlugins(ETinyMCE4Plugin... aPlugins) Add multiple TinyMCE plugins at once.
HCTinyMCE4	addPlugins(Iterable<ETinyMCE4Plugin> aPlugins) Add multiple TinyMCE plugins at once.
com.helger.html.hc.html.HCScript	build()
boolean	containsCustomOption(String sName)
Map<String,com.helger.html.js.builder.IJSExpression>	getAllCustomOptions()
Set<TinyMCE4ExternalPlugin>	getAllExternalPlugins()
Set<ETinyMCE4Plugin>	getAllPlugins()
String	getAutoFocus()
int	getCustomOptionCount()
com.helger.html.js.builder.IJSExpression	getCustomOptionValue(String sName)
com.helger.html.hc.api.EHCTextDirection	getDirectionality()
int	getExternalPluginCount()
com.helger.html.js.builder.JSAnonymousFunction	getFileBrowserCallback()
int	getHeight()
com.helger.html.js.builder.JSAssocArray	getJSInitOptions()
com.helger.html.js.builder.JSInvocation	getJSInvocation()
ETinyMCE4Language	getLanguage()
com.helger.commons.url.ISimpleURL	getLanguageURL()
TinyMCE4MenubarItemList	getMenubar()
int	getPluginCount()
ETinyMCE4Resize	getResize()
String	getSelector()
ETinyMCE4Skin	getSkin()
com.helger.commons.url.ISimpleURL	getSkinURL()
ETinyMCE4Theme	getTheme()
com.helger.commons.url.ISimpleURL	getThemeURL()
TinyMCE4ToolbarControlList	getToolbar()
int	getWidth()
boolean	isBrowserSpellcheck()
boolean	isConvertFontsToSpans()
boolean	isHiddenInput()
boolean	isInline()
boolean	isMenubarDisabled()
boolean	isNoWrap()
boolean	isObjectResizing()
boolean	isPreviewStyles()
boolean	isStatusbar()
boolean	isToolbarDisabled()
static void	registerExternalResources()
com.helger.html.js.builder.IJSExpression	removeCustomOption(String sName)
com.helger.commons.state.EChange	removeExternalPlugin(TinyMCE4ExternalPlugin aExternalPlugin) Remove the specified external plugin.
com.helger.commons.state.EChange	removeExternalPlugins(Iterable<? extends TinyMCE4ExternalPlugin> aExternalPlugins) Remove the specified external plugins.
com.helger.commons.state.EChange	removeExternalPlugins(TinyMCE4ExternalPlugin... aExternalPlugins) Remove the specified external plugins.
com.helger.commons.state.EChange	removePlugin(ETinyMCE4Plugin ePlugin) Remove the specified plugin.
com.helger.commons.state.EChange	removePlugins(ETinyMCE4Plugin... aPlugins) Remove the specified TinyMCE plugins.
com.helger.commons.state.EChange	removePlugins(Iterable<ETinyMCE4Plugin> aPlugins) Remove the specified TinyMCE plugins.
HCTinyMCE4	setAutoFocus(String sAutoFocus) This option enables you to auto focus an editor instance.
HCTinyMCE4	setBrowserSpellcheck(boolean bBrowserSpellcheck) This is a true/false value if the usage of the browsers internal spellchecker should be used.
HCTinyMCE4	setBrowserSpellcheck(Boolean aBrowserSpellcheck) This is a true/false value if the usage of the browsers internal spellchecker should be used.
HCTinyMCE4	setConvertFontsToSpans(boolean bConvertFontsToSpans) If you set this option to true, TinyMCE will convert all font elements to span elements and generate span elements instead of font elements.
HCTinyMCE4	setConvertFontsToSpans(Boolean aConvertFontsToSpans) If you set this option to true, TinyMCE will convert all font elements to span elements and generate span elements instead of font elements.
HCTinyMCE4	setDirectionality(com.helger.html.hc.api.EHCTextDirection eDirectionality) Set the default directionality of the editor.
HCTinyMCE4	setFileBrowserCallback(com.helger.html.js.builder.JSAnonymousFunction aFileBrowserCallback) This option enables you to add your own file browser/image browser to TinyMCE.
HCTinyMCE4	setHeight(int nHeight) Set the height of the editor.
HCTinyMCE4	setHiddenInput(boolean bHiddenInput) This option gives you the ability to disable the auto generation of hidden input fields for inline editing elements.
HCTinyMCE4	setHiddenInput(Boolean aHiddenInput) This option gives you the ability to disable the auto generation of hidden input fields for inline editing elements.
HCTinyMCE4	setInline(boolean bInline) This option changes the behaviour of the editor to allow the usage of inline elements instead of a textarea.
HCTinyMCE4	setInline(Boolean aInline) This option changes the behaviour of the editor to allow the usage of inline elements instead of a textarea.
HCTinyMCE4	setLanguage(ETinyMCE4Language eLanguage) Set the language of the UI texts
HCTinyMCE4	setLanguageURL(com.helger.commons.url.ISimpleURL aLanguageURL) A simple URL to where the language file to use.
HCTinyMCE4	setMenubar(TinyMCE4MenubarItemList aMenubar) This option allows you to configure the menus you want to appear in the menu bar.
HCTinyMCE4	setMenubarDisabled(boolean bMenubarDisabled) Manually enable or disable the toolbar.
HCTinyMCE4	setNoWrap(boolean bNoWrap) This option will make the editable are behave like very much like a <pre> tag, and add a scroll instead of wrapping text.
HCTinyMCE4	setNoWrap(Boolean aNoWrap) This option will make the editable are behave like very much like a <pre> tag, and add a scroll instead of wrapping text.
HCTinyMCE4	setObjectResizing(boolean bObjectResizing) This options allows you to turn on/off the resizing handles on images, tables or media objects.
HCTinyMCE4	setObjectResizing(Boolean aObjectResizing) This options allows you to turn on/off the resizing handles on images, tables or media objects.
HCTinyMCE4	setPreviewStyles(boolean bPreviewStyles) The enables you to turn of the preview of styles in format/style listboxes.
HCTinyMCE4	setPreviewStyles(Boolean aPreviewStyles) The enables you to turn of the preview of styles in format/style listboxes.
HCTinyMCE4	setResize(ETinyMCE4Resize eResize)
HCTinyMCE4	setSelector(String sSelector) Selector option, allows you to use CSS selector syntax for determining what areas should be editable, this is the recommended way of selecting what elements should be editable.
HCTinyMCE4	setSkin(ETinyMCE4Skin eSkin) Select what skin to use, this should match the foldername of the skin.
HCTinyMCE4	setSkinURL(com.helger.commons.url.ISimpleURL aSkinURL) This option enables you to specify location of the current skin.
HCTinyMCE4	setStatusbar(boolean bStatusbar) Show or hide the statusbar.
HCTinyMCE4	setStatusbar(Boolean aStatusbar) Show or hide the statusbar.
HCTinyMCE4	setTheme(ETinyMCE4Theme eTheme) Set the theme of TinyMCE.
HCTinyMCE4	setThemeURL(com.helger.commons.url.ISimpleURL aThemeURL) This option enables you to specify location of the current theme.
HCTinyMCE4	setToolbar(TinyMCE4ToolbarControlList aToolbar) This controls what buttons you want show up in the toolbar.
HCTinyMCE4	setToolbarDisabled(boolean bToolbarDisabled) Manually enable or disable the toolbar.
HCTinyMCE4	setWidth(int nWidth) Set the width of the editor.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BROWSER_SPELLCHECK

public static final boolean DEFAULT_BROWSER_SPELLCHECK

See Also:

Constant Field Values

DEFAULT_NOWRAP

public static final boolean DEFAULT_NOWRAP

See Also:

Constant Field Values

DEFAULT_OBJECT_RESIZING

public static final boolean DEFAULT_OBJECT_RESIZING

See Also:

Constant Field Values

DEFAULT_SELECTOR

public static final String DEFAULT_SELECTOR

See Also:

Constant Field Values

DEFAULT_INLINE

public static final boolean DEFAULT_INLINE

See Also:

Constant Field Values

DEFAULT_HIDDEN_INPUT

public static final boolean DEFAULT_HIDDEN_INPUT

See Also:

Constant Field Values

DEFAULT_CONVERT_FONTS_TO_SPANS

public static final boolean DEFAULT_CONVERT_FONTS_TO_SPANS

See Also:

Constant Field Values

DEFAULT_TOOLBAR_DISABLED

public static final boolean DEFAULT_TOOLBAR_DISABLED

See Also:

Constant Field Values

DEFAULT_MENUBAR_DISABLED

public static final boolean DEFAULT_MENUBAR_DISABLED

See Also:

Constant Field Values

DEFAULT_STATUSBAR

public static final boolean DEFAULT_STATUSBAR

See Also:

Constant Field Values

DEFAULT_PREVIEW_STYLES

public static final boolean DEFAULT_PREVIEW_STYLES

See Also:

Constant Field Values

Constructor Detail

HCTinyMCE4

public HCTinyMCE4()

Method Detail

getAutoFocus

@Nullable
public String getAutoFocus()

setAutoFocus

@Nonnull
public HCTinyMCE4 setAutoFocus(@Nullable
                              String sAutoFocus)

This option enables you to auto focus an editor instance. The value of this option should be an editor instance id. The editor instance id is the id for the original textarea or div element that got replaced.

Parameters:

sAutoFocus - Editor ID

Returns:

this

getDirectionality

@Nullable
public com.helger.html.hc.api.EHCTextDirection getDirectionality()

setDirectionality

@Nonnull
public HCTinyMCE4 setDirectionality(@Nullable
                                   com.helger.html.hc.api.EHCTextDirection eDirectionality)

 Set the default directionality of the editor.
 Possible values are:
 - ltr
  - rtl
 

Parameters:

eDirectionality - direction

Returns:

this

isBrowserSpellcheck

public boolean isBrowserSpellcheck()

setBrowserSpellcheck

@Nonnull
public HCTinyMCE4 setBrowserSpellcheck(boolean bBrowserSpellcheck)

This is a true/false value if the usage of the browsers internal spellchecker should be used. Default value is false.

Parameters:

bBrowserSpellcheck - true to enabled, false to disable

Returns:

this

setBrowserSpellcheck

@Nonnull
public HCTinyMCE4 setBrowserSpellcheck(@Nullable
                                      Boolean aBrowserSpellcheck)

This is a true/false value if the usage of the browsers internal spellchecker should be used. Default value is false.

Parameters:

aBrowserSpellcheck - true to enabled, false to disable and null for default value.

Returns:

this

getLanguage

@Nullable
public ETinyMCE4Language getLanguage()

setLanguage

@Nonnull
public HCTinyMCE4 setLanguage(@Nullable
                             ETinyMCE4Language eLanguage)

Set the language of the UI texts

Parameters:

eLanguage - The language to use. null means English

Returns:

this

getLanguageURL

@Nullable
public com.helger.commons.url.ISimpleURL getLanguageURL()

setLanguageURL

@Nonnull
public HCTinyMCE4 setLanguageURL(@Nullable
                                com.helger.commons.url.ISimpleURL aLanguageURL)

A simple URL to where the language file to use. We recommend using a site absolute URL.

Parameters:

aLanguageURL - The language URL to use.

Returns:

this

isNoWrap

public boolean isNoWrap()

setNoWrap

@Nonnull
public HCTinyMCE4 setNoWrap(boolean bNoWrap)

This option will make the editable are behave like very much like a <pre> tag, and add a scroll instead of wrapping text.

Parameters:

bNoWrap - true to enabled, false to disable

Returns:

this

setNoWrap

@Nonnull
public HCTinyMCE4 setNoWrap(@Nullable
                           Boolean aNoWrap)

This option will make the editable are behave like very much like a <pre> tag, and add a scroll instead of wrapping text.

Parameters:

aNoWrap - true to enabled, false to disable and null for default value.

Returns:

this

isObjectResizing

public boolean isObjectResizing()

setObjectResizing

@Nonnull
public HCTinyMCE4 setObjectResizing(boolean bObjectResizing)

This options allows you to turn on/off the resizing handles on images, tables or media objects.

Parameters:

bObjectResizing - true to enabled, false to disable

Returns:

this

setObjectResizing

@Nonnull
public HCTinyMCE4 setObjectResizing(@Nullable
                                   Boolean aObjectResizing)

This options allows you to turn on/off the resizing handles on images, tables or media objects.

Parameters:

aObjectResizing - true to enabled, false to disable and null for default value.

Returns:

this

getAllPlugins

@Nonnull
@ReturnsMutableCopy
public Set<ETinyMCE4Plugin> getAllPlugins()

getPluginCount

@Nonnegative
public int getPluginCount()

addPlugin

@Nonnull
public HCTinyMCE4 addPlugin(@Nonnull
                           ETinyMCE4Plugin ePlugin)

Add a TinyMCE plugin to use.

Parameters:

ePlugin - The plugin to add. May not be null.

Returns:

this

addPlugins

@Nonnull
public HCTinyMCE4 addPlugins(@Nullable
                            ETinyMCE4Plugin... aPlugins)

Add multiple TinyMCE plugins at once.

Parameters:

aPlugins - The plugins to add. The array may be null but the contained elements may not be null.

Returns:

this

addPlugins

@Nonnull
public HCTinyMCE4 addPlugins(@Nullable
                            Iterable<ETinyMCE4Plugin> aPlugins)

Add multiple TinyMCE plugins at once.

Parameters:

aPlugins - The plugins to add. The array may be null but the contained elements may not be null.

Returns:

this

addAllPlugins

@Nonnull
public HCTinyMCE4 addAllPlugins()

Add all available plugins there are.

Returns:

this

removePlugin

@Nonnull
public com.helger.commons.state.EChange removePlugin(@Nullable
                                                    ETinyMCE4Plugin ePlugin)

Remove the specified plugin.

Parameters:

ePlugin - The plugin to be removed. May be null.

Returns:

EChange.CHANGED if the plugin was successfully removed.

removePlugins

@Nonnull
public com.helger.commons.state.EChange removePlugins(@Nullable
                                                     ETinyMCE4Plugin... aPlugins)

Remove the specified TinyMCE plugins.

Parameters:

aPlugins - The plugins to be removed. May be null.

Returns:

EChange.CHANGED it at least one plugin was removed successfully.

removePlugins

@Nonnull
public com.helger.commons.state.EChange removePlugins(@Nullable
                                                     Iterable<ETinyMCE4Plugin> aPlugins)

Remove the specified TinyMCE plugins.

Parameters:

aPlugins - The plugins to be removed. May be null.

Returns:

EChange.CHANGED it at least one plugin was removed successfully.

getAllExternalPlugins

@Nonnull
@ReturnsMutableCopy
public Set<TinyMCE4ExternalPlugin> getAllExternalPlugins()

getExternalPluginCount

@Nonnegative
public int getExternalPluginCount()

addExternalPlugin

@Nonnull
public HCTinyMCE4 addExternalPlugin(@Nonnull
                                   TinyMCE4ExternalPlugin aExternalPlugin)

Add an external plugin to the editor.

Parameters:

aExternalPlugin - The plugin to be added. May not be null.

Returns:

this

addExternalPlugins

@Nonnull
public HCTinyMCE4 addExternalPlugins(@Nullable
                                    TinyMCE4ExternalPlugin... aExternalPlugins)

Add multiple external plugins at once.

Parameters:

aExternalPlugins - The plugins to be added. May be null but no contained plugin may be null.

Returns:

this

addExternalPlugins

@Nonnull
public HCTinyMCE4 addExternalPlugins(@Nullable
                                    Iterable<? extends TinyMCE4ExternalPlugin> aExternalPlugins)

Add multiple external plugins at once.

Parameters:

aExternalPlugins - The plugins to be added. May be null but no contained plugin may be null.

Returns:

this

removeExternalPlugin

@Nonnull
public com.helger.commons.state.EChange removeExternalPlugin(@Nullable
                                                            TinyMCE4ExternalPlugin aExternalPlugin)

Remove the specified external plugin.

Parameters:

aExternalPlugin - The plugin to be removed. May be null.

Returns:

EChange.CHANGED if the plugin was removed successfully.

removeExternalPlugins

@Nonnull
public com.helger.commons.state.EChange removeExternalPlugins(@Nullable
                                                             TinyMCE4ExternalPlugin... aExternalPlugins)

Remove the specified external plugins.

Parameters:

aExternalPlugins - The plugins to be removed. May be null.

Returns:

EChange.CHANGED it at least one plugin was removed successfully.

removeExternalPlugins

@Nonnull
public com.helger.commons.state.EChange removeExternalPlugins(@Nullable
                                                             Iterable<? extends TinyMCE4ExternalPlugin> aExternalPlugins)

Remove the specified external plugins.

Parameters:

aExternalPlugins - The plugins to be removed. May be null.

Returns:

EChange.CHANGED it at least one plugin was removed successfully.

getSelector

@Nonnull
@Nonempty
public String getSelector()

Returns:

The jQuery selector to be used to convert nodes to TinyMCE elements.

setSelector

@Nonnull
public HCTinyMCE4 setSelector(@Nonnull@Nonempty
                             String sSelector)

 Selector option, allows you to use CSS selector syntax for determining what areas should be editable, this is the recommended way of selecting what elements should be editable.
 Some examples of usage.
 This would select all textarea elements in the page.
 selector: "textarea",
 This would select all textareas with the class .editme in your page.
 selector: "textarea.editme",
 If you use the inline option, the selector can be used on any block element.
 selector: "h1.editme",
 selector: "div.editme",
 

Parameters:

sSelector - The selector to use. May neither be null nor empty.

Returns:

this

getSkin

@Nullable
public ETinyMCE4Skin getSkin()

setSkin

@Nonnull
public HCTinyMCE4 setSkin(@Nullable
                         ETinyMCE4Skin eSkin)

Select what skin to use, this should match the foldername of the skin.

Parameters:

eSkin - Skin to use. May be null.

Returns:

this

getSkinURL

@Nullable
public com.helger.commons.url.ISimpleURL getSkinURL()

setSkinURL

@Nonnull
public HCTinyMCE4 setSkinURL(@Nullable
                            com.helger.commons.url.ISimpleURL aSkinURL)

This option enables you to specify location of the current skin. Enables you to load TinyMCE from one URL for example a CDN then load a local skin on the current server.

Parameters:

aSkinURL - The skin URL to use.

Returns:

this

getTheme

@Nullable
public ETinyMCE4Theme getTheme()

setTheme

@Nonnull
public HCTinyMCE4 setTheme(@Nullable
                          ETinyMCE4Theme eTheme)

Set the theme of TinyMCE.

Parameters:

eTheme - Theme to use.

Returns:

this

getThemeURL

@Nullable
public com.helger.commons.url.ISimpleURL getThemeURL()

setThemeURL

@Nonnull
public HCTinyMCE4 setThemeURL(@Nullable
                             com.helger.commons.url.ISimpleURL aThemeURL)

This option enables you to specify location of the current theme. Enables you to load TinyMCE from one URL for example a CDN then load a local theme on the current server.

Parameters:

aThemeURL - The theme URL to use.

Returns:

this

isInline

public boolean isInline()

setInline

@Nonnull
public HCTinyMCE4 setInline(boolean bInline)

This option changes the behaviour of the editor to allow the usage of inline elements instead of a textarea.

Parameters:

bInline - true to enabled, false to disable

Returns:

this

setInline

@Nonnull
public HCTinyMCE4 setInline(@Nullable
                           Boolean aInline)

This option changes the behaviour of the editor to allow the usage of inline elements instead of a textarea.

Parameters:

aInline - true to enabled, false to disable and null for default value.

Returns:

this

isHiddenInput

public boolean isHiddenInput()

setHiddenInput

@Nonnull
public HCTinyMCE4 setHiddenInput(boolean bHiddenInput)

This option gives you the ability to disable the auto generation of hidden input fields for inline editing elements. By default all inline editors gets an hidden input element that contents gets saved to when you do editor.save() or tinymce.triggerSave(); this can be disabled if you don't need these controls.

Parameters:

bHiddenInput - true to enabled, false to disable

Returns:

this

setHiddenInput

@Nonnull
public HCTinyMCE4 setHiddenInput(@Nullable
                                Boolean aHiddenInput)

This option gives you the ability to disable the auto generation of hidden input fields for inline editing elements. By default all inline editors gets an hidden input element that contents gets saved to when you do editor.save() or tinymce.triggerSave(); this can be disabled if you don't need these controls.

Parameters:

aHiddenInput - true to enabled, false to disable and null for default value.

Returns:

this

isConvertFontsToSpans

public boolean isConvertFontsToSpans()

setConvertFontsToSpans

@Nonnull
public HCTinyMCE4 setConvertFontsToSpans(boolean bConvertFontsToSpans)

If you set this option to true, TinyMCE will convert all font elements to span elements and generate span elements instead of font elements. This option should be used in order to get more W3C compatible code, since font elements are deprecated.

Parameters:

bConvertFontsToSpans - true to enabled, false to disable

Returns:

this

setConvertFontsToSpans

@Nonnull
public HCTinyMCE4 setConvertFontsToSpans(@Nullable
                                        Boolean aConvertFontsToSpans)

If you set this option to true, TinyMCE will convert all font elements to span elements and generate span elements instead of font elements. This option should be used in order to get more W3C compatible code, since font elements are deprecated.

Parameters:

aConvertFontsToSpans - true to enabled, false to disable and null for default value.

Returns:

this

getToolbar

@Nullable
@ReturnsMutableObject(reason="Design")
public TinyMCE4ToolbarControlList getToolbar()

setToolbar

@Nonnull
public HCTinyMCE4 setToolbar(@Nullable
                            TinyMCE4ToolbarControlList aToolbar)

This controls what buttons you want show up in the toolbar.

Parameters:

aToolbar - The toolbar to be set. May be null. If not null a clone of the object is stored.

Returns:

this

isToolbarDisabled

public boolean isToolbarDisabled()

setToolbarDisabled

@Nonnull
public HCTinyMCE4 setToolbarDisabled(boolean bToolbarDisabled)

Manually enable or disable the toolbar.

Parameters:

bToolbarDisabled - true to disable it

Returns:

this

getMenubar

@Nullable
@ReturnsMutableObject(reason="Design")
public TinyMCE4MenubarItemList getMenubar()

setMenubar

@Nonnull
public HCTinyMCE4 setMenubar(@Nullable
                            TinyMCE4MenubarItemList aMenubar)

This option allows you to configure the menus you want to appear in the menu bar.

Parameters:

aMenubar - The menu bar to be set. May be null. If not null a clone of the object is stored.

Returns:

this

isMenubarDisabled

public boolean isMenubarDisabled()

setMenubarDisabled

@Nonnull
public HCTinyMCE4 setMenubarDisabled(boolean bMenubarDisabled)

Manually enable or disable the toolbar.

Parameters:

bMenubarDisabled - true to disable it

Returns:

this

isStatusbar

public boolean isStatusbar()

setStatusbar

@Nonnull
public HCTinyMCE4 setStatusbar(boolean bStatusbar)

Show or hide the statusbar.

Parameters:

bStatusbar - true to show, false to hide

Returns:

this

setStatusbar

@Nonnull
public HCTinyMCE4 setStatusbar(@Nullable
                              Boolean aStatusbar)

Show or hide the statusbar.

Parameters:

aStatusbar - true to show, false to hide and null for default value.

Returns:

this

getResize

@Nullable
public ETinyMCE4Resize getResize()

setResize

@Nonnull
public HCTinyMCE4 setResize(@Nullable
                           ETinyMCE4Resize eResize)

getWidth

public int getWidth()

setWidth

@Nonnull
public HCTinyMCE4 setWidth(int nWidth)

Set the width of the editor.

Parameters:

nWidth - New width. Only values >= 0 are considered!

Returns:

this

getHeight

public int getHeight()

setHeight

@Nonnull
public HCTinyMCE4 setHeight(int nHeight)

Set the height of the editor.

Parameters:

nHeight - New height. Only values >= 0 are considered!

Returns:

this

isPreviewStyles

public boolean isPreviewStyles()

setPreviewStyles

@Nonnull
public HCTinyMCE4 setPreviewStyles(boolean bPreviewStyles)

The enables you to turn of the preview of styles in format/style listboxes. It's turned on by default.

Parameters:

bPreviewStyles - true to show, false to hide

Returns:

this

setPreviewStyles

@Nonnull
public HCTinyMCE4 setPreviewStyles(@Nullable
                                  Boolean aPreviewStyles)

The enables you to turn of the preview of styles in format/style listboxes. It's turned on by default.

Parameters:

aPreviewStyles - true to show, false to hide and null for default value.

Returns:

this

getFileBrowserCallback

@Nullable
public com.helger.html.js.builder.JSAnonymousFunction getFileBrowserCallback()

setFileBrowserCallback

@Nonnull
public HCTinyMCE4 setFileBrowserCallback(@Nullable
                                        com.helger.html.js.builder.JSAnonymousFunction aFileBrowserCallback)

This option enables you to add your own file browser/image browser to TinyMCE. If this option is set with a value a browse button will appear in different dialogues such as "insert/edit link" or "insert/edit image". If this option hasn't got a value set (or equals to false or null) the dialogues in question won't show any browse button. This function is executed each time a user clicks on the "browse" buttons in various dialogues. The format of this callback function is: fileBrowser(field_name, url, type, win) where field_name is the id/name of the form element that the browser should insert its URL into. The url parameter contains the URL value that is currently inside the field. The type parameter contains what type of browser to present; this value can be file, image or flash depending on what dialogue is calling the function. The win parameter contains a reference to the dialog/window that executes the function.

Parameters:

aFileBrowserCallback - Callback function

Returns:

this

addCustomOption

@Nonnull
public HCTinyMCE4 addCustomOption(@Nonnull@Nonempty
                                 String sName,
                                 boolean bValue)

addCustomOption

@Nonnull
public HCTinyMCE4 addCustomOption(@Nonnull@Nonempty
                                 String sName,
                                 int nValue)

addCustomOption

@Nonnull
public HCTinyMCE4 addCustomOption(@Nonnull@Nonempty
                                 String sName,
                                 double dValue)

addCustomOption

@Nonnull
public HCTinyMCE4 addCustomOption(@Nonnull@Nonempty
                                 String sName,
                                 @Nonnull
                                 BigDecimal aValue)

addCustomOption

@Nonnull
public HCTinyMCE4 addCustomOption(@Nonnull@Nonempty
                                 String sName,
                                 @Nonnull
                                 String sValue)

addCustomOption

@Nonnull
public HCTinyMCE4 addCustomOption(@Nonnull@Nonempty
                                 String sName,
                                 @Nonnull
                                 com.helger.html.js.builder.IJSExpression aValue)

removeCustomOption

@Nullable
public com.helger.html.js.builder.IJSExpression removeCustomOption(@Nullable
                                                                   String sName)

getAllCustomOptions

@Nonnull
@ReturnsMutableCopy
public Map<String,com.helger.html.js.builder.IJSExpression> getAllCustomOptions()

containsCustomOption

public boolean containsCustomOption(@Nullable
                           String sName)

getCustomOptionValue

@Nullable
public com.helger.html.js.builder.IJSExpression getCustomOptionValue(@Nullable
                                                                     String sName)

getCustomOptionCount

@Nonnegative
public int getCustomOptionCount()

getJSInitOptions

@Nonnull
@ReturnsMutableCopy
public com.helger.html.js.builder.JSAssocArray getJSInitOptions()

getJSInvocation

@Nonnull
public com.helger.html.js.builder.JSInvocation getJSInvocation()

Returns:

The JSInvocation with the tinymce.init code and all options specified for this instance.

build

@Nonnull
public com.helger.html.hc.html.HCScript build()

Specified by:

build in interface com.helger.html.hc.IHCNodeBuilder

registerExternalResources

public static void registerExternalResources()