com.neurosys.site.wicket.components

Class CategoryPanel<T>

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.site.wicket.components.CategoryPanel<T>

All Implemented Interfaces:

ChangeGenerator<T>, Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderPartContainerProvider

Direct Known Subclasses:

ContentTreePanel, ProductCategoryPanel, SubFolderViewPanel

public abstract class CategoryPanel<T>
extends org.apache.wicket.markup.html.panel.Panel
implements ChangeGenerator<T>

A Panel to represent all the items in the hierarchy

Since this implements ChangeGenerator; it will also generate Events of Type

• Node Selected - T

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 boolean	expandedState
protected List<ChangeListener<T>>	listeners
protected boolean	loadLeaves

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
CategoryPanel(String id, org.apache.wicket.model.IModel<T> model, boolean loadLeaves)

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener changeListener) Notify all ChangeListeners about a change
protected TreeModel	convertToTreeModel(List<T> list) Converts a List type tree to actual Tree model
protected abstract org.apache.wicket.markup.html.tree.LinkTree	createLinkTree(String id, TreeModel treeModel) One can intercept LinkTree Ajax requests via its LinkTree.onNodeLinkClicked(java.lang.Object, org.apache.wicket.markup.html.tree.BaseTree, org.apache.wicket.ajax.AjaxRequestTarget) etc.
protected TreeModel	createTreeModel() Creates the model that feeds the tree.
protected abstract List<T>	getDataList(T parentNode) Fetch the Data as a Data List.
List	getListeners() Get list directly.
org.apache.wicket.model.IModel<T>	getModel()
protected org.apache.wicket.markup.html.tree.AbstractTree	getTree(String id)
boolean	isExpandedState()
boolean	isLoadLeaves()
protected void	modifyNode(DefaultMutableTreeNode node, T modelForNode) Allow overriding and manipulating of a Node
void	notifyAllListeners(T object) Whenever a node is selected, it also notifies its listeners.
void	onInitialize()
void	onInitialize(List<T> list) Initialize using some external list, liek a Search result or Authorized filetered list
void	setExpandedState(boolean expandedState)
void	setListeners(List listeners) Set list directly.
void	setLoadLeaves(boolean loadLeaves)
void	setState(org.apache.wicket.model.IModel<T> category)

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

loadLeaves

protected boolean loadLeaves

expandedState

protected boolean expandedState

listeners

protected transient List<ChangeListener<T>> listeners

Constructor Detail

CategoryPanel

public CategoryPanel(String id,
                     org.apache.wicket.model.IModel<T> model,
                     boolean loadLeaves)

Parameters:

id - as Component Id

model - as IModel of Menu; the product represents the root context @nullable false

Method Detail

onInitialize

public void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.Component

onInitialize

public void onInitialize(List<T> list)

Initialize using some external list, liek a Search result or Authorized filetered list

Parameters:

list -

setState

public void setState(org.apache.wicket.model.IModel<T> category)

getModel

public org.apache.wicket.model.IModel<T> getModel()

getTree

protected org.apache.wicket.markup.html.tree.AbstractTree getTree(String id)

createLinkTree

protected abstract org.apache.wicket.markup.html.tree.LinkTree createLinkTree(String id,
                                                                              TreeModel treeModel)

One can intercept LinkTree Ajax requests via its LinkTree.onNodeLinkClicked(java.lang.Object, org.apache.wicket.markup.html.tree.BaseTree, org.apache.wicket.ajax.AjaxRequestTarget) etc. Define custom/anon class so you can intercept Ajax requests.

Parameters:

tree - as LinkTree

notifyAllListeners

public void notifyAllListeners(T object)

Whenever a node is selected, it also notifies its listeners.

Specified by:

notifyAllListeners in interface ChangeGenerator<T>

Parameters:

object -

getDataList

protected abstract List<T> getDataList(T parentNode)

Fetch the Data as a Data List. If a item has children then that will contain a sub-list and so on. Order is extremely crucial.

Parameters:

parentNode - as T @nullable true (if root)

Returns:

List

createTreeModel

protected TreeModel createTreeModel()

Creates the model that feeds the tree.
If we want child categories as end nodes then add blank lists for them.

Returns:

New instance of tree model.

convertToTreeModel

protected TreeModel convertToTreeModel(List<T> list)

Converts a List type tree to actual Tree model

Parameters:

list -

Returns:

See Also:

{@link ModuleHelpers#hierarchyFilter(List, boolean)}

modifyNode

protected void modifyNode(DefaultMutableTreeNode node,
                          T modelForNode)

Allow overriding and manipulating of a Node

Parameters:

node -

isLoadLeaves

public boolean isLoadLeaves()

setLoadLeaves

public void setLoadLeaves(boolean loadLeaves)

isExpandedState

public boolean isExpandedState()

setExpandedState

public void setExpandedState(boolean expandedState)

addChangeListener

public void addChangeListener(ChangeListener changeListener)

Notify all ChangeListeners about a change

Specified by:

addChangeListener in interface ChangeGenerator<T>

Parameters:

changeListener -

getListeners

public List getListeners()

Description copied from interface: ChangeGenerator

Get list directly. Support DI; like Spring IOC

Specified by:

getListeners in interface ChangeGenerator<T>

setListeners

public void setListeners(List listeners)

Description copied from interface: ChangeGenerator

Set list directly. Support DI; like Spring IOC

Specified by:

setListeners in interface ChangeGenerator<T>