org.sakaiproject.profile2.tool.components

Class CKEditorTextArea

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

org.apache.wicket.markup.html.form.FormComponent<T>

org.apache.wicket.markup.html.form.AbstractTextComponent<T>

org.apache.wicket.markup.html.form.TextArea<String>

org.sakaiproject.profile2.tool.components.CKEditorTextArea

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.form.IFormModelUpdateListener, org.apache.wicket.markup.html.form.IFormVisitorParticipant, org.apache.wicket.markup.html.form.ILabelProvider<String>

public class CKEditorTextArea
extends org.apache.wicket.markup.html.form.TextArea<String>

Extends a wicket TextArea to create a CKEditor instance. Each instance can be individually configured by using the setEditorConfig and the setCallbackFunction. The advantage is that you can have multiple CKEditors in the page each with a custom configuration. Uses the editor from sakai library. NOTE: In order to have this component working on IE, the WicketApplication must set the javascript compressor to null. ex: this.getResourceSettings().setJavascriptCompressor(null);

Aditional Notes: The recommended jQuery version is 1.7.2, if you have an older version we recommend upgrading to a more recent jQuery version.

Author:

Bogdan Mariesan, ISDC!

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CKEditorTextArea.CKEditorAjaxSubmitModifier Behavior for updating all editors from page.

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.AbstractTextComponent

org.apache.wicket.markup.html.form.AbstractTextComponent.ITextFormatProvider

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.FormComponent

org.apache.wicket.markup.html.form.FormComponent.AbstractVisitor, org.apache.wicket.markup.html.form.FormComponent.IVisitor

Nested classes/interfaces inherited from class org.apache.wicket.Component

org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.VisibilityChange

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVE_KEYSTROKES Used to configure active keystrokes.
static String	ACTIVE_KEYSTROKES_VALUES Used to configure active keystrokes.
static String	BASIC_ENTITIES CKEDITOR basic entities - key.
static String	BLOCKED_KEYSTROKES Used to configure lockedKeystrokes.
static String	BLOCKED_KEYSTROKES_VALUES Used to configure lockedKeystrokes.
static String	CKEDITOR_ENTER_BR CKEDITOR CKEDITOR_ENTER_BR - key.
static String	CONFIG_ALIGN CKEDITOR align - key.
static String	CONFIG_HEIGHT CKEDITOR height - key.
static String	CONFIG_TOOLBAR CKEDITOR toolbar - key.
static String	CONFIG_WIDTH CKEDITOR width - key.
static String	DECORATOR_FUNCTION_UPDATE_ALL Decorator to update all.
static String	ELEMENTS_PATH CKEDITOR elementspath plugin - key.
static String	ENTER_MODE CKEDITOR enterMode - key.
static String	ENTITIES CKEDITOR entities - key.
static String	EXTRA_PLUGINS CKEDITOR extraPlugins - key.
static String	HTML_ENCODE_OUTPUT CKEDITOR htmlEncodeOutput - key.
static String	LANGUAGE_CONFIG Used to configure language.
static String	REMOVE_FORMAT_TAGS CKEDITOR removeFormatTags - key.
static String	REMOVE_PLUGINS CKEDITOR removePlugins - key.
static String	RESIZE_ENABLED CKEDITOR resize_enabled - key.
static String	SHIFT_ENTER_MODE CKEDITOR shiftEnterMode - key.
static String	SKIN CKEDITOR skin - key.
static String	SKIN_V2 CKEDITOR skin - key.
static String	TOOLBAR_FULL CKEDITOR full toolbar - key.

Fields inherited from class org.apache.wicket.markup.html.form.FormComponent

FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
CKEditorTextArea(String id) Basic constructor.
CKEditorTextArea(String id, boolean shouldCkInstanceRemoveInstance) Basic constructor.
CKEditorTextArea(String id, org.apache.wicket.model.IModel<String> model) Basic constructor.
CKEditorTextArea(String id, org.apache.wicket.model.IModel<String> model, boolean shouldCkInstanceRemoveInstance) Basic constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	createDestroyMethod()
org.apache.wicket.ajax.calldecorator.AjaxCallDecorator	getAjaxCallDecoratedToUpdateElement() Gets the ajax decorator that can be used to update the current element.
static org.apache.wicket.ajax.calldecorator.AjaxCallDecorator	getAjaxCallDecoratedToUpdateElementForAllEditorsOnPage() Gets the ajax decorator that can be used to update the all ckeditors on page.
String	getInputName()
protected void	onRemove()
void	setCallbackFunction(String callbackFunctionParam) Sets the callback function for the CKEDITOR.
void	setEditorConfig(Map<String,String> config) Sets custom config for the CKEDITOR.

