com.neurosys.content.admin.wicket.pages.panels

Class ContentEditorPanel

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup

org.apache.wicket.markup.html.panel.Panel

com.neurosys.system.admin.wicket.components.AdminPanel

com.neurosys.content.admin.wicket.pages.panels.ContentEditorPanel

All Implemented Interfaces:

ContentFacetEditor, IAdminPanel, Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.markup.html.IHeaderPartContainerProvider

public class ContentEditorPanel
extends AdminPanel
implements ContentFacetEditor

A self contained implementation of the CkEditorWrapper with default behaviors, error handling + markup ready made for common use cases

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

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 inherited from class com.neurosys.system.admin.wicket.components.AdminPanel

adminConfiguration, authorizationModule

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
ContentEditorPanel(String id, org.apache.wicket.model.IModel<String> contentModel, String editorId, FacetMeta facetMeta, Object modelObject)
ContentEditorPanel(String id, org.apache.wicket.model.IModel<String> contentModel, String editorId, Object modelObject)

Method Summary

Modifier and Type	Method and Description
void	configureEditor(FacetMeta fm) Get the CSS(s) & related attribs from the Template#FacetMeta.attributes and configure the Editor to display as per template settings
static String	decorateScriptToUpdateModel(String proxyActionSuppliedScript, CharSequence script) Because of CkEditor we have to ensure that on Save/Update from the containing markup/page, the model is updated.
protected org.apache.wicket.markup.html.WebMarkupContainer	defineEditor(String id, org.apache.wicket.model.IModel<String> contentModel, String editorId, FacetMeta facetMeta, Object modelObject) Define an editor for Content Editing.
protected FieldAjaxEventBehavior	getAjaxSavingBehavior(org.apache.wicket.ajax.markup.html.AjaxLink link, org.apache.wicket.ajax.IAjaxCallDecorator callDecorator) If not null will override the save behavior of the content.
String	getEditorModelValue() Interface implementation to standardize how to extract the value within the core editor.
protected org.apache.wicket.markup.html.WebMarkupContainer	getExtraButtonsContainer(String componentId, org.apache.wicket.markup.html.WebMarkupContainer parent)

Methods inherited from class com.neurosys.system.admin.wicket.components.AdminPanel

getConfigProperty, getModuleForPage, headerMeta, renderHead

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

onComponentTag, onComponentTagBody, renderHead

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

newHeaderPartContainer, renderHeadFromAssociatedMarkupFile

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, 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, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, 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

Constructor Detail

ContentEditorPanel

public ContentEditorPanel(String id,
                          org.apache.wicket.model.IModel<String> contentModel,
                          String editorId,
                          FacetMeta facetMeta,
                          Object modelObject)

ContentEditorPanel

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

Method Detail

decorateScriptToUpdateModel

public static String decorateScriptToUpdateModel(String proxyActionSuppliedScript,
                                                 CharSequence script)

Because of CkEditor we have to ensure that on Save/Update from the containing markup/page, the model is updated.
This is used by IAjaxCallDecorators to decorate the script

defineEditor

protected org.apache.wicket.markup.html.WebMarkupContainer defineEditor(String id,
                                                                        org.apache.wicket.model.IModel<String> contentModel,
                                                                        String editorId,
                                                                        FacetMeta facetMeta,
                                                                        Object modelObject)

Define an editor for Content Editing.

Parameters:

id - as Component Id

contentModel - as IModel of String type

editorId - as String

facetMeta - as FacetMeta.

Returns:

editor like CkEditorWrapper

See Also:

CkEditorWrapper.addCustomControls, - Can be String, List or Transformer that returns a List or a String.

getEditorModelValue

public String getEditorModelValue()

Interface implementation to standardize how to extract the value within the core editor.

Specified by:

getEditorModelValue in interface ContentFacetEditor

Returns:

String

getExtraButtonsContainer

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

getAjaxSavingBehavior

protected FieldAjaxEventBehavior getAjaxSavingBehavior(org.apache.wicket.ajax.markup.html.AjaxLink link,
                                                       org.apache.wicket.ajax.IAjaxCallDecorator callDecorator)

If not null will override the save behavior of the content.

Parameters:

callDecorator - as IAjaxCallDecorator ; scripting and wiring with the feeback panel that is apart of this panel

Returns:

FieldAjaxEventBehavior @nullable true

configureEditor

public void configureEditor(FacetMeta fm)

Get the CSS(s) & related attribs from the Template#FacetMeta.attributes and configure the Editor to display as per template settings

Parameters:

fm - as FacetMeta