com.neurosys.content.wicket.pages

Class CategoryTemplatePage<C extends ContentDescriber,T extends Template<TemplatePage>>

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>

com.neurosys.content.wicket.pages.PublishTemplatePage<T,ContentDescriber>

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

Type Parameters:

C -

All Implemented Interfaces:

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

Deprecated.

@Deprecated
public abstract class CategoryTemplatePage<C extends ContentDescriber,T extends Template<TemplatePage>>
extends PublishTemplatePage<T,ContentDescriber>

TODO: WORK IN PROGRESS ******************* Figure to ensure the delegated parentTemplate is Spring Aware or rather Spring is aware of it ..so you can't just do "new MyTemplate()" ! Also need to ensure how wicket will maintain and respected a delegated classes hierarchy A Template that allows one to specify a Category as the main input type and the Template renders the children of the Category on Page. The TemplatePages Template FacetMeta are applied to the category on the page like a regular Page. For the children there is an additional templateForChild to apply for the rending of each child element. Each child element is hence expected to be built on that Template to supply the relevant information.
Both the parent & the children are available for use.

Ideal for Category based Dynamic ListViews
NOTE: If the delegated instance parentTemplate has some custom methods to override, the calling class may do so as anonamous functions before setting this class.

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 String	categoryName Deprecated.
protected TemplatePage	parentTemplate Deprecated. Ideally one would want to extend this Class from a Custom template so that all the template properties are inherited.
protected Template<TemplatePage>	templateForChild Deprecated. For the rendering of the Child elements what template will be Used and so the Child will be defined as per the facets in this template

Fields inherited from class com.neurosys.content.wicket.pages.PublishTemplatePage

facetContentCache

Fields inherited from class com.neurosys.content.wicket.pages.TemplatePage

contentDesc, template, 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 com.neurosys.module.model.IPageParams

ALL_RECS, CAMPAIGN_ID, LANG, PAGE_ID, PAGE_MODE_MOBILE, PAGE_MODE_POPUP, PAGE_NAME, PAGE_NUM, PAGE_PARAM, PAGE_PARENT, PAGE_PARENT_ID, PAGE_REFERRER, PAGE_TYPE, PREVIEW

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
CategoryTemplatePage() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected Page<C>	categoryPageExtractionhandler() Deprecated. How using the parent category we wish to extract the children.
protected abstract void	errorHandler(Exception e) Deprecated. Get the custom error handler Page
protected org.apache.wicket.MarkupContainer	getFacetContainer() Deprecated. By default the container for all the facets is the template page at row level.
TemplatePage	getParentTemplate() Deprecated.
protected Class<? extends TemplatePage>	getTemplatePageClass() Deprecated.
protected void	iterateAndAddContentFacetsToPage(org.apache.wicket.MarkupContainer container, ContentDescriber contentDesc, Collection<? extends FacetMeta> facets) Deprecated. Iterates over the collection of ? extends FacetMetas and adds them using {@link #getComponentForFacet(ContentFacet)} to the {@link TemplatePage}.
void	onInitialize() Deprecated.
protected abstract void	populateChild(org.apache.wicket.markup.html.list.ListItem<C> item) Deprecated. Can override further based on any custom rendering requirements
void	renderHead(org.apache.wicket.markup.html.IHeaderResponse response) Deprecated.
void	setParentTemplate(TemplatePage parentTemplate) Deprecated.

Methods inherited from class com.neurosys.content.wicket.pages.PublishTemplatePage

getComponentForFacet, getContentDescriber, getContentService

Methods inherited from class com.neurosys.content.wicket.pages.TemplatePage

allowOnPage, checkPageMatchesTemplate, fetchContentForPage, getContainerForFacet, getContent, getNewContentInstance, getPageContext, getPageLocale, getTemplate

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

categoryName

protected transient String categoryName

Deprecated.

templateForChild

protected Template<TemplatePage> templateForChild

Deprecated.

For the rendering of the Child elements what template will be Used and so the Child will be defined as per the facets in this template

parentTemplate

protected TemplatePage parentTemplate

Deprecated.

Ideally one would want to extend this Class from a Custom template so that all the template properties are inherited.
Since here we have to extend an existing TemplatePage pass the desired parent; it will decorate that (Optional)

Can be null:

true

Constructor Detail

CategoryTemplatePage

public CategoryTemplatePage()

Deprecated.

Method Detail

iterateAndAddContentFacetsToPage

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

Deprecated.

Iterates over the collection of ? extends FacetMetas 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.

Overrides:

iterateAndAddContentFacetsToPage in class TemplatePage<T extends Template<TemplatePage>,ContentDescriber>

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

categoryPageExtractionhandler

protected Page<C> categoryPageExtractionhandler()

Deprecated.

How using the parent category we wish to extract the children.
Can override further for any custom strategy. By default picks out immediate children.

Returns:

@nullable false

populateChild

protected abstract void populateChild(org.apache.wicket.markup.html.list.ListItem<C> item)

Deprecated.

Can override further based on any custom rendering requirements

Parameters:

item -

errorHandler

protected abstract void errorHandler(Exception e)

Deprecated.

Get the custom error handler Page

Parameters:

e - @nullable true

getParentTemplate

public TemplatePage getParentTemplate()

Deprecated.

setParentTemplate

public void setParentTemplate(TemplatePage parentTemplate)

Deprecated.

getFacetContainer

protected org.apache.wicket.MarkupContainer getFacetContainer()

Deprecated.

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

Overrides:

getFacetContainer in class TemplatePage<T extends Template<TemplatePage>,ContentDescriber>

Returns:

MarkupContainer

onInitialize

public void onInitialize()

Deprecated.

Overrides:

onInitialize in class TemplatePage<T extends Template<TemplatePage>,ContentDescriber>

renderHead

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

Deprecated.

Specified by:

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

Overrides:

renderHead in class PublishTemplatePage<T extends Template<TemplatePage>,ContentDescriber>

getTemplatePageClass

protected Class<? extends TemplatePage> getTemplatePageClass()

Deprecated.

Overrides:

getTemplatePageClass in class TemplatePage<T extends Template<TemplatePage>,ContentDescriber>