com.neurosys.site.wicket.panels

Class RecursiveListBasedMenuPanel

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.panels.MenuPanel

com.neurosys.site.wicket.panels.RecursiveListBasedMenuPanel

All Implemented Interfaces:

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

public class RecursiveListBasedMenuPanel
extends MenuPanel

Menu Panel implementation that generates a <ul> ...<li>..</li>... </ul> code to generate a Menu
Sample UI component HTML/JS this will work with scriptbreaker-multiple-accordion-1.js
Markup Sample:

  <wicket:fragment wicket:id="subMenuType">
								<li wicket:id="row"><a wicket:id="link"><wicket:container wicket:id="name">"parentname</wicket:container></a>
									<ul> <!-- Sub menu container. Override getSubMenuContainer() to do anything on this -->
									  <wicket:container wicket:id="children">
											<wicket:container wicket:id="subMenu"></wicket:container>
									  </wicket:container>
									</ul>
								</li>
	</wicket:fragment>
	
	<wicket:container wicket:id="rootLevel">
		<wicket:container wicket:id="subMenuFragment" />
	</wicket:container>
	
        

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	ignoreNavigableNodeChildren If true, will optimize by removing children of nodes that are navigable.
protected static String[]	VOID_ARRAY

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
RecursiveListBasedMenuPanel(String id, org.apache.wicket.model.IModel<Menu> model)

Method Summary

Modifier and Type	Method and Description
protected List<String>	defineAttributesForLink(MenuItemState state) Override to customize attributes to Link
protected org.apache.wicket.Component	getLink(String linkComponentName, MenuItemState state, org.apache.wicket.markup.html.WebMarkupContainer container) Create a Link or a container containing the Link part of the Menu item.
protected List<MenuItemState>	getNodeChildStates(MenuItemState menuItemState) Override to dictate custom strategies on what child elements can be loaded for a given parent MenuItemState
protected org.apache.wicket.markup.html.WebMarkupContainer	getSubMenuContainer(MenuItemState menuItemState, org.apache.wicket.markup.html.WebMarkupContainer children) Optional override that returns a wrapper sub menu container over children produced by recurseAdd(Fragment, MenuItemState)
boolean	isIgnoreNavigableNodeChildren() If true, will optimize by removing children of nodes that are navigable.
protected void	renderMenu() Main render method called by MenuPanel.onInitialize
void	setIgnoreNavigableNodeChildren(boolean ignoreNavigableNodeChildren) If true, will optimize by removing children of nodes that are navigable.

Methods inherited from class com.neurosys.site.wicket.panels.MenuPanel

getModel, onInitialize, setState

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

ignoreNavigableNodeChildren

protected boolean ignoreNavigableNodeChildren

If true, will optimize by removing children of nodes that are navigable. This is useful in situations where you know you can never reach the children of Navigable (Clickable) parents; Also the ignored nodes cannot be part of an Active Path. This is because often we may want to open the hierarchy to the focus-node in an Active path. (where the node maybe a child of a navigable parent).

VOID_ARRAY

protected static final String[] VOID_ARRAY

Constructor Detail

RecursiveListBasedMenuPanel

public RecursiveListBasedMenuPanel(String id,
                                   org.apache.wicket.model.IModel<Menu> model)

Method Detail

defineAttributesForLink

protected List<String> defineAttributesForLink(MenuItemState state)

Override to customize attributes to Link

Parameters:

state -

Returns:

getLink

protected org.apache.wicket.Component getLink(String linkComponentName,
                                              MenuItemState state,
                                              org.apache.wicket.markup.html.WebMarkupContainer container)

Create a Link or a container containing the Link part of the Menu item.

Parameters:

linkComponentName - as String; this component by default contains a Label "name"

state - as MenuItemState

Returns:

getNodeChildStates

protected List<MenuItemState> getNodeChildStates(MenuItemState menuItemState)

Override to dictate custom strategies on what child elements can be loaded for a given parent MenuItemState

Parameters:

menuItemState -

Returns:

children as List of MenuItemState

getSubMenuContainer

protected org.apache.wicket.markup.html.WebMarkupContainer getSubMenuContainer(MenuItemState menuItemState,
                                                                               org.apache.wicket.markup.html.WebMarkupContainer children)

Optional override that returns a wrapper sub menu container over children produced by recurseAdd(Fragment, MenuItemState)

Parameters:

menuItemState - as MenuItemState

children - as WebMarkupContainer for children

Returns:

WebMarkupContainer

Default value:

will return children container itself

renderMenu

protected void renderMenu()

Main render method called by MenuPanel.onInitialize

Specified by:

renderMenu in class MenuPanel

isIgnoreNavigableNodeChildren

public boolean isIgnoreNavigableNodeChildren()

If true, will optimize by removing children of nodes that are navigable. This is useful in situations where you know you can never reach the children of Navigable (Clickable) parents; Also the ignored nodes cannot be part of an Active Path. This is because often we may want to open the hierarchy to the focus-node in an Active path. (where the node maybe a child of a navigable parent).

setIgnoreNavigableNodeChildren

public void setIgnoreNavigableNodeChildren(boolean ignoreNavigableNodeChildren)

If true, will optimize by removing children of nodes that are navigable. This is useful in situations where you know you can never reach the children of Navigable (Clickable) parents; Also the ignored nodes cannot be part of an Active Path. This is because often we may want to open the hierarchy to the focus-node in an Active path. (where the node maybe a child of a navigable parent).