com.plumtree.portalnavigation.views
Class NavigationAccessibleLeftVerticalView

java.lang.Object
  com.plumtree.portalnavigation.views.NavigationCommonVerticalView
      com.plumtree.portalnavigation.views.NavigationAccessibleLeftVerticalView

All Implemented Interfaces:

IManagedObject, IMVCObject, IView

public class NavigationAccessibleLeftVerticalView
extends NavigationCommonVerticalView
implements IView

Accessible navigation view (used for 508, and low bandwidth). This view displays My Pages, My Communities, Directory and mandatory links in vertical sections. Mandatory Communities with tab are not displayed separately from the My Communities section. This view is used by NavTypeAccessible in the Above Body section. It uses helper functions in NavigationCommonVerticalView. No javascript is used.

Author:

MichaelD

Field Summary

static int	ACCESSIBLE_MENU_TEXT_MAX_LENGTH The maximum length of strings before truncation for accessible menu: Needs to be long enough for Community Members and Knowledge Directory
static java.lang.String	STR_MVC_CLASS_NAME MVC object name

Fields inherited from class com.plumtree.portalnavigation.views.NavigationCommonVerticalView

m_asOwner, m_model, MENU_TEXT_MAX_LENGTH

Constructor Summary

NavigationAccessibleLeftVerticalView()

Method Summary

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 static void	AddStandardListRow(HTMLTable table, HTMLElement element) Adds an HTMLTableCell inside an HTMLTableRow with an HTMLAnchor link
protected static void	AddSUBSUBSectionListRow(HTMLTable table, HTMLElement element, boolean bIndent) Adds an HTMLTableCell inside an HTMLTableRow with a subsubsection link, used for related and subcommunities section.=
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
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).
protected void	Write508MyCommunitiesSection(HTMLElementCollection col) Adds an HTMLTable to the HTMLElementCollection with the current Community section
protected void	Write508Section(HTMLElementCollection col, java.lang.String strTitle, ICPListEntryIterator iterator, java.lang.String strIfIteratorEmpty, boolean bShowImages) Adds an HTMLTable to the HTMLElementCollection with the directory section
protected void	WriteCommPages(HTMLElementCollection col, CommunityNavPage commP) Adds an HTMLTable to the HTMLElementCollection with the Community pages section

Methods inherited from class com.plumtree.portalnavigation.views.NavigationCommonVerticalView

AddActionListRow, AddAdminListRow, AddSectionHeaderRow, AddStandardListBoldRow, AddStandardListRow, AddStandardListRow, AddSubSectionHeaderRow, AddSubSectionHeaderRow, AddSubSectionListRow, AddSUBSUBSectionListRow, AddVerticalSpacerRow, CreateActionBarDivider, CreateHeaderTable, CreateListStartTable, Get508PortletAccessAnchors, GetActionCollapseExpandURL, GetCollapseExpandURL, GetSectionCollapseExpandURL, Write508JumpLink, Write508ShortcutsSection, WriteAdminLink, WriteCurCommunitySection, WriteDocumentsSection, WriteMandatoryCommunitiesSection, WriteMandatoryLinksSection, WriteMinimizedSubSectionBar, WriteMyCommunitiesSection, WriteMyPagesSection, WriteRelatedCommunitiesSubSection, WriteSubCommsSubSection, WriteTextRow

Methods inherited from class java.lang.Object

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

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

MVC object name

See Also:

Constant Field Values

ACCESSIBLE_MENU_TEXT_MAX_LENGTH

public static final int ACCESSIBLE_MENU_TEXT_MAX_LENGTH

The maximum length of strings before truncation for accessible menu: Needs to be long enough for Community Members and Knowledge Directory

See Also:

Constant Field Values

Constructor Detail

NavigationAccessibleLeftVerticalView

public NavigationAccessibleLeftVerticalView()

Method Detail

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)

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()

Write508MyCommunitiesSection

protected void Write508MyCommunitiesSection(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

Throws:

java.lang.Exception

HTMLException

Write508Section

protected void Write508Section(HTMLElementCollection col,
                               java.lang.String strTitle,
                               ICPListEntryIterator iterator,
                               java.lang.String strIfIteratorEmpty,
                               boolean bShowImages)
                        throws HTMLException

Adds an HTMLTable to the HTMLElementCollection with the directory section

Parameters:

col - The HTMLElementCollection to add the HTMLTable too

Throws:

HTMLException

WriteCommPages

protected void WriteCommPages(HTMLElementCollection col,
                              CommunityNavPage commP)
                       throws HTMLException

Adds an HTMLTable to the HTMLElementCollection with the Community pages section

Overrides:

WriteCommPages in class NavigationCommonVerticalView

Parameters:

col - The HTMLElementCollection to add the HTMLTable too

commP - The CommunityNavPage

Throws:

HTMLException

AddSUBSUBSectionListRow

protected static void AddSUBSUBSectionListRow(HTMLTable table,
                                              HTMLElement element,
                                              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

element - The element link to add

bIndent - True to indent the string

Throws:

HTMLException

AddSectionHeaderRow

protected void AddSectionHeaderRow(HTMLTable table,
                                   java.lang.String headerString)
                            throws HTMLException

Adds an HTMLTableCell inside an HTMLTableRow with a header bar

Overrides:

AddSectionHeaderRow in class NavigationCommonVerticalView

Parameters:

table - The table to add the generated HTMLTableRow to

headerString - The header string

Throws:

HTMLException

See Also:

NavVisibility

AddStandardListRow

protected static void AddStandardListRow(HTMLTable table,
                                         HTMLElement element)
                                  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

AddCurCommSubSectionHeaderRow

protected void AddCurCommSubSectionHeaderRow(HTMLElementCollection col,
                                             CommunityNavPage commP)
                                      throws HTMLException

Adds an HTMLTable to the HTMLElementCollection with the Subcommunity section

Overrides:

AddCurCommSubSectionHeaderRow in class NavigationCommonVerticalView

Parameters:

col - The HTMLElementCollection to add the HTMLTable too

commP - The CommunityNavPage

Throws:

HTMLException