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

Interface NodeMaker

All Superinterfaces:

Contexed

All Known Implementing Classes:

AbstractNodeMaker, ConfigFormProvider, ExactNodeMaker, ExternalNodeMaker, FormFactoryProviderRegistry, FormRegistry, HeirarchyFormRegistry, PageNodeMaker, ParentNodeMaker, RoleNodeMaker, SUNodeMaker, TransitionNodeMaker

public interface NodeMaker
extends Contexed

A factory class for making Nodes Generic NodeMakers just create the correct type of Node. However these can also be plug-ins that build user specific node trees based on the current user and their database state.

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 interface uk.ac.ed.epcc.webapp.Contexed

getContext

Method Detail

makeNode

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

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 addChildren(Node, String, FilteredProperties)

Parameters:

name - name of the node

props - FilteredProperties containing the navigation menu configuration

Returns:

Node

addChildren

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

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 makeNode(String, FilteredProperties)

Parameters:

parent -

name -

props -