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

Class NavigationMenuService

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractContexed

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

All Implemented Interfaces:

AppContextCleanup, AppContextService<NavigationMenuService>, Contexed

public class NavigationMenuService
extends AbstractContexed
implements AppContextService<NavigationMenuService>

A AppContextService for building navigation menus.

The top level menu is defined as a comma separated list in the property navigation.list Each name defines a menu node using the properties:

• navigation.name.text - menu text, defaults to name
• navigation.name.list - comma separated list of additional child node names
• navigation.name.type - type of NodeMaker to make node
• navigation.name.path - path to set for the node
• navigation.name.help - tooltip help text
• navigation.name.path - path to set for the node
• navigation.name.role - Role user must have to see item
• navigation.name.require_feature - Feature that must be enabled to see item
• navigation.name.disable_feature - Feature that must be disabled to see item
• navigation.name.require_parameter - config parameter that must be non null to see item
• navigation.name.image - image name for menu item
• navigation.name.access_key - access_key the node
• navigation.name.replacement - Name of a node to substitute if the NodeMaker returns null. The configuration properties of the original node are not automatically inherited.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DISABLE_NAVIGATION_ATTR
static Feature	FORCE_SERIALISE_FEATURE
static Feature	NAVIGATION_MENU_FEATURE
static Feature	NAVIGATION_MENU_JS_FEATURE
static java.lang.String	NAVIGATIONAL_PREFIX

Fields inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

conn

Constructor Summary

Constructors

Constructor and Description
NavigationMenuService(AppContext conn)

Method Summary

Modifier and Type	Method and Description
void	addChildren(java.util.Set<java.lang.String> seen, java.lang.String name, FilteredProperties menu_prop, NodeMaker maker, Node n)
void	cleanup() AppContext is being closed.
void	disableNavigation(HttpServletRequest request)
NodeContainer	getMenu()
HtmlBuilder	getNavigation(HttpServletRequest request, HtmlBuilder builder) build the navigation element for
FilteredProperties	getProperties()
java.lang.Class<? super NavigationMenuService>	getType() Returns the type of service the class should be registered under.
NodeContainer	makeMenu() Populate a NodeContainer with the appropriate navigational Nodes for the current user.
protected Node	makeNode(java.util.Set<java.lang.String> seen, java.lang.String name, FilteredProperties menu_prop)
void	resetMenu() reset the Navigation menu so it is re-calculated for the next page view.
static <T,K> Node	transitionNode(AppContext conn, TransitionFactory<K,T> provider, T target, K key) Make a node corresponding to a transition a target.
static <T,K> Node	viewNode(AppContext conn, ViewTransitionFactory<K,T> provider, T target) Make a node corresponding to the view url of a target.
boolean	willAddChildren(java.lang.String name, FilteredProperties menu_prop)
protected boolean	willMakeNode(java.lang.String name, FilteredProperties menu_prop)

Methods inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

getContext, getLogger, resetLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DISABLE_NAVIGATION_ATTR

public static final java.lang.String DISABLE_NAVIGATION_ATTR

See Also:

Constant Field Values

NAVIGATIONAL_PREFIX

public static final java.lang.String NAVIGATIONAL_PREFIX

See Also:

Constant Field Values

NAVIGATION_MENU_FEATURE

public static final Feature NAVIGATION_MENU_FEATURE

NAVIGATION_MENU_JS_FEATURE

public static final Feature NAVIGATION_MENU_JS_FEATURE

FORCE_SERIALISE_FEATURE

public static final Feature FORCE_SERIALISE_FEATURE

Constructor Detail

NavigationMenuService

public NavigationMenuService(AppContext conn)

Method Detail

cleanup

public void cleanup()

Description copied from interface: AppContextCleanup

AppContext is being closed. Only use this for cleanup that can't be handled by normal garbage collection or for state which is never returned by reference.

Specified by:

cleanup in interface AppContextCleanup

getType

public java.lang.Class<? super NavigationMenuService> getType()

Description copied from interface: AppContextService

Returns the type of service the class should be registered under.

Specified by:

getType in interface AppContextService<NavigationMenuService>

Returns:

registration type

getMenu

public NodeContainer getMenu()

resetMenu

public void resetMenu()

reset the Navigation menu so it is re-calculated for the next page view. This needs to be called when the account state changes in a way that will change the menu structure.

getProperties

public FilteredProperties getProperties()

makeMenu

public NodeContainer makeMenu()

Populate a NodeContainer with the appropriate navigational Nodes for the current user.

Returns:

NodeContainer for the navigation menu or null

makeNode

protected Node makeNode(java.util.Set<java.lang.String> seen,
                        java.lang.String name,
                        FilteredProperties menu_prop)

Parameters:

name -

menu_prop -

Returns:

willMakeNode

protected boolean willMakeNode(java.lang.String name,
                               FilteredProperties menu_prop)

addChildren

public void addChildren(java.util.Set<java.lang.String> seen,
                        java.lang.String name,
                        FilteredProperties menu_prop,
                        NodeMaker maker,
                        Node n)

Parameters:

seen -

name -

menu_prop -

maker -

n -

willAddChildren

public boolean willAddChildren(java.lang.String name,
                               FilteredProperties menu_prop)

disableNavigation

public void disableNavigation(HttpServletRequest request)

getNavigation

public HtmlBuilder getNavigation(HttpServletRequest request,
                                 HtmlBuilder builder)

build the navigation element for

Parameters:

builder -

Returns:

viewNode

public static <T,K> Node viewNode(AppContext conn,
                                  ViewTransitionFactory<K,T> provider,
                                  T target)

Make a node corresponding to the view url of a target.

Parameters:

conn -

provider -

target -

Returns:

Node

transitionNode

public static <T,K> Node transitionNode(AppContext conn,
                                        TransitionFactory<K,T> provider,
                                        T target,
                                        K key)

Make a node corresponding to a transition a target.

Parameters:

conn -

provider -

target -

Returns:

Node