com.plumtree.portalnavigation
Class NavTypeSimpleLeftVertical

java.lang.Object
  extended by com.plumtree.portalnavigation.NavTypeSimpleLeftVertical
All Implemented Interfaces:
INavTypes

public class NavTypeSimpleLeftVertical
extends java.lang.Object
implements INavTypes

The NavType for Left Vertical Navigation The vertical sections are collapsable/expandable and stored as personal preferences.

Author:
robertz, DavidP

Constructor Summary
NavTypeSimpleLeftVertical()
           
 
Method Summary
 int GetID()
          Return the integer order of the navigation type.
 java.lang.String GetName(java.lang.String _strLangID)
          Return the text name of this navigation type shown in the subportal editor.
 java.lang.String GetNavAreaView(NavAreaEnum area)
          Primary method to implement for pluggable navigation support.
 java.lang.String GetScope(java.lang.String _strLangID)
          Return the description of this navigation plugin shown in the subportal editor.
 boolean IsFeatureEnabled(NavFeatureEnum feature)
          Return boolean to control whether or not a specific navigation feature is displayed.
 HTMLScriptCollection JavaScriptIncludes(AActivitySpace owner)
          Return the names of the javascript file includes as an array of strings or null if none are used.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NavTypeSimpleLeftVertical

public NavTypeSimpleLeftVertical()
Method Detail

GetID

public int GetID()
Description copied from interface: INavTypes
Return the integer order of the navigation type. Must be greater than 5 for external plugins. Note that this number must be unique among registered navigation plugins on any specific install.

Specified by:
GetID in interface INavTypes
Returns:
integer navigation topic position
See Also:
INavTypes.GetID()

GetName

public java.lang.String GetName(java.lang.String _strLangID)
Description copied from interface: INavTypes
Return the text name of this navigation type shown in the subportal editor.

Specified by:
GetName in interface INavTypes
Returns:
String plguin name
See Also:
INavTypes.GetName(String)

GetScope

public java.lang.String GetScope(java.lang.String _strLangID)
Description copied from interface: INavTypes
Return the description of this navigation plugin shown in the subportal editor.

Specified by:
GetScope in interface INavTypes
Returns:
String plugin scope
See Also:
INavTypes.GetScope(String)

GetNavAreaView

public java.lang.String GetNavAreaView(NavAreaEnum area)
Description copied from interface: INavTypes
Primary method to implement for pluggable navigation support. Return stringname of the view class by page area used in pluggable navigation. Viewnames returned will be registered as IView types associated with the main display class' MVC hierarchy and used to render the page via pluggable navigation. Area examples include left and right of page body, and above and below the banner. IView classes return HTML used to display the page.

Specified by:
GetNavAreaView in interface INavTypes
Returns:
String
See Also:
INavTypes.GetNavAreaView(com.plumtree.portaluiinfrastructure.navtype.NavAreaEnum)

JavaScriptIncludes

public HTMLScriptCollection JavaScriptIncludes(AActivitySpace owner)
Description copied from interface: INavTypes
Return the names of the javascript file includes as an array of strings or null if none are used. A single javascript include is supported for all subviews in each pluggable navigation instance. IMPORTANT NOTE: This function is where IView.DisplayJavaScript() should be called in order for the navigation view specific javascript to appear in the navigation.

Specified by:
JavaScriptIncludes in interface INavTypes
Returns:
String[]
See Also:
com.plumtree.portaluiinfrastructure.navtype.INavTypes#JavaScriptIncludes()

IsFeatureEnabled

public boolean IsFeatureEnabled(NavFeatureEnum feature)
Description copied from interface: INavTypes
Return boolean to control whether or not a specific navigation feature is displayed. Examples include the topbar, the header (banner), and the footer.

Specified by:
IsFeatureEnabled in interface INavTypes
Returns:
boolean
See Also:
INavTypes.IsFeatureEnabled(com.plumtree.portaluiinfrastructure.navtype.NavFeatureEnum)



Copyright 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.