Package com.jalios.jcms.taglib.settings.impl

Class WysiwygSettings

java.lang.Object

com.jalios.jcms.taglib.settings.BasicSettings<T>

com.jalios.jcms.taglib.settings.AbstractAreaSettings<WysiwygSettings>

com.jalios.jcms.taglib.settings.impl.WysiwygSettings

All Implemented Interfaces:

ControlSettings<WysiwygSettings>, java.lang.Cloneable

public class WysiwygSettings
extends AbstractAreaSettings<WysiwygSettings>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONFIGURATION_ID
static java.lang.String	DEFAULT_CONFIGURATION_ID
static java.lang.String	POPUP_EDITION
static java.lang.String	WORKSPACE

Fields inherited from class com.jalios.jcms.taglib.settings.AbstractAreaSettings

ROWS

Fields inherited from class com.jalios.jcms.taglib.settings.BasicSettings

APPEND, ARIA_ATTR_PREFIX, ARIA_ATTRIBUTES, AUTOFOCUS, CLEAR_BUTTON, CSS, DATA_ATTR_PREFIX, DATA_ATTRIBUTES, DISABLED, HIDE_CLEAR_BUTTON, HTML_ATTRIBUTES, ID, LANGUAGE_CHOOSER, MAX_LENGTH, NAME, PLACEHOLDER, PREPEND, READONLY, REQUIRED, TITLE, TRIGGER_ACTION, TRIGGER_EVENT, VALUE

Constructor Summary

Constructors

Constructor	Description
WysiwygSettings()

Method Summary

Modifier and Type	Method	Description
static void	addFrontEndDependencies(JcmsJspContext jcmsContext, java.lang.String configId)
WysiwygSettings	configurationId(java.lang.String configId)	Specify the ID of WYSIWYG configuration to use on the current control.
static java.util.Map<java.lang.String,java.lang.Object>	getGlobalOptions()	Return the map of the options that are common to all WYSIWYG editors.
protected WysiwygSettings	getThis()	Returns the exact type of the this reference. It's a way to recover the type of the this object in a class hierarchy (cf.
ControlType	getType()	Returns the ControlType related to the current ControlSettings implementation.
WysiwygSettings	inline()	Request the wysiwyg editor to be in TinyMCE inline mode.
WysiwygSettings	popupEdition()	Specify whether the WYSIWYG is displayed in popup edition mode.
static void	resetGlobalOptions()	Remove all global WYSIWYG options.
void	resolveOptions(TypeFieldEntry tfe)	Set options from the specified TypeFieldEntry.
static void	setGlobalOptions(java.util.Map<java.lang.String,java.lang.Object> globalOptions)	Set the options that are common to all WYSIWYG editors.
WysiwygSettings	workspace(Workspace workspace)	Specify the Workspace to use in the editor.
WysiwygSettings	workspace(java.lang.String workspaceId)	Specify the Workspace to use in the editor.

Methods inherited from class com.jalios.jcms.taglib.settings.AbstractAreaSettings

onChange, rows

Methods inherited from class com.jalios.jcms.taglib.settings.BasicSettings

addOption, append, aria, aria, autofocus, clearOption, clone, css, dataAttribute, dataAttributes, disable, getOption, getOptionNames, htmlAttributes, htmlAttributes, id, isChannelReady, maxLength, merge, name, onFocusOut, placeholder, prepend, readonly, removeOption, require, showLanguageChooser, sortSet, title, toStringArray, toStringArray, toStringArray, toStringArray, toStringArray, trigger, value

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIGURATION_ID

public static final java.lang.String DEFAULT_CONFIGURATION_ID

See Also:

Constant Field Values

CONFIGURATION_ID

public static final java.lang.String CONFIGURATION_ID

See Also:

Constant Field Values

POPUP_EDITION

public static final java.lang.String POPUP_EDITION

See Also:

Constant Field Values

WORKSPACE

public static final java.lang.String WORKSPACE

See Also:

Constant Field Values

Constructor Detail

WysiwygSettings

public WysiwygSettings()

Method Detail

getType

public ControlType getType()

Description copied from interface: ControlSettings

Returns the ControlType related to the current ControlSettings implementation.

Returns:

ControlType

getThis

protected WysiwygSettings getThis()

Description copied from class: BasicSettings

Returns the exact type of the this reference.
It's a way to recover the type of the this object in a class hierarchy (cf. getThis "trick").

Specified by:

getThis in class BasicSettings<WysiwygSettings>

Returns:

The exact type of the this reference

resolveOptions

public void resolveOptions(TypeFieldEntry tfe)

Description copied from interface: ControlSettings

Set options from the specified TypeFieldEntry.

Specified by:

resolveOptions in interface ControlSettings<WysiwygSettings>

Overrides:

resolveOptions in class AbstractAreaSettings<WysiwygSettings>

Parameters:

tfe - TypeFieldEntry

configurationId

public WysiwygSettings configurationId(java.lang.String configId)

Specify the ID of WYSIWYG configuration to use on the current control.

Parameters:

configId - WYSIWYG Configuration ID

Returns:

a reference to this object - used to chain calls

popupEdition

public WysiwygSettings popupEdition()

Specify whether the WYSIWYG is displayed in popup edition mode.

Returns:

a reference to this object - used to chain calls

workspace

public WysiwygSettings workspace(java.lang.String workspaceId)

Specify the Workspace to use in the editor.

Parameters:

workspaceId - Workspace ID

Returns:

a reference to this object - used to chain calls

workspace

public WysiwygSettings workspace(Workspace workspace)

Specify the Workspace to use in the editor.

Parameters:

workspace - Workspace

Returns:

a reference to this object - used to chain calls

setGlobalOptions

public static void setGlobalOptions(java.util.Map<java.lang.String,java.lang.Object> globalOptions)

Set the options that are common to all WYSIWYG editors.

Parameters:

globalOptions - Map of WYSIWYG options

getGlobalOptions

public static java.util.Map<java.lang.String,java.lang.Object> getGlobalOptions()

Return the map of the options that are common to all WYSIWYG editors.

Returns:

Map of global WYSIWYG options

resetGlobalOptions

public static void resetGlobalOptions()

Remove all global WYSIWYG options.

inline

public WysiwygSettings inline()

Request the wysiwyg editor to be in TinyMCE inline mode.

Returns:

a reference to this object - used to chain calls

Since:

jcms-10.0.5 / JCMS-8615

addFrontEndDependencies

public static void addFrontEndDependencies(JcmsJspContext jcmsContext,
                                           java.lang.String configId)