Plumtree Pluggable Navigation API  
 

NavigationCommonHelpers Methods

The methods of the NavigationCommonHelpers class are listed below. For a complete list of NavigationCommonHelpers class members, see the NavigationCommonHelpers Members topic.

Public Static Methods

CreateDropDownEndMarkers Adds the end of banner markers for ISC dropdown menus. Should be added to below banner view when using ISC menus in the above banner view.
CreateHorizontalSpacerCell Adds a spacer cell with a cell width of 4to the specified HTMLTableRow
CreateMandatoryTabsArray Creates a HTMLScript block with an array of the mandatory tabs to display The javascript array is a two dimensional array - element[i][0]: Name of the mandatory community element[i][1]: Original name of the mandatory community (before truncation), use for tooltip element[i][2]: URL to the mandatory community
CreateVerticalSpacerCell Adds a spacer cell to the specified HTMLTableRow
EscapeSingleQuotes Prepares a string for use in Javascript code, escapes single quotes (').
GenerateJSHTMLHelperFunctions Creates writeStartTable, writeEndOfTable, writeSpacerTable and writeSpacerCell, dynamic HTML generating Javascript helper functions used in .js files to to position dropdown menu tabs and mandatory communities tabs.
GetCommunityImageSource Helper function that returns a string with the image source of the formatted image for Communities
GetCommunityImageURLString Helper function that returns a string with the HTML of the formatted image for Communities
GetMyPageImageSource Helper function that returns a string with the HTML of the formatted image for Mypages
GetMyPageImageURLString Helper function that returns a string with the HTML of the formatted image for Mypages
GetNavSettingsValueAsInt Helper function for getting values of settings in NavigationSettings.xml as integers.
GetNavSettingsValueAsString Helper function for getting values of settings in NavigationSettings.xml as Strings.
GetSpacerImage Helper function that creates a spacer Image with specified width and height
writeURLTemplateParseFunction Parses the ID or IDs needed to create the URL for mypages or community pages (or other types) Needs to be in sync with the IDs put used as data value for each cell. M = MyPages C = Communities , E = Editor, F = Freeform URL (no template) etc

Public Instance Methods

Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

NavigationCommonHelpers Class | com.plumtree.portalpages.common.uiparts Namespace