com.plumtree.portaluiinfrastructure.navtype
Class NavManager

java.lang.Object
  com.plumtree.portaluiinfrastructure.navtype.NavManager

public class NavManager
extends java.lang.Object

Singleton navigation types loader and manager for pluggable navigation. To create a pluggable navigation type, implement INavTypes, implement multiple views and specify them in your INavTypes implementation, and add the JAR that contains these views and INavTypes implementation to CustomActivitySpaces.xml. The new nav will then show up in the interface. Please insure your navigation ID does not conflict with an existing ID. ```````````````````````````````````````````````````````````````````` ``````````````````````````````````````````````

Author:

DavidP, AdolfoC

Field Summary

static NavManager	INSTANCE Use this class static to access the one and only instance of ActivitySpaceManager.
boolean	m_bSystemStartupSuccesful whether or not the system was able to start up correctly.

Method Summary

INavTypes	GetNavType(int navID) Return the requested NavTypes.
IXPEnumerator	GetNavTypes() Gets the navigation types loaded.
XPArrayList	GetNavTypesAsSortedArray() Gets the navigation types loaded as sorted array list
int	GetNumCustomNavTypes() This method returns the number of custom NavTypes currently loaded.
void	LoadClasses(java.lang.String strLibDir, java.lang.String strConfigFile) This method initializes the NavManager and should only be called by the warmup servlet.
void	LoadCustomClasses(java.lang.String strLibDir, java.lang.String strConfigFile) This method initializes the NavManager and should only be called by the warmup servlet.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final NavManager INSTANCE

Use this class static to access the one and only instance of ActivitySpaceManager.

m_bSystemStartupSuccesful

public boolean m_bSystemStartupSuccesful

whether or not the system was able to start up correctly.

Method Detail

GetNavType

public INavTypes GetNavType(int navID)

Return the requested NavTypes.

Parameters:

navID - the unique identifier for this navigation scheme.

Returns:

INavTypes

GetNavTypes

public IXPEnumerator GetNavTypes()

Gets the navigation types loaded. UNRELATED to NavPageType or NavCategoryType. This simply gets the pluggable navigation elements, each of which have an ID that uniquely identifies them.

Returns:

IXPEnumerator

GetNavTypesAsSortedArray

public XPArrayList GetNavTypesAsSortedArray()

Gets the navigation types loaded as sorted array list

Returns:

XPArrayList

LoadClasses

public void LoadClasses(java.lang.String strLibDir,
                        java.lang.String strConfigFile)

This method initializes the NavManager and should only be called by the warmup servlet. This method can only be called once.

Parameters:

strLibDir -

strConfigFile -

LoadCustomClasses

public void LoadCustomClasses(java.lang.String strLibDir,
                              java.lang.String strConfigFile)

This method initializes the NavManager and should only be called by the warmup servlet.

Parameters:

strLibDir -

strConfigFile -

GetNumCustomNavTypes

public int GetNumCustomNavTypes()

This method returns the number of custom NavTypes currently loaded. This number is reset every time custom objects are loaded.

Returns:

The number of custom NavTypes currently loaded.