uk.ac.ed.epcc.webapp.session

Class RoleNodeMaker

java.lang.Object

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

uk.ac.ed.epcc.webapp.session.RoleNodeMaker

All Implemented Interfaces:

Contexed, NodeMaker

public class RoleNodeMaker
extends AbstractNodeMaker

A NodeMaker that adds role toggle links. This can be invoked using configuration parameters or called directly by SUNodeMaker under control of a Feature

Constructor Summary

Constructors

Constructor and Description
RoleNodeMaker(AppContext conn)

Method Summary

Modifier and Type	Method and Description
void	addChildren(Node parent, java.lang.String name, FilteredProperties props) Add additional child nodes specific to the NodeMaker.
Node	makeNode(java.lang.String name, FilteredProperties props) Create a Node for a named menu item.

Methods inherited from class uk.ac.ed.epcc.webapp.servlet.navigation.AbstractNodeMaker

getContext, getLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleNodeMaker

public RoleNodeMaker(AppContext conn)

Parameters:

conn -

Method Detail

makeNode

public Node makeNode(java.lang.String name,
                     FilteredProperties props)

Description copied from interface: NodeMaker

Create a Node for a named menu item. This is allowed to return null to indicate that nodes of this type are disabled/empty and should be suppressed. The NavigationMenuService can be configured to substitute a different node in this case (for example to host child nodes added by the configuration).

Automatic child nodes can be added in this method and will appear first. Followed by nodes from the configuration then nodes from NodeMaker.addChildren(Node, String, FilteredProperties)

Parameters:

name - name of the node

props - FilteredProperties containing the navigation menu configuration

Returns:

Node

addChildren

public void addChildren(Node parent,
                        java.lang.String name,
                        FilteredProperties props)

Description copied from interface: NodeMaker

Add additional child nodes specific to the NodeMaker. This is intended for Nodes based on the current user or their roles. It is a separate method so the dynamically generated nodes are added after any specified in the configuration. Dynamic nodes that should appear first can be added directly in NodeMaker.makeNode(String, FilteredProperties)

Specified by:

addChildren in interface NodeMaker

Overrides:

addChildren in class AbstractNodeMaker