com.plumtree.portalpages.common.uiparts
Class NavigationJSPortalMenuHelpers

java.lang.Object
  com.plumtree.portalpages.common.uiparts.NavigationJSPortalMenuHelpers

public class NavigationJSPortalMenuHelpers
extends java.lang.Object

NavigationJSPortalMenuHelpers provides helper methods to pluggable navigations that use the Plumtree JS Portal Menu Drop Downs. The available helper methods are MakeDDMenu and GetPlumtreeJSFrameworkJavaScript. MakeDDMenu will write to javascript the list of links to be displayed in a drop down menu in the format that the javascript framework for these drop downs will recognize. It uses the String strMenuID to determine which tab the drop down menu is to drop down from, and it uses the ICPListEntryIterator cpList to iterate through and write out each of these links. MakeDDMenu should be called from inside the drop down view, once for each drop down menu. See com.plumtree.portalnavigation.NavigationJSPortalMenuDropDownView to see how MakeDDMenu is used there. GetPlumtreeJSFrameworkJavaScript returns a HTMLScriptCollection of the javascript that is needed for use by the jsportalmenus. This includes several .js files. GetPlumtreeJSFrameworkJavaScript should be called in the drop down NavType's JavaScriptIncludes method. See com.plumtree.portalnavigation.NavTypeJSPortalMenuDropDown to see how GetPlumtreeJSFrameworkJavaScript is used there.

Author:

MichaelD

Field Summary

static java.lang.String	COL_ARRAY_ID_PREFIX
static java.lang.String	DATA_ARRAY_ID_PREFIX Prefix of the Javascript array names
static int	DEFAULT_DDMENU_TEXT_MAX_LENGTH Default width of text in the ISC dropdown menus
static java.lang.String	LISTVIEW_ID_PREFIX
static java.lang.String	m_strCommID IDs of the ISC ListViewer objects
static java.lang.String	m_strDocID
static java.lang.String	m_strMandLinksID
static java.lang.String	m_strMyPageID
static java.lang.String	m_strPrefsID
static java.lang.String	m_strSubCommID

Constructor Summary

NavigationJSPortalMenuHelpers()

Method Summary

static HTMLScript	GetPlumtreeCommunityTabJavaScript(AActivitySpace owner) Defines the required javascript includes for the navigation schemes using Community Tabs.
static HTMLScriptCollection	GetPlumtreeJSFrameworkJavaScript(AActivitySpace owner) Defines the required javascript includes for the navigation schemes using Plumtree's jsportalmenu JavaScript framework
static HTMLScriptCollection	GetPlumtreeJSFrameworkNoCommunityTabJavaScript(AActivitySpace owner) Defines the required javascript includes for the navigation schemes using Plumtree's jsportalmenu JavaScript framework
static HTMLScript	GetPlumtreeMandatoryTabJavaScript(AActivitySpace owner) Defines the required javascript includes for the navigation schemes using Mandatory Tabs.
static void	MakeDDMenu(HTMLScriptCollection col, AActivitySpace parent, ICPListEntryIterator cpList, java.lang.String strMenuID) Helper function to populate and create a new JS Portal Menu ListViewer object used for the dropdown menu.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DDMENU_TEXT_MAX_LENGTH

public static final int DEFAULT_DDMENU_TEXT_MAX_LENGTH

Default width of text in the ISC dropdown menus

See Also:

Constant Field Values

DATA_ARRAY_ID_PREFIX

public static final java.lang.String DATA_ARRAY_ID_PREFIX

Prefix of the Javascript array names

See Also:

Constant Field Values

COL_ARRAY_ID_PREFIX

public static final java.lang.String COL_ARRAY_ID_PREFIX

See Also:

Constant Field Values

LISTVIEW_ID_PREFIX

public static final java.lang.String LISTVIEW_ID_PREFIX

See Also:

Constant Field Values

m_strCommID

public static final java.lang.String m_strCommID

IDs of the ISC ListViewer objects

See Also:

Constant Field Values

m_strDocID

public static final java.lang.String m_strDocID

See Also:

Constant Field Values

m_strMandLinksID

public static final java.lang.String m_strMandLinksID

See Also:

Constant Field Values

m_strMyPageID

public static final java.lang.String m_strMyPageID

See Also:

Constant Field Values

m_strPrefsID

public static final java.lang.String m_strPrefsID

See Also:

Constant Field Values

m_strSubCommID

public static final java.lang.String m_strSubCommID

See Also:

Constant Field Values

Constructor Detail

NavigationJSPortalMenuHelpers

public NavigationJSPortalMenuHelpers()

Method Detail

MakeDDMenu

public static void MakeDDMenu(HTMLScriptCollection col,
                              AActivitySpace parent,
                              ICPListEntryIterator cpList,
                              java.lang.String strMenuID)

Helper function to populate and create a new JS Portal Menu ListViewer object used for the dropdown menu. Inserts javascript into the HTMLScriptCollection passed to the method.

Parameters:

col - HTMLScriptCollection

parent - Activityspace

cpList - List with links to populate the menu with

strMenuID - ID of the menu

GetPlumtreeJSFrameworkJavaScript

public static HTMLScriptCollection GetPlumtreeJSFrameworkJavaScript(AActivitySpace owner)

Defines the required javascript includes for the navigation schemes using Plumtree's jsportalmenu JavaScript framework

Returns:

HTMLScriptCollection of the script needed for the jsportalmenus

GetPlumtreeJSFrameworkNoCommunityTabJavaScript

public static HTMLScriptCollection GetPlumtreeJSFrameworkNoCommunityTabJavaScript(AActivitySpace owner)

Defines the required javascript includes for the navigation schemes using Plumtree's jsportalmenu JavaScript framework

Returns:

HTMLScriptCollection of the script needed for the jsportalmenus

GetPlumtreeMandatoryTabJavaScript

public static HTMLScript GetPlumtreeMandatoryTabJavaScript(AActivitySpace owner)

Defines the required javascript includes for the navigation schemes using Mandatory Tabs.

Returns:

HTMLScript of the script needed for the tabs (Mandatory Links, Administration, Mandatory Communities, My Pages, My Communities)

GetPlumtreeCommunityTabJavaScript

public static HTMLScript GetPlumtreeCommunityTabJavaScript(AActivitySpace owner)

Defines the required javascript includes for the navigation schemes using Community Tabs.

Returns:

HTMLScript of the script needed for the community tabs (Community Pages, Related Communities, Subcommunities)