com.neurosys.content.wicket.pages.panel

Class TemplatePanel<T extends Template<TemplatePanel>,M extends Serializable>

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.content.wicket.pages.panel.TemplatePanel<T,M>

All Implemented Interfaces:

ContentPanel, Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderPartContainerProvider

Direct Known Subclasses:

ListViewTemplatePanel

public abstract class TemplatePanel<T extends Template<TemplatePanel>,M extends Serializable>
extends org.apache.wicket.markup.html.panel.Panel
implements ContentPanel

Allow Dynamic content via Template to create the UI component for the template.
Unlike TemplatePage this can be used @ a component level and represent any MODEL type that is processed by the Templating engine to produce the Panel TODO: Control visibility of certain fields (for Authorization/Security etc)

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

Modifier and Type	Field and Description
protected T	template

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
TemplatePanel(String id, org.apache.wicket.model.IModel<M> model, T template)

Method Summary

Modifier and Type	Method and Description
protected boolean	addFacetToMetaItems(FacetMeta facet, Map<String,Field> fieldMap, ContentType... filterContentType) Determine which fields/FacetMeta will render and be processed
protected List<MetaItem>	extractMetaItems(M modelObject, Collection<? extends FacetMeta> facets, ContentType... filterContentType) Get template attributes + Fields that satisfy filter(Map, Serializable) In addition {filter(Map, Serializable)
protected void	filter(Map<String,Field> fieldMap, M modelObject) Apply Filter. By Default filter any Field that matches the default set of types defined by filterClasses() & those that have Type annotation.
protected Class[]	filterClasses() Return all the types from the main model & parents that are eligible for rendering By default this impl includes primitive types, String, Double, Float, Character, Integer, Boolean and Serializable All should be Serializable types
protected abstract org.apache.wicket.Component[]	getComponents(M modelObject, MetaItem item) Called by and added to page my processItemList(). An entity can define native field UI support using Type.
protected org.apache.wicket.MarkupContainer	getContainer() By default the container for all the elements added to this component
abstract <C extends org.apache.wicket.Component> List<C>	getDataRelatedComponents(Class<C> type) All elements added to the dynamic panel maybe added within wrapper elements and nested hierarchies.
T	getTemplate()
protected boolean	isAuthorized(FacetMeta facet, Map<String,Field> fieldMap, ContentType... filterContentType)
protected void	iterateAndAddFacetsToPage(org.apache.wicket.MarkupContainer container, M modelObject, Collection<? extends FacetMeta> facets) Iterates over the collection of ? extends FacetMetas and adds them to the TemplatePanel.
void	onInitialize()
protected void	processItemList(org.apache.wicket.MarkupContainer container, M modelObject, List<MetaItem> items) A list sorting, pre-processing, filtering etc can be performed here.
void	setTemplate(T template)

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

Field Detail

template

protected T extends Template<TemplatePanel> template

Constructor Detail

TemplatePanel

public TemplatePanel(String id,
                     org.apache.wicket.model.IModel<M> model,
                     T template)

Method Detail

onInitialize

public void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.Component

isAuthorized

protected boolean isAuthorized(FacetMeta facet,
                               Map<String,Field> fieldMap,
                               ContentType... filterContentType)

addFacetToMetaItems

protected boolean addFacetToMetaItems(FacetMeta facet,
                                      Map<String,Field> fieldMap,
                                      ContentType... filterContentType)

Determine which fields/FacetMeta will render and be processed

Parameters:

facet - as FacetMeta

fieldMap - as Map ; for all fields in the Entity

filterContentType - as ContentType to accept only

Returns:

extractMetaItems

protected List<MetaItem> extractMetaItems(M modelObject,
                                          Collection<? extends FacetMeta> facets,
                                          ContentType... filterContentType)

Get template attributes + Fields that satisfy filter(Map, Serializable)
In addition {filter(Map, Serializable)

Parameters:

modelObject - as M

facets - as Collection of FacetMeta

Returns:

List of MetaItem

iterateAndAddFacetsToPage

protected void iterateAndAddFacetsToPage(org.apache.wicket.MarkupContainer container,
                                         M modelObject,
                                         Collection<? extends FacetMeta> facets)

Iterates over the collection of ? extends FacetMetas and adds them to the TemplatePanel.
The type of the elements in the collection is determined by the onInitialize() method.

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

Parameters:

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

M - as model object

facets - as Collection of ? extends FacetMeta

filter

protected void filter(Map<String,Field> fieldMap,
                      M modelObject)

Apply Filter.
By Default filter any Field that matches the default set of types defined by filterClasses() & those that have Type annotation.

Parameters:

fieldMap - as Map for local reference (shared map)

modelObject -

filterClasses

protected Class[] filterClasses()

Return all the types from the main model & parents that are eligible for rendering
By default this impl includes primitive types, String, Double, Float, Character, Integer, Boolean and Serializable
All should be Serializable types

Returns:

processItemList

protected void processItemList(org.apache.wicket.MarkupContainer container,
                               M modelObject,
                               List<MetaItem> items)

A list sorting, pre-processing, filtering etc can be performed here.
In addition, the final list of fields/items is added to the Container

Parameters:

container - @nullable false (expects a valid container from iterateAndAddFacetsToPage(MarkupContainer, Serializable, Collection))

M - as model object

List - of MetaItem

items -

getComponents

protected abstract org.apache.wicket.Component[] getComponents(M modelObject,
                                                               MetaItem item)

Called by and added to page my processItemList().

An entity can define native field UI support using Type. All fields that are annotated with this will be processed also by this method. If a Facet and field share the same name then both will not be null.
Either one can also be null.

Parameters:

M - as Model Object

item - as MetaItem

Returns:

Component @nullable false

getContainer

protected org.apache.wicket.MarkupContainer getContainer()

By default the container for all the elements added to this component

Returns:

MarkupContainer

Default value:

this

getDataRelatedComponents

public abstract <C extends org.apache.wicket.Component> List<C> getDataRelatedComponents(Class<C> type)

All elements added to the dynamic panel maybe added within wrapper elements and nested hierarchies. i.e. not directly attached to the main container component.
An efficient and convenient method of retrieving all elements of the same/similar raw type irrespective of what parent they are attached to.

Parameters:

type - as Class of Component type

Returns:

getTemplate

public T getTemplate()

setTemplate

public void setTemplate(T template)