er.extensions.appserver.navigation

Class ERXNavigationManager

java.lang.Object

er.extensions.appserver.navigation.ERXNavigationManager

public class ERXNavigationManager
extends Object

Please read "Documentation/Navigation.html" to fnd out how to use the navigation components.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	hasRegistered
protected static ERXNavigationManager	manager
static String	NAVIGATION_MAP_KEY
protected NSDictionary<String,ERXNavigationItem>	navigationItemsByName
protected String	navigationMenuFileName
protected ERXNavigationItem	rootNavigationItem

Constructor Summary

Constructors

Constructor and Description
ERXNavigationManager()

Method Summary

Modifier and Type	Method and Description
void	configureNavigation()
protected NSArray	createNavigationItemsFromDictionaries(NSArray navItems)
void	loadNavigationMenu()
static ERXNavigationManager	manager()
ERXNavigationItem	navigationItemForName(String name)
NSDictionary<String,ERXNavigationItem>	navigationItemsByName()
String	navigationMenuFileName()
ERXNavigationState	navigationStateForSession(com.webobjects.appserver.WOSession session)
String	navigationStateFromMap(com.webobjects.appserver.WOSession session) If the current request was created via a link on the navigation menu, this will retrieve the matching navigation state as a string.
String	navigationStateSessionKey()
ERXNavigationItem	newNavigationItem(NSDictionary dict)
void	registerObserverForFramework(String frameworkName)
void	reloadNavigationMenu(com.webobjects.foundation.NSNotification notification)
ERXNavigationItem	rootNavigationItem()
protected void	setNavigationItems(NSArray items)
void	setNavigationMenuFileName(String name)
void	storeInNavigationMap(com.webobjects.appserver.WOSession session, ERXNavigationItem navigationItem, String uri) Stores a navigation item's fully qualified state (e.g.

Methods inherited from class java.lang.Object

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

Field Detail

manager

protected static ERXNavigationManager manager

NAVIGATION_MAP_KEY

public static String NAVIGATION_MAP_KEY

navigationItemsByName

protected NSDictionary<String,ERXNavigationItem> navigationItemsByName

rootNavigationItem

protected ERXNavigationItem rootNavigationItem

navigationMenuFileName

protected String navigationMenuFileName

hasRegistered

protected boolean hasRegistered

Constructor Detail

ERXNavigationManager

public ERXNavigationManager()

Method Detail

manager

public static ERXNavigationManager manager()

navigationStateForSession

public ERXNavigationState navigationStateForSession(com.webobjects.appserver.WOSession session)

navigationStateFromMap

public String navigationStateFromMap(com.webobjects.appserver.WOSession session)

If the current request was created via a link on the navigation menu, this will retrieve the matching navigation state as a string.

Parameters:

session -

Returns:

the applicable navigation state as a string or null if it is undefined

storeInNavigationMap

public void storeInNavigationMap(com.webobjects.appserver.WOSession session,
                                 ERXNavigationItem navigationItem,
                                 String uri)

Stores a navigation item's fully qualified state (e.g. "Movies.SearchMovie") under the corresponding URI for retrieval on the next request.

Parameters:

session -

navigationItem -

uri -

navigationStateSessionKey

public String navigationStateSessionKey()

navigationMenuFileName

public String navigationMenuFileName()

setNavigationMenuFileName

public void setNavigationMenuFileName(String name)

navigationItemsByName

public NSDictionary<String,ERXNavigationItem> navigationItemsByName()

rootNavigationItem

public ERXNavigationItem rootNavigationItem()

navigationItemForName

public ERXNavigationItem navigationItemForName(String name)

setNavigationItems

protected void setNavigationItems(NSArray items)

configureNavigation

public void configureNavigation()

loadNavigationMenu

public void loadNavigationMenu()

registerObserverForFramework

public void registerObserverForFramework(String frameworkName)

newNavigationItem

public ERXNavigationItem newNavigationItem(NSDictionary dict)

createNavigationItemsFromDictionaries

protected NSArray createNavigationItemsFromDictionaries(NSArray navItems)

reloadNavigationMenu

public void reloadNavigationMenu(com.webobjects.foundation.NSNotification notification)