com.neurosys.site.wicket.components

Class CkEditorWrapper

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

com.neurosys.site.wicket.components.CkEditorWrapper

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor

public class CkEditorWrapper
extends org.apache.wicket.markup.html.WebMarkupContainer
implements org.apache.wicket.markup.html.IHeaderContributor

A Wicket wrapper to a CK Editor that can be invoked dynamically and multiple times on a page.
Note, this class assumes you are using CK Editor and the container markup contains imports to the necerssary libraries & css.
This code will not import the libraries, but it will inject the dynamic configuraton in JavaScript for each editor in the header.
Note: This is kept as a WebMarkupContainer and not a Panel so that we explicitly state the Markup in the calling component, so its flexible to tweak and modify. One can also override this component and use in a Panel if we wish to associate markup.

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CkEditorWrapper.CKEditorConfigs

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

org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.IVisitor<T extends org.apache.wicket.Component>, org.apache.wicket.Component.VisibilityChange

Field Summary

Fields

Modifier and Type	Field and Description
static net.sf.json.util.PropertyFilter	ckPropertyFilter
protected CkEditorWrapper.CKEditorConfigs	config
protected String	editorId

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, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
CkEditorWrapper(String id, org.apache.wicket.model.IModel<String> contentModel, String editorId)

Method Summary

Modifier and Type	Method and Description
protected void	addCustomControls(org.apache.wicket.markup.html.WebMarkupContainer c) In addition to main CkEditor, there may be added plugins, custom plugins we can add their behaviors here.
protected void	addElements(org.apache.wicket.markup.html.WebMarkupContainer c) Assumes custom functions createEditor() & removeEditor() exist and the markup exist for:
CkEditorWrapper.CKEditorConfigs	getConfigs()
List<String>	getCss() All the CSS path that should be imported into the editor
protected org.apache.wicket.markup.html.WebMarkupContainer	getExtraButtonsContainer(org.apache.wicket.markup.html.WebMarkupContainer parent) An empty container is provided next to the last button to add new buttons via API if needed dynamically
protected String	getRenderHead()
void	onInitialize()
void	renderHead(org.apache.wicket.markup.html.IHeaderResponse response)

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, onComponentTagBody, 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, 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, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onComponentTag, onConfigure, onDetach, onEndRequest, onModelChanged, onModelChanging, onRemove, 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

config

protected CkEditorWrapper.CKEditorConfigs config

editorId

protected String editorId

ckPropertyFilter

public static net.sf.json.util.PropertyFilter ckPropertyFilter

Constructor Detail

CkEditorWrapper

public CkEditorWrapper(String id,
                       org.apache.wicket.model.IModel<String> contentModel,
                       String editorId)

Method Detail

addElements

protected void addElements(org.apache.wicket.markup.html.WebMarkupContainer c)

Assumes custom functions createEditor() & removeEditor() exist and the markup exist for:

Example:

 
 	 	<td wicket:id="ckEditor">
 			<input wicket:id="originalContent" type="hidden" />
 			<a wicket:id="updateContentProxyLink">Proxy Link</a>
 			<input wicket:id="createEditor" type="button" value="Add / Edit" title='Modify the content' />
 			<input wicket:id="removeEditor" type="button" value="Read Only" style='display:none;'title='Ensure no accidental changes are made, and the content is only readable not editable' />
 			<input wicket:id="resetEditor" type="button" value="Reset" style='display:none;' title='Reset browser contents to content when page was opened. The state of this remains the same; even on saving. Only a page refresh changes the state. Also, this does not change the state on server/DB, use SAVE for that.' />
 			<br>
 			<div wicket:id="facetEditor"></div>
 			<div wicket:id="facetContents"><b style='font-size:0.8em;color:grey'><br>Last Edited:<br></b>
 				<span wicket:id="facetEditorContents" />
 			</div>
 	</td>
 	  
 

Parameters:

c -

getExtraButtonsContainer

protected org.apache.wicket.markup.html.WebMarkupContainer getExtraButtonsContainer(org.apache.wicket.markup.html.WebMarkupContainer parent)

An empty container is provided next to the last button to add new buttons via API if needed dynamically

Parameters:

parent - as WebMarkupContainer

Returns:

WebMarkupContainer

addCustomControls

protected void addCustomControls(org.apache.wicket.markup.html.WebMarkupContainer c)

In addition to main CkEditor, there may be added plugins, custom plugins we can add their behaviors here.

Parameters:

c -

onInitialize

public void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.Component

getCss

public List<String> getCss()

All the CSS path that should be imported into the editor

getConfigs

public CkEditorWrapper.CKEditorConfigs getConfigs()

getRenderHead

protected String getRenderHead()

renderHead

public void renderHead(org.apache.wicket.markup.html.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IHeaderContributor