| | Plumtree Pluggable Navigation API | |
| com.plumtree.portaluiinfrastructure.navtype Namespace |
Pluggable Navigation Documentation.
Namespace hierarchy
Classes
Class |
Description |
NavAreaEnum
|
Enumerates the view names, by area, of the page where you can supply navigation. View names must be unique and be defined in GetName() in the view implementation See dynamic loading, MVC names examples; must implement IView or extend of it The areas and their meanings are: ABOVEBODY: Return the name of the view for the area below the banner, or null if not implemented. RIGHTOFBODY: Return the name of the view for the area right of the page, or null if not implemented. LEFTOFBODY: Return the name of the view for the area left of the page, or null if not implemented. BELOWBODY: Return the name of the view for the area above the footer, or null if not implemented. BELOWBANNER: Return the name of the view for the area below the Header, or null if not implemented. ABOVEBANNER: Return the name of the view for the area above the Header, or null if not implemented. BELOWFOOTER: Return the name of the view for the area below the footer, or null if not implemented. ABOVEFOOTER: Return the name of the view for the area above the footer, or null if not implemented. TOPBAR: Return the name of the view for the topbar area, or null if not implemented. |
NavAreaHelper
|
Helper class to assist in the enumeration of navigation types |
NavFeatureEnum
|
Enumeration of core features used on each page which can be turned on or off |
NavFeatureHelper
|
Helper class to assist in the enumeration of navigation feature types |
NavManager
|
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. ````````````````````````````````````````````````````````````````````\u0009`````````````````````````````````````````````` |
Interfaces
Interface |
Description |
INavTypes
|
Core pluggable navigation interface. All pluggable navigations must implement this high-level interface, which lsist the names of view classes used for each area of the page the developer wishes to take over for navigation purposes. Refer to IPluggableNavRO for all model-related methods to build navigation. |