Methods inherited from class org.apache.wicket.markup.html.form.TextArea

onComponentTagBody

Methods inherited from class org.apache.wicket.markup.html.form.AbstractTextComponent

convertInput, convertValue, getConvertEmptyInputStringToNull, isInputNullable, onBeforeRender, setConvertEmptyInputStringToNull, supportsPersistence

Methods inherited from class org.apache.wicket.markup.html.form.FormComponent

add, add, checkRequired, clearInput, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getModel, getModelObject, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isMultiPart, isPersistent, isRequired, isValid, newValidatable, onComponentTag, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setModelValue, setPersistent, setRequired, setType, shouldTrimInput, trim, updateModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

getLabel, setLabelInternal

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onAfterRenderChildren, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeginRequest, onConfigure, onEndRequest, onInitialize, onModelChanged, onModelChanging, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Field Detail

DECORATOR_FUNCTION_UPDATE_ALL

public static final String DECORATOR_FUNCTION_UPDATE_ALL

Decorator to update all.

See Also:

Constant Field Values

CONFIG_HEIGHT

public static final String CONFIG_HEIGHT

CKEDITOR height - key.

See Also:

Constant Field Values

CONFIG_WIDTH

public static final String CONFIG_WIDTH

CKEDITOR width - key.

See Also:

Constant Field Values

CONFIG_TOOLBAR

public static final String CONFIG_TOOLBAR

CKEDITOR toolbar - key.

See Also:

Constant Field Values

TOOLBAR_FULL

public static final String TOOLBAR_FULL

CKEDITOR full toolbar - key.

See Also:

Constant Field Values

CONFIG_ALIGN

public static final String CONFIG_ALIGN

CKEDITOR align - key.

See Also:

Constant Field Values

HTML_ENCODE_OUTPUT

public static final String HTML_ENCODE_OUTPUT

CKEDITOR htmlEncodeOutput - key.

See Also:

Constant Field Values

ENTITIES

public static final String ENTITIES

CKEDITOR entities - key.

See Also:

Constant Field Values

BASIC_ENTITIES

public static final String BASIC_ENTITIES

CKEDITOR basic entities - key.

See Also:

Constant Field Values

SKIN

public static final String SKIN

CKEDITOR skin - key.

See Also:

Constant Field Values

SKIN_V2

public static final String SKIN_V2

CKEDITOR skin - key.

See Also:

Constant Field Values

EXTRA_PLUGINS

public static final String EXTRA_PLUGINS

CKEDITOR extraPlugins - key.

See Also:

Constant Field Values

REMOVE_PLUGINS

public static final String REMOVE_PLUGINS

CKEDITOR removePlugins - key.

See Also:

Constant Field Values

ELEMENTS_PATH

public static final String ELEMENTS_PATH

CKEDITOR elementspath plugin - key.

See Also:

Constant Field Values

RESIZE_ENABLED

public static final String RESIZE_ENABLED

CKEDITOR resize_enabled - key.

See Also:

Constant Field Values

REMOVE_FORMAT_TAGS

public static final String REMOVE_FORMAT_TAGS

CKEDITOR removeFormatTags - key.

See Also:

Constant Field Values

SHIFT_ENTER_MODE

public static final String SHIFT_ENTER_MODE

CKEDITOR shiftEnterMode - key.

See Also:

Constant Field Values

ENTER_MODE

public static final String ENTER_MODE

CKEDITOR enterMode - key.

See Also:

Constant Field Values

CKEDITOR_ENTER_BR

public static final String CKEDITOR_ENTER_BR

CKEDITOR CKEDITOR_ENTER_BR - key.

See Also:

Constant Field Values

LANGUAGE_CONFIG

public static final String LANGUAGE_CONFIG

Used to configure language.

See Also:

Constant Field Values

BLOCKED_KEYSTROKES

public static final String BLOCKED_KEYSTROKES

Used to configure lockedKeystrokes.

See Also:

Constant Field Values

BLOCKED_KEYSTROKES_VALUES

public static final String BLOCKED_KEYSTROKES_VALUES

Used to configure lockedKeystrokes.

See Also:

Constant Field Values

ACTIVE_KEYSTROKES

public static final String ACTIVE_KEYSTROKES

Used to configure active keystrokes. A blocked keystroke overridden with an active one will be active.

See Also:

Constant Field Values

ACTIVE_KEYSTROKES_VALUES

public static final String ACTIVE_KEYSTROKES_VALUES

Used to configure active keystrokes. A blocked keystroke overridden with an active one will be active.

See Also:

Constant Field Values

Constructor Detail

CKEditorTextArea

public CKEditorTextArea(String id)

Basic constructor. NOTE: In order to have this component working on IE, the wicket application must set the javascript compressor to null. ex: this.getResourceSettings().setJavascriptCompressor(null);

Parameters:

id - component id.

CKEditorTextArea

public CKEditorTextArea(String id,
                boolean shouldCkInstanceRemoveInstance)

Basic constructor. NOTE: In order to have this component working on IE, the wicket application must set the javascript compressor to null. ex: this.getResourceSettings().setJavascriptCompressor(null);

Parameters:

id - component id.

shouldCkInstanceRemoveInstance - If the ck instance should be removed when destroying wicket component. Normally should always be true, but we saw that calling a js in onRemove function causes some loading problems in wicket. We saw that this is working if the editor is used in repeaters but not if the editor is used in a normal way. That is why default is false.

CKEditorTextArea

public CKEditorTextArea(String id,
                org.apache.wicket.model.IModel<String> model,
                boolean shouldCkInstanceRemoveInstance)

Basic constructor. NOTE: In order to have this component working on IE, the wicket application must set the javascript compressor to null. ex: this.getResourceSettings().setJavascriptCompressor(null);

Parameters:

id - the wicket component id.

model - the wicket component model.

shouldCkInstanceRemoveInstance - If the ck instance should be removed when destroying wicket component. Normally should always be true, but we saw that calling a js in onRemove function causes some loading problems in wicket. We saw that this is working if the editor is used in repeaters but not if the editor is used in a normal way. That is why default is false.

CKEditorTextArea

public CKEditorTextArea(String id,
                org.apache.wicket.model.IModel<String> model)

Basic constructor. NOTE: In order to have this component working on IE, the wicket application must set the javascript compressor to null. ex: this.getResourceSettings().setJavascriptCompressor(null);

Parameters:

id - the wicket component id.

model - the wicket component model.

Method Detail

onRemove

protected void onRemove()

Overrides:

onRemove in class org.apache.wicket.Component

createDestroyMethod

protected String createDestroyMethod()

Returns:

the destroy method

getInputName

public String getInputName()

Overrides:

getInputName in class org.apache.wicket.markup.html.form.FormComponent<String>

setEditorConfig

public void setEditorConfig(Map<String,String> config)

Sets custom config for the CKEDITOR. The config must be passed as a key value map where the key stands for the desired configuration option and the value for the configuration value for that option.

Parameters:

config - the config map.

setCallbackFunction

public void setCallbackFunction(String callbackFunctionParam)

Sets the callback function for the CKEDITOR.

Parameters:

callbackFunctionParam - the callbackFunction to set

getAjaxCallDecoratedToUpdateElementForAllEditorsOnPage

public static final org.apache.wicket.ajax.calldecorator.AjaxCallDecorator getAjaxCallDecoratedToUpdateElementForAllEditorsOnPage()

Gets the ajax decorator that can be used to update the all ckeditors on page.

Returns:

decorator that updates all elements

getAjaxCallDecoratedToUpdateElement

public org.apache.wicket.ajax.calldecorator.AjaxCallDecorator getAjaxCallDecoratedToUpdateElement()

Gets the ajax decorator that can be used to update the current element.

Returns:

decorator that updates the element