Plumtree Pluggable Navigation API  
 

NavigationCommonHelpers Members

NavigationCommonHelpers overview

Public Static Fields

iconiconDEFAULT_MENU_TEXT_MAX_LENGTH Default truncation width *
iconiconJSCRIPT_FUNC_BUILD_URL_FROM_TEMPL Javascript function name constant
iconiconJSCRIPT_VAR_DDTABS_ARRAY Javascript variable name constant
iconiconJSCRIPT_VAR_MANDTAB_ARRAY Javascript variable name constant
iconiconURLTEMPLATE_REDIRECT_JSFUNCNAME Url template redirect function. Make the name as short as possible to send down less data

Public Static Methods

iconiconCreateDropDownEndMarkers 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.
iconiconCreateHorizontalSpacerCell Adds a spacer cell with a cell width of 4to the specified HTMLTableRow
iconiconCreateMandatoryTabsArray 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
iconiconCreateVerticalSpacerCell Adds a spacer cell to the specified HTMLTableRow
iconiconEscapeSingleQuotes Prepares a string for use in Javascript code, escapes single quotes (').
iconiconGenerateJSHTMLHelperFunctions 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.
iconiconGetCommunityImageSource Helper function that returns a string with the image source of the formatted image for Communities
iconiconGetCommunityImageURLString Helper function that returns a string with the HTML of the formatted image for Communities
iconiconGetMyPageImageSource Helper function that returns a string with the HTML of the formatted image for Mypages
iconiconGetMyPageImageURLString Helper function that returns a string with the HTML of the formatted image for Mypages
iconiconGetNavSettingsValueAsInt Helper function for getting values of settings in NavigationSettings.xml as integers.
iconiconGetNavSettingsValueAsString Helper function for getting values of settings in NavigationSettings.xml as Strings.
iconiconGetSpacerImage Helper function that creates a spacer Image with specified width and height
iconiconwriteURLTemplateParseFunction 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 Constructors

icon NavigationCommonHelpers Constructor Initializes a new instance of the NavigationCommonHelpers class.

Public Instance Methods

iconEquals (inherited from Object)Determines whether the specified Object is equal to the current Object.
iconGetHashCode (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.
iconGetType (inherited from Object)Gets the Type of the current instance.
iconToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

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

See Also

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