Package uk.ac.ed.epcc.webapp.servlet.navigation

Support for a menu navigation.

See: Description

Interface Summary

Interface	Description
NodeMaker	A factory class for making Nodes Generic NodeMakers just create the correct type of Node.
Visitor	a visitor class for navigation menu items

Class Summary

Class	Description
AbstractNodeMaker
ButtonVisitor	A Visitor that generates the menu HTML as a set of buttons
ExactNode	a Node which matches the target url exactly.
ExactNodeMaker
ExternalNode	A Node representing an external URL
ExternalNodeMaker
LandingPageAppUserTransitionProvider<AU extends AppUser>	An AppUserTransitionProvider where the view transition can act as the landing-page for the SUNodeMaker menu.
LandingPageAppUserTransitionProvider.ImportKey<AU extends AppUser>	An AppUserKey for menu items imported as transitions
LandingPageAppUserTransitionProvider.MenuTransition<AU extends AppUser>
LandingPageVisitor	A Visitor that generates the menu HTML as in-page content
MenuVisitor	A Visitor that generates the menu HTML
NavigationMenuService	A AppContextService for building navigation menus.
Node	This represents a node in the navigational menu.
NodeContainer	A container for menu Nodes This might represent the top-level menu-bar.
NodeGenerator	Adds the contents of NodeContainer Assumed to be passed a HtmlBuilder
PageNode	An ExactNode that records the calling page.
PageNodeMaker
ParentNode	a Node that matches all locations below the target.
ParentNodeMaker
SUNode	An ExactNode where the menu text changes to the name of the current person if the session is a "SU" session from an admin account.
SUNodeMaker
TransitionNodeMaker<T,K>	Create a navigation Node corresponding to a transition Config properties (without navigation.prefix: name.transition transition provider name (defaults to name).

Package uk.ac.ed.epcc.webapp.servlet.navigation Description

Support for a menu navigation.

A navigation menu consists of a tree of Navigational nodes that will be formatted as a html multi-level list of links. CSS and possible ECMAscript will format these as navigational menus. The exact details of which depend on the css and may be responsive to the device viewing the page.

Each node can represent:

• The short text presented to the user in the navigational menu.
• A target url navigated to when the node is clicked.
• A set of sub-nodes
• An query method that checks if the current request "matches" the urls controlled by the node. This will be used to generate an attribute on the html node. This must include the target url but can be wider. Child targets do not have to be explicitly included the CSS can explicitly match active children.

Nodes are lightweight and serialisable so a menu can be built and cached in the user session without requiring complex sql queries. The Node tree is build by a AppContextService. Operations that might modify the menu structure should use the service to explicitly rebuild the tree.