com.plumtree.portalnavigation.views
Class NavigationCommonVerticalView

java.lang.Object
  extended by com.plumtree.portalnavigation.views.NavigationCommonVerticalView
Direct Known Subclasses:
NavigationAccessibleLeftVerticalView, NavigationSimpleLeftVerticalView, NavigationTabGroupsLeftVerticalView, NavigationTabGroupsTabsView

public class NavigationCommonVerticalView
extends java.lang.Object

Common parent class for vertical navigation schemes. Contains variables and methods common for vertical schemes.

Author:
robertz

Field Summary
protected  AActivitySpace m_asOwner
           
protected  IPluggableNavModelRO m_model
           
static int MENU_TEXT_MAX_LENGTH
          The maximum length of strings before truncation
 
Constructor Summary
NavigationCommonVerticalView()
           
 
Method Summary
protected  void AddActionListRow(HTMLTable table, HTMLAnchor anchor, ASURL collapseLink)
          Adds an HTMLTableCell inside an HTMLTableRow with an action link
protected static void AddAdminListRow(HTMLTable table, HTMLAnchor anchor)
          DCA - Creating HTML for Administration Button Don't need this function
protected  void AddCurCommSubSectionHeaderRow(HTMLElementCollection col, CommunityNavPage commP)
          Adds an HTMLTable to the HTMLElementCollection with the Subcommunity section
protected  void AddSectionHeaderRow(HTMLTable table, java.lang.String headerString)
          Adds an HTMLTableCell inside an HTMLTableRow with a header bar
protected  void AddSectionHeaderRow(HTMLTable table, java.lang.String headerString, int nID, boolean bCollapsed)
          Adds an HTMLTableCell inside an HTMLTableRow with a collapsible/expandable header bar
protected static void AddStandardListBoldRow(HTMLTable table, java.lang.String strLabel)
          Adds an HTMLTableCell inside an HTMLTableRow with a bolded string
protected static void AddStandardListRow(HTMLTable table, ASURL asURL)
          Adds an HTMLTableCell inside an HTMLTableRow with an ASURL link
protected static void AddStandardListRow(HTMLTable table, HTMLAnchor anchor)
          Adds an HTMLTableCell inside an HTMLTableRow with an HTMLAnchor link
protected  void AddSubSectionHeaderRow(HTMLTable table, java.lang.String headerString)
          Adds an HTMLTableCell inside an HTMLTableRow with a section header
protected  void AddSubSectionHeaderRow(HTMLTable table, java.lang.String headerString, int nID, boolean bCollapsed)
          Adds an HTMLTableCell inside an HTMLTableRow with a collapsible/expandable section header
protected static void AddSubSectionListRow(HTMLTable table, HTMLAnchor anchor)
          Adds an HTMLTableCell inside an HTMLTableRow with a subsection link
protected static void AddSUBSUBSectionListRow(HTMLTable table, HTMLAnchor anchor, boolean bIndent)
          Adds an HTMLTableCell inside an HTMLTableRow with a subsubsection link, used for related and subcommunities section.=
protected static void AddVerticalSpacerRow(HTMLTable table)
          Adds an HTMLTableCell inside an HTMLTableRow with a spacer row
protected  HTMLTableCell CreateActionBarDivider()
          Helper function that gets a table cell used as a thin divider.
static HTMLTable CreateHeaderTable(boolean bSpacer)
          Helper method that creates a header HTMLTable
static HTMLTable CreateListStartTable()
          Helper method that creates an HTMLTable to start a list
protected  HTMLElementCollection Get508PortletAccessAnchors()
          Return a collection of access key anchors elements pointing to each portlet displayed.
 ASURL GetActionCollapseExpandURL(int nSectionID, boolean bCollapse)
          Gets the ASURL with image to collapse/expand vertical actions subsection
protected  ASURL GetCollapseExpandURL(int nSectionID, boolean bCollapse)
          Generates the ASURL with just the URL to the control for collapse/expanding vertical navigation sections.
 ASURL GetSectionCollapseExpandURL(int nSectionID, boolean bCollapse)
          Gets the ASURL with image to collapse/expand vertical navigation sections
 void Write508JumpLink(HTMLElementCollection result)
          This method displays the hidden link after the navigation banner so that 508 users can skip the navigation.
 void Write508ShortcutsSection(HTMLElementCollection result)
          This method displays the access key shortcuts for the 508 banner.
protected  void WriteAdminLink(HTMLElementCollection col)
          Adds an HTMLTable with the Administration link to the specified HTMLElementCollection
protected  void WriteCommPages(HTMLElementCollection col, CommunityNavPage commP)
          Adds an HTMLTable to the HTMLElementCollection with the Community pages section
protected  void WriteCurCommunitySection(HTMLElementCollection col, CommunityNavPage commP)
          Adds an HTMLTable to the HTMLElementCollection with the current Community section, with the Community pages, Subcommunities and related communities
protected  void WriteDocumentsSection(HTMLElementCollection col)
          Adds an HTMLTable to the HTMLElementCollection with the directory section
protected  void WriteMandatoryCommunitiesSection(HTMLElementCollection col)
          Adds an HTMLTable to the HTMLElementCollection with the Mandatory Communities section.
protected  void WriteMandatoryLinksSection(HTMLElementCollection col)
          Adds an HTMLTable to the HTMLElementCollection with the Mandatory links section
protected  void WriteMinimizedSubSectionBar(HTMLTable table, java.lang.String strTitle, int nID, ICPListEntryIterator cpList)
          Adds an HTMLTableRow to specified HTMLTable with a collapsed Subsection Bar.
protected  void WriteMyCommunitiesSection(HTMLElementCollection col)
          Adds an HTMLTable to the HTMLElementCollection with the current Community section
protected  void WriteMyPagesSection(HTMLElementCollection col)
          Adds an HTMLTable to the HTMLElementCollection with the Mypage links section
protected  void WriteRelatedCommunitiesSubSection(HTMLElementCollection col, CommunityNavPage commP)
          Adds an HTMLTable to the HTMLElementCollection with the Related communities section of the current community
protected  void WriteSubCommsSubSection(HTMLElementCollection col, CommunityNavPage commP)
          Adds an HTMLTable to the HTMLElementCollection with the Subcommunities section of the current community
static void WriteTextRow(HTMLTable table, java.lang.String text)
          Adds an HTMLTableCell inside an HTMLTableRow with just a string and no anchor to the specified HTMLTable.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MENU_TEXT_MAX_LENGTH

public static final int MENU_TEXT_MAX_LENGTH
The maximum length of strings before truncation

See Also:
Constant Field Values

m_asOwner

protected AActivitySpace m_asOwner

m_model

protected IPluggableNavModelRO m_model
Constructor Detail

NavigationCommonVerticalView

public NavigationCommonVerticalView()
Method Detail

Write508JumpLink

public void Write508JumpLink(HTMLElementCollection result)
                      throws HTMLException
This method displays the hidden link after the navigation banner so that 508 users can skip the navigation. This is mainly relevant for IE.

Parameters:
HTMLElementCollection - the collection to add the shortcut section to.
Throws:
HTMLException

Write508ShortcutsSection

public void Write508ShortcutsSection(HTMLElementCollection result)
                              throws HTMLException
This method displays the access key shortcuts for the 508 banner. This is mainly relevant for IE. These entries need to appear every time, unlike the normal navigation bar, where

Parameters:
HTMLElementCollection - the collection to add the shortcut section to.
Throws:
HTMLException

Get508PortletAccessAnchors

protected HTMLElementCollection Get508PortletAccessAnchors()
Return a collection of access key anchors elements pointing to each portlet displayed.

Returns:

CreateListStartTable

public static HTMLTable CreateListStartTable()
Helper method that creates an HTMLTable to start a list

Returns:
Table template for lists

CreateHeaderTable

public static HTMLTable CreateHeaderTable(boolean bSpacer)
Helper method that creates a header HTMLTable

Parameters:
bSpacer - True to add a spacer row below the header
Returns:
Table template for headers

WriteTextRow

public static void WriteTextRow(HTMLTable table,
                                java.lang.String text)
                         throws HTMLException
Adds an HTMLTableCell inside an HTMLTableRow with just a string and no anchor to the specified HTMLTable.

Parameters:
table - The table to add the generated HTMLTableRow to
text - Label to add
Throws:
HTMLException

GetCollapseExpandURL

protected ASURL GetCollapseExpandURL(int nSectionID,
                                     boolean bCollapse)
Generates the ASURL with just the URL to the control for collapse/expanding vertical navigation sections.

Parameters:
nSectionID - NavVisibility ID of the navigation section
bCollapsed - True if the entire section is collapsed
Returns:
ASURL Generated ASURL with just the URL
Throws:
HTMLException
See Also:
NavVisibility

GetSectionCollapseExpandURL

public ASURL GetSectionCollapseExpandURL(int nSectionID,
                                         boolean bCollapse)
Gets the ASURL with image to collapse/expand vertical navigation sections

Parameters:
nSectionID - NavVisibility ID of the navigation section
bCollapsed - True if the entire section is collapsed
Returns:
ASURL Generated ASURL with image for collapsing/expanding section
See Also:
NavVisibility

GetActionCollapseExpandURL

public ASURL GetActionCollapseExpandURL(int nSectionID,
                                        boolean bCollapse)
                                 throws HTMLException
Gets the ASURL with image to collapse/expand vertical actions subsection

Parameters:
nSectionID - NavVisibility ID of the navigation section
bCollapsed - True if the entire section is collapsed
Returns:
ASURL Generated ASURL with image for collapsing/expanding actions section
Throws:
java.lang.Exception
HTMLException
See Also:
NavVisibility

AddAdminListRow

protected static void AddAdminListRow(HTMLTable table,
                                      HTMLAnchor anchor)
                               throws HTMLException
DCA - Creating HTML for Administration Button Don't need this function

Parameters:
table - HTMLTable to add the generated row to
asURL - Administrator ASURL
Throws:
HTMLException

AddActionListRow

protected void AddActionListRow(HTMLTable table,
                                HTMLAnchor anchor,
                                ASURL collapseLink)
                         throws HTMLException
Adds an HTMLTableCell inside an HTMLTableRow with an action link

Parameters:
table - The table to add the generated HTMLTableRow to
text - Label to add
collapseLink - Display the link to collapse the current action subsection
Throws:
HTMLException

AddVerticalSpacerRow

protected static void AddVerticalSpacerRow(HTMLTable table)
Adds an HTMLTableCell inside an HTMLTableRow with a spacer row

Parameters:
table - The table to add the generated HTMLTableRow to
Throws:
HTMLException

AddSectionHeaderRow

protected void AddSectionHeaderRow(HTMLTable table,
                                   java.lang.String headerString)
                            throws HTMLException
Adds an HTMLTableCell inside an HTMLTableRow with a header bar

Parameters:
table - The table to add the generated HTMLTableRow to
headerString - The header string
Throws:
HTMLException

AddSectionHeaderRow

protected void AddSectionHeaderRow(HTMLTable table,
                                   java.lang.String headerString,
                                   int nID,
                                   boolean bCollapsed)
                            throws HTMLException
Adds an HTMLTableCell inside an HTMLTableRow with a collapsible/expandable header bar

Parameters:
table - The table to add the generated HTMLTableRow to
headerString - The header string
nID - NavVisibility ID of the navigation section
bCollapsed - True if the entire section is collapsed
Throws:
HTMLException
See Also:
NavVisibility

AddStandardListRow

protected static void AddStandardListRow(HTMLTable table,
                                         ASURL asURL)
                                  throws HTMLException
Adds an HTMLTableCell inside an HTMLTableRow with an ASURL link

Parameters:
table - The table to add the generated HTMLTableRow to
asURL - The ASURL link to add
Throws:
HTMLException
See Also:
NavVisibility

AddStandardListRow

protected static void AddStandardListRow(HTMLTable table,
                                         HTMLAnchor anchor)
                                  throws HTMLException
Adds an HTMLTableCell inside an HTMLTableRow with an HTMLAnchor link

Parameters:
table - The table to add the generated HTMLTableRow to
anchor - The anchor link to add
Throws:
HTMLException

AddStandardListBoldRow

protected static void AddStandardListBoldRow(HTMLTable table,
                                             java.lang.String strLabel)
                                      throws HTMLException
Adds an HTMLTableCell inside an HTMLTableRow with a bolded string

Parameters:
table - The table to add the generated HTMLTableRow to
strLabel - The string to display
Throws:
HTMLException

AddSUBSUBSectionListRow

protected static void AddSUBSUBSectionListRow(HTMLTable table,
                                              HTMLAnchor anchor,
                                              boolean bIndent)
                                       throws HTMLException
Adds an HTMLTableCell inside an HTMLTableRow with a subsubsection link, used for related and subcommunities section.=

Parameters:
table - The table to add the generated HTMLTableRow to
anchor - The anchor link to add
bIndent - True to indent the string
Throws:
HTMLException

AddSubSectionListRow

protected static void AddSubSectionListRow(HTMLTable table,
                                           HTMLAnchor anchor)
                                    throws HTMLException
Adds an HTMLTableCell inside an HTMLTableRow with a subsection link

Parameters:
table - The table to add the generated HTMLTableRow to
anchor - The anchor link to add
Throws:
HTMLException

AddSubSectionHeaderRow

protected void AddSubSectionHeaderRow(HTMLTable table,
                                      java.lang.String headerString)
                               throws HTMLException
Adds an HTMLTableCell inside an HTMLTableRow with a section header

Parameters:
table - The table to add the generated HTMLTableRow to
headerString - The header string to display
Throws:
HTMLException

AddSubSectionHeaderRow

protected void AddSubSectionHeaderRow(HTMLTable table,
                                      java.lang.String headerString,
                                      int nID,
                                      boolean bCollapsed)
                               throws HTMLException
Adds an HTMLTableCell inside an HTMLTableRow with a collapsible/expandable section header

Parameters:
table - The table to add the generated HTMLTableRow to
headerString - The header string to display
nID - NavVisibility ID of the navigation section
bCollapsed - True if the entire section is collapsed
Throws:
HTMLException
See Also:
NavVisibility

AddCurCommSubSectionHeaderRow

protected void AddCurCommSubSectionHeaderRow(HTMLElementCollection col,
                                             CommunityNavPage commP)
                                      throws HTMLException
Adds an HTMLTable to the HTMLElementCollection with the Subcommunity section

Parameters:
col - The HTMLElementCollection to add the HTMLTable too
commP - The CommunityNavPage
Throws:
HTMLException

WriteAdminLink

protected void WriteAdminLink(HTMLElementCollection col)
                       throws HTMLException,
                              java.lang.Exception
Adds an HTMLTable with the Administration link to the specified HTMLElementCollection

Parameters:
col - HTMLCollection to add the Admin HTMLTable too
Throws:
HTMLException
java.lang.Exception

WriteCurCommunitySection

protected void WriteCurCommunitySection(HTMLElementCollection col,
                                        CommunityNavPage commP)
                                 throws java.lang.Exception
Adds an HTMLTable to the HTMLElementCollection with the current Community section, with the Community pages, Subcommunities and related communities

Parameters:
col - The HTMLElementCollection to add the HTMLTable too
commP - The CommunityNavPage
Throws:
java.lang.Exception

WriteMyCommunitiesSection

protected void WriteMyCommunitiesSection(HTMLElementCollection col)
                                  throws HTMLException,
                                         java.lang.Exception
Adds an HTMLTable to the HTMLElementCollection with the current Community section

Parameters:
col - The HTMLElementCollection to add the HTMLTable too
commP - The CommunityNavPage
Throws:
java.lang.Exception
HTMLException

WriteCommPages

protected void WriteCommPages(HTMLElementCollection col,
                              CommunityNavPage commP)
                       throws HTMLException
Adds an HTMLTable to the HTMLElementCollection with the Community pages section

Parameters:
col - The HTMLElementCollection to add the HTMLTable too
commP - The CommunityNavPage
Throws:
HTMLException

WriteSubCommsSubSection

protected void WriteSubCommsSubSection(HTMLElementCollection col,
                                       CommunityNavPage commP)
                                throws HTMLException,
                                       java.lang.Exception
Adds an HTMLTable to the HTMLElementCollection with the Subcommunities section of the current community

Parameters:
col - The HTMLElementCollection to add the HTMLTable too
commP - The CommunityNavPage
Throws:
java.lang.Exception
HTMLException
java.lang.Exception

WriteDocumentsSection

protected void WriteDocumentsSection(HTMLElementCollection col)
                              throws HTMLException
Adds an HTMLTable to the HTMLElementCollection with the directory section

Parameters:
col - The HTMLElementCollection to add the HTMLTable too
Throws:
HTMLException

WriteMandatoryCommunitiesSection

protected void WriteMandatoryCommunitiesSection(HTMLElementCollection col)
                                         throws HTMLException,
                                                java.lang.Exception
Adds an HTMLTable to the HTMLElementCollection with the Mandatory Communities section. Note that My communities section lists these aswell.

Parameters:
col - The HTMLElementCollection to add the HTMLTable too
Throws:
java.lang.Exception
HTMLException

WriteMandatoryLinksSection

protected void WriteMandatoryLinksSection(HTMLElementCollection col)
                                   throws HTMLException
Adds an HTMLTable to the HTMLElementCollection with the Mandatory links section

Parameters:
col - The HTMLElementCollection to add the HTMLTable too
Throws:
HTMLException

WriteMinimizedSubSectionBar

protected void WriteMinimizedSubSectionBar(HTMLTable table,
                                           java.lang.String strTitle,
                                           int nID,
                                           ICPListEntryIterator cpList)
                                    throws HTMLException,
                                           java.lang.Exception
Adds an HTMLTableRow to specified HTMLTable with a collapsed Subsection Bar. Used to display collapsed actions subsection with only the action images.

Parameters:
table - The HTMLTable to add the generated row too.
strTitle - Subsection header string
nID - NavVisibility ID of the section
cpList - Actions as ICPListEntryIterator
Throws:
HTMLException
java.lang.Exception

WriteMyPagesSection

protected void WriteMyPagesSection(HTMLElementCollection col)
                            throws HTMLException,
                                   java.lang.Exception
Adds an HTMLTable to the HTMLElementCollection with the Mypage links section

Parameters:
col - The HTMLElementCollection to add the HTMLTable too
Throws:
HTMLException
java.lang.Exception

WriteRelatedCommunitiesSubSection

protected void WriteRelatedCommunitiesSubSection(HTMLElementCollection col,
                                                 CommunityNavPage commP)
                                          throws HTMLException
Adds an HTMLTable to the HTMLElementCollection with the Related communities section of the current community

Parameters:
col - The HTMLElementCollection to add the HTMLTable too
commP - The CommunityNavPage
Throws:
HTMLException

CreateActionBarDivider

protected HTMLTableCell CreateActionBarDivider()
                                        throws HTMLException
Helper function that gets a table cell used as a thin divider.

Returns:
HTMLTableCell Divider cell
Throws:
HTMLException



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