com.neurosys.content.wicket.pages

Class TemplatePage<T extends Template<?>,C extends Content>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.Page

org.apache.wicket.markup.html.WebPage

com.neurosys.content.wicket.pages.TemplatePage<T,C>

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, org.apache.wicket.IRedirectListener, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.INewBrowserWindowListener, org.apache.wicket.session.pagemap.IPageMapEntry

Direct Known Subclasses:

MockTemplatePage, PublishTemplatePage

public abstract class TemplatePage<T extends Template<?>,C extends Content>
extends org.apache.wicket.markup.html.WebPage

Allow Templates to be switched for Pages. The Page can load any template (panel) dynamically, provided the template is compatible with this page. The implementation of this page must provide at-least those Markup elements that the Parent container TemplatePage supports.

All the overridable methods are called my the onInitialize() method.

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

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

org.apache.wicket.Page.IPageSerializer

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
protected C	contentDesc
protected T	template
protected TemplateService	templateService

Fields inherited from class org.apache.wicket.Page

LATEST_VERSION, serializer

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

Fields inherited from interface org.apache.wicket.markup.html.INewBrowserWindowListener

INTERFACE

Fields inherited from interface org.apache.wicket.IRedirectListener

INTERFACE

Constructor Summary

Constructors

Constructor and Description
TemplatePage()

Method Summary

Modifier and Type	Method and Description
protected boolean	allowOnPage(FacetMeta fm) A Filter to check if a FacetMeta should be added on Page or not
protected void	checkPageMatchesTemplate()
protected C	fetchContentForPage() Get fresh Content for the page based on its ContentContext
protected abstract <T extends FacetMeta> org.apache.wicket.Component	getComponentForFacet(C contentDesc, T facet) Called by and added to page my iterateAndAddContentFacetsToPage(). Note: Addition contextual info about Locale & ContentContext can be derived by the Component.getLocale() & getPageContext() methods.
protected org.apache.wicket.MarkupContainer	getContainerForFacet(org.apache.wicket.MarkupContainer container, FacetMeta facet) One can add components in a hierarchy using a FacetMeta.getAttribute(String) with attribute FacetMeta.ATTRIB_NAMESPACE with a.b.c convention or a List a > b > c.
protected C	getContent() Get current content being rendered by this page
protected C	getContentDescriber(Status status) This method does not guarantee the Entity from the DataStore neither does it guarantee a valid mapping; it simply guarantees an Identity Object that can Identify the ContentDescriber by name and Status.
protected org.apache.wicket.MarkupContainer	getFacetContainer() By default the container for all the facets is the template page at row level.
protected C	getNewContentInstance(String contentNameId)
protected ContentContext	getPageContext() Get ContentContext for current page
protected Locale	getPageLocale()
Template<?>	getTemplate() Get the associated Template with this component.
protected Class<? extends TemplatePage>	getTemplatePageClass()
protected void	iterateAndAddContentFacetsToPage(org.apache.wicket.MarkupContainer container, C contentDesc, Collection<? extends FacetMeta> facets) Iterates over the collection of ? extends ContentFacetMetas and adds them using {@link #getComponentForFacet(ContentFacet)} to the {@link TemplatePage}.
void	onInitialize()

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

configureResponse, getMarkupType, getUrlCompressor, getWebRequestCycle, homePageLink, onAfterRender, onNewBrowserWindow, setHeaders

Methods inherited from class org.apache.wicket.Page

afterCallComponent, beforeCallComponent, componentChanged, componentRendered, detachModels, dirty, endComponentRender, expireOldestVersion, getAjaxVersionNumber, getAutoIndex, getAutoIndex2, getCurrentVersionNumber, getId, getNumericId, getPageClass, getPageId, getPageMap, getPageMapEntry, getPageMapName, getPageParameters, getPageReference, getSizeInBytes, getStatelessHint, getVersion, getVersions, hierarchyAsString, ignoreVersionMerge, internalOnModelChanged, isBookmarkable, isErrorPage, isPageStateless, moveToPageMap, newVersionManager, onBeforeRender, onDetach, onPageAttached, onRedirect, onRender, prepareForRender, removePersistedFormData, renderPage, rollbackPage, setNumericId, setStatelessHint, startComponentRender, toString, writeReplace

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, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, 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, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, 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, onAttach, onBeginRequest, onComponentTag, onConfigure, onEndRequest, onModelChanged, onModelChanging, onRemove, 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

Methods inherited from interface org.apache.wicket.session.pagemap.IPageMapEntry

getPage

Field Detail

templateService

@SpringBean(name="defaultContentTemplateService")
protected TemplateService templateService

template

protected transient T extends Template<?> template

contentDesc

protected C extends Content contentDesc

Constructor Detail

TemplatePage

public TemplatePage()

Method Detail

allowOnPage

protected boolean allowOnPage(FacetMeta fm)

A Filter to check if a FacetMeta should be added on Page or not

Default value:

true; add all FacetMetas

getTemplatePageClass

protected Class<? extends TemplatePage> getTemplatePageClass()

checkPageMatchesTemplate

protected final void checkPageMatchesTemplate()

getTemplate

public Template<?> getTemplate()

Get the associated Template with this component.

Returns:

Template

fetchContentForPage

protected C fetchContentForPage()

Get fresh Content for the page based on its ContentContext

Returns:

See Also:

contentDesc, getPageContext()

onInitialize

public void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.Component

getPageLocale

protected Locale getPageLocale()

getPageContext

protected ContentContext getPageContext()

Get ContentContext for current page

getNewContentInstance

protected C getNewContentInstance(String contentNameId)

getContentDescriber

protected C getContentDescriber(Status status)

This method does not guarantee the Entity from the DataStore neither does it guarantee a valid mapping; it simply guarantees an Identity Object that can Identify the ContentDescriber by name and Status.

Parameters:

status - as Status

Returns:

getContainerForFacet

protected org.apache.wicket.MarkupContainer getContainerForFacet(org.apache.wicket.MarkupContainer container,
                                                                 FacetMeta facet)

One can add components in a hierarchy using a FacetMeta.getAttribute(String) with attribute FacetMeta.ATTRIB_NAMESPACE with a.b.c convention or a List a > b > c. There "a" is the child of the container, and "c" would be its immediate parent in the container hierarchy.

Parameters:

container - as MarkupContainer, the main container for the dynamic elements for this page

facet - as FacetMeta

iterateAndAddContentFacetsToPage

protected void iterateAndAddContentFacetsToPage(org.apache.wicket.MarkupContainer container,
                                                C contentDesc,
                                                Collection<? extends FacetMeta> facets)

Iterates over the collection of ? extends ContentFacetMetas and adds them using {@link #getComponentForFacet(ContentFacet)} to the {@link TemplatePage}.
The type of the elements in the collection is determined by the {@link #onInitialize()} method.

Note: Addition contextual info about {@link Locale} & {@link ContentContext} can be derived by the {@link #getLocale()} & {@link #getPageContext()} methods.

Parameters:

container - @nullable true (if not null then it adds facets to specified container, else it adds to the page directly)

contentDesc - as ContentDescriber @nullable true

facets - as Collection of ? extends ContentFacet

getComponentForFacet

protected abstract <T extends FacetMeta> org.apache.wicket.Component getComponentForFacet(C contentDesc,
                                                                                          T facet)

Called by and added to page my iterateAndAddContentFacetsToPage().

Note: Addition contextual info about Locale & ContentContext can be derived by the Component.getLocale() & getPageContext() methods.

Parameters:

contentDesc - as ContentDescriber

facet - as T extends ContentFacet.
The exact type of param here depends on the element in the Collection passed from #iterateAndAddContentFacetsToPage(ContentDescriber, Collection)

Returns:

Component

getFacetContainer

protected org.apache.wicket.MarkupContainer getFacetContainer()

By default the container for all the facets is the template page at row level. Can override.
Template Facets are added to this.

Returns:

MarkupContainer

getContent

protected C getContent()

Get current content being rendered by this page

Returns: