com.plumtree.portalnavigation.views
Class NavigationJSPortalMenuDropDownView

java.lang.Object
  com.plumtree.portalnavigation.views.NavigationJSPortalMenuDropDownView

All Implemented Interfaces:

IManagedObject, IMVCObject, IView

public class NavigationJSPortalMenuDropDownView
extends java.lang.Object
implements IView

Horizontal navigaton scheme with dropdown menus using the JSPortalMenu framework. This navigation view displays "My Pages", "My Communities", "Directory" and mandatory links dropdown menus using the JSPortalMenu framework. Mandatory communities and link to Administration are displayed using same tabs as the menu tabs. The tabs will wrap to multiple rows if there are too many tabs to fit on one row. This view is used by the NavTypeJSPortalMenuDropDown in the above banner view. The menu framework is defined in navjsportalmenufuncs.js and functions in navjsportalmenucommon.js is used for the mandatory community tabs. Now supports browser detection internally, so this view can be used as a nested view by other navigation views. This view supports auto-browser handling so it can be used by external custom navigations. Custom navs that use this view MUST also use the JavaScriptIncludes() method on NavTypeJSPortalMenuDropDown to return proper javascript to support this view.

Author:

RobertZ, DavidP

Field Summary

protected int	m_nDirectoryMenuEntries
protected int	m_nMandatoryLinksEntries
protected int	m_nMyCommsMenuEntries
protected int	m_nMyPageMenuEntries
static java.lang.String	STR_MVC_CLASS_NAME Drop down view class name

Constructor Summary

NavigationJSPortalMenuDropDownView()

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
protected void	CreateCommMembershipMenu(HTMLScriptCollection col) Creates the dropdown menu with the Communities the current user is a member of.
protected HTMLScript	CreateDDTabsArray() This function populates an array of Tabs with the navigation menus to show Element 0: Display name Element 1: ID of the menu Element 2: Tooltip (if needed);
protected void	CreateDocMenu(HTMLScriptCollection col) Creates the dropdown menu with the Directory links.
protected void	CreateMandatoryLinksMenu(HTMLScriptCollection col) Creates the dropdown menu with the current user's Mandatory Links Defines javascript variables in HTMLScript blocks that are added to the HTMLScriptCollection
protected void	CreateMyPageMenu(HTMLScriptCollection col) Creates the dropdown menu with the current user's My pages Defines javascript variables in HTMLScript blocks that are added to the HTMLScriptCollection
HTMLElement	Display() This method returns the HTMLElement that encompasses the output of the View.
HTMLScript	DisplayJavascript() This method returns the HTMLScript that encompasses the Javascript on the page.
java.lang.String	GetName() Return the name of the MVC object.
void	Init(IModelRO model, AActivitySpace parent) This method initializes the View with the read only model interface it is supposed to draw it's data from as well as it's parent ActivitySpace (necessary to create URLS).

Methods inherited from class java.lang.Object

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

Field Detail

m_nMyPageMenuEntries

protected int m_nMyPageMenuEntries

m_nMyCommsMenuEntries

protected int m_nMyCommsMenuEntries

m_nDirectoryMenuEntries

protected int m_nDirectoryMenuEntries

m_nMandatoryLinksEntries

protected int m_nMandatoryLinksEntries

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

Drop down view class name

See Also:

Constant Field Values

Constructor Detail

NavigationJSPortalMenuDropDownView

public NavigationJSPortalMenuDropDownView()

Method Detail

Create

public java.lang.Object Create()

Description copied from interface: IManagedObject

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

Display

public HTMLElement Display()

Description copied from interface: IView

This method returns the HTMLElement that encompasses the output of the View.

Specified by:

Display in interface IView

See Also:

IView.Display()

DisplayJavascript

public HTMLScript DisplayJavascript()

This method returns the HTMLScript that encompasses the Javascript on the page.

Specified by:

DisplayJavascript in interface IView

Returns:

HTMLScript

See Also:

IView.DisplayJavascript()

GetName

public java.lang.String GetName()

Description copied from interface: IMVCObject

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Returns:

the name of the object.

See Also:

IMVCObject.GetName()

Init

public void Init(IModelRO model,
                 AActivitySpace parent)

Description copied from interface: IView

This method initializes the View with the read only model interface it is supposed to draw it's data from as well as it's parent ActivitySpace (necessary to create URLS).

Specified by:

Init in interface IView

See Also:

IView.Init(IModelRO, AActivitySpace)

CreateCommMembershipMenu

protected void CreateCommMembershipMenu(HTMLScriptCollection col)
                                 throws HTMLException

Creates the dropdown menu with the Communities the current user is a member of. Defines javascript variables in HTMLScript blocks that are added to the HTMLScriptCollection

Parameters:

col - The HTMLScriptCollection to add the javascript too

Throws:

HTMLException

CreateDDTabsArray

protected HTMLScript CreateDDTabsArray()
                                throws HTMLException

This function populates an array of Tabs with the navigation menus to show Element 0: Display name Element 1: ID of the menu Element 2: Tooltip (if needed);

Parameters:

script - HTMLScript block with the array

Throws:

HTMLException

CreateDocMenu

protected void CreateDocMenu(HTMLScriptCollection col)
                      throws HTMLException

Creates the dropdown menu with the Directory links. Defines javascript variables in HTMLScript blocks that are added to the HTMLScriptCollection

Parameters:

col - The HTMLScriptCollection to add the javascript too

Throws:

HTMLException

CreateMandatoryLinksMenu

protected void CreateMandatoryLinksMenu(HTMLScriptCollection col)
                                 throws HTMLException

Creates the dropdown menu with the current user's Mandatory Links Defines javascript variables in HTMLScript blocks that are added to the HTMLScriptCollection

Parameters:

col - The HTMLScriptCollection to add the javascript too

Throws:

HTMLException

CreateMyPageMenu

protected void CreateMyPageMenu(HTMLScriptCollection col)
                         throws HTMLException

Creates the dropdown menu with the current user's My pages Defines javascript variables in HTMLScript blocks that are added to the HTMLScriptCollection

Parameters:

col - The HTMLScriptCollection to add the javascript too

Throws:

HTMLException