<portal-navigation/> tags

<portal-navigation/> tags

The <portal-navigation/> tags are used to implement navigation tasks such as generating URLs and traversing the portal navigation model.
The following section provides detailed descriptions of the <portal-navigation/> JSP tags:
<portal:favoritesLoop/>
This tag is deprecated and should be replaced using the <portal-navigation:navigation/> tag with its scopeUniqueName attribute.
The following code example uses this tag to create the Organize Favorites functionality. To use this code, place it within the themes to have this functionality.
<%@ taglib uri="/WEB-INF/tld/portal.tld" prefix="portal" %>
<portal-logic:if loggedIn="yes" notScreen="SelfcareUserForm,SelfcareUserConf">
<table border="0" cellspacing="0" cellpadding="0" >
 <tr>
 <td align="<%=bidiAlignRight%>" valign="middle" dir="ltr" nowrap>
 <%
 boolean firstItem = true;
 %>        
  <table border="0" cellpadding="0" cellspacing="0" <%= bidiDirAttr %> >
 <tr>
 <td valign="middle">
 <form tabIndex="8" name="wpsFavoritesSelectionForm" method="GET"    style="margin-bottom: 0">   
  <select name="favoritesCommand" onchange="document.location.href=this.options[this.selectedIndex].value">
   <option value='#' selected><wps:text key='link.favorites.myfavorites'
   bundle='nls.engine'/>
    <portal-logic:if pageBookmarkable="true">
   <option value='<portal-navigation:url command="AddBookmark"
   alias="wps.My Favorites"/>'><portal-fmt:text key='link.favorites.add'
   bundle='nls.engine'/>
   </portal-logic:if>
    <portal-navigation:urlGeneration contentNode="wps.Organize Favorites"
   portletWindowState="Normal" pacCheck="NoCheck">
   <option value='<% wpsURL.write(escapeXmlWriter); %>' >
   <portal-fmt:text key='link.favorites.orgainize' bundle='nls.engine'/>
   </portal-navigation:urlGeneration>
    <option value='#'>------------
          <portal:favoritesLoop>
    <%      // wpsFavoritesURL is null for folders in the list of favorites
    if (wpsFavoritesURL != null)
    {
    // Check the favorite type.  If it is an external URL, add a symbol to the URL     
    // so the JavaScript on the select can detect when to open a new window     
    // wpsFavoritesType may be null.  wpsFavoritesType=1 means external URL      
    if ("EXTERNALURL".equals(wpsFavoritesType))
     wpsFavoritesURL = "@" + wpsFavoritesURL;
    //Phone number links are only supported on WML devices... and favorites are not markup-specific.
    // wpsFavoritesType may be null.  wpsFavoritesType=2 means Phone Number      
    if (!"2".equals(wpsFavoritesType))
     {
     %>
     <option value="<%= wpsFavoritesURL %>">
     <% for (int favSpace=1; favSpace < wpsFavoritesLevel.intValue();
     favSpace++) {%>   <% } %><%= wpsFavoritesTitle %>
     <%
     }
     }
     else      {
     %>
     <option value="#" ><% for (int favSpace=1;  favSpace < wpsFavoritesLevel.intValue();
     favSpace++) {%>   <% } %>--<%= wpsFavoritesTitle %>--
     <%
     }
     %>
     </portal:favoritesLoop>
    </select>
    <noscript>
    <input type="image" border="0" align="absmiddle"
    src='<portal-logic:urlFindInTheme file="go.gif"/>'/>
    <span class="wpsPlaceBarLink" > <portal-fmt:text key="go"
    bundle="nls.button"/></span>
    </noscript>
    </form>
    </td>
   </tr>
  </table>
  </td>
 </tr>
</table>
</portal-logic:if>
<portal-navigation:navigation>
This tag initializes a set of objects and makes them available through scripting variables. These objects are required for the rendering process of the navigation. The scripting variables are accessible only within the body of the tag. The settings of the startLevel and stopLevel attributes determine whether the content of the navigation tag is evaluated. The navigation tag uses an "in-order" traversal of the navigation tree to select the nodes.
Attributes are as follows:
startLevel

Optional. The level on which this navigation is to begin showing information. If no start level is given, this tag will start at the navigation node after the levels that where shown by other JSPs. Otherwise, the default is level 1.

stopLevel

Optional. The level on which this navigation is to stop showing information. Default is to render all levels.

computeNumLevelsToDisplay

Optional. Compute the number of levels shown by this navigation. When this attribute is set to true, a scripting variable is made available inside the body of the navigation tag named wpsNumLevelsToDisplay of Java type java.lang.Integer.

scopeUniqueName
Specifies where to start the rendering of the portal navigation. The expected value is a unique name or string representation of the navigation node's ObjectID. This also replaces the <portal:favoritesLoop/> tag for enabling Organize Favorites functionality. The following code example shows how to use the <portal-navigation:navigation> with the scopeUniqueName attribute to enable Organize Favorites:
<portal-navigation:navigation scopeUniqueName="wps.Favorites">
   <portal-navigation:navigationLoop>
     <a href='<portal-navigation:navigationUrl type="link"/>'
        title='<portal-fmt:description varname="<%=wpsNavNode%>"/>'>
           <portal-fmt:title varname="<%=wpsNavNode%>"/>
     </a>
   </portal-navigation:navigationLoop>
 </portal-navigation:navigation>
<portal-navigation:navigationLoop>

This tag traverses through the navigation model. This tag is nested inside of the <portal-navigation:navigation/> tag when used. This tag indicates the part of the markup that will be repeated once for each navigation node. There are no attributes for this tag. The body of this tag is executed for each navigation node. This tag makes several scripting variables available for obtaining information for the navigation. These scripting variables are accessible only within the body of the tag.

<portal-navigation:navigationShift by="number" maxPages="number">

This tag is used in the navigation to create a URL that scrolls to the next set of page links when the number of available pages exceeds maxPages. The by attribute indicates the number of page links to scroll. If this tag is not used, all page links for the current level are rendered.
This tag is nested in the <portal-navigation:navigation> tag and requires values for the startLevel and stopLevel attributes of the <portal-navigation:navigation> tag for its correct functioning.

<portal-navigation:navigationUrl type="link|expand|collapse|launch" varname="node" var="variable_name"/>

Creates URLs for navigation nodes. The tag is used inside the body of the <portal-navigation:navigationLoop> tag and outputs links for the current navigation node according to the type attribute.
Attributes are as follows:

type

Use one of the following values:

type="link"

Create a URL to change the selected node.

type="expand"

Create a URL that expands the node to reveal its child nodes. This is intended for expanding the navigation tree.

type="collapse"

Create a URL that collapses the node to conceal its child nodes. This is intended for collapsing the navigation tree.

type="launch"

Create a URL that either launches a page if all conditions for the page launch are fulfilled for the navigation node or if just like in the selection URL in type="link".

The global state of the portal navigation trees is collapsed by default (with some exceptions, such as the Portal Administration navigation). We configure the default state of the portal navigation trees to expand all nodes by setting the Portal Configuration Service property navigation.expansion.defaultstate to true.

varname

This attribute specifies an object of type com.ibm.portal.navigation.NavigationNode for which the URL is to be generated. The attribute is optional.

var

Name of a scripting variable that is exposed in the body of the tag. The attribute is optional. The variable exposes an object that implements com.ibm.portal.DisposableURL used to stream the URL to the output. If the content node referenced by the navigation node is an internal URL, the body is evaluated only if the target of the internal URL is accessible.

forceAbsolute = "true|false"

Optional. It specifies whether the URL generated by this tag is to be absolute or not. If true, absolute URLs are enforced; in this case other settings that affect the generation of URLs might be overridden.

keepNavigationalState="true|false"

If this attribute is set to false, the current navigational state (including all portlet modes, states, and render parameters) is not included in the URL and the portal is reset to its default state. If true, which is the default, navigational state is included.

To generate the title or description of a navigation node, use the <portal-fmt:title/> or the <portal-fmt:description/> tags. This tag is used only in theme JSPs.

<portal-navigation:url>
Creates a portal URL depending on the specified attribute. Attributes are as follows:
home="public|protected"

Create a URL pointing to the public or protected (logged in) page of the portal.

screen="screen_name"

Create a URL pointing to the screen name to be displayed.

command="LoginUser|LogoutUser|ShowTools"

Create a URL bannersues the command to the portal. command="LoginUser" is used for the login panel, and command="LogoutUser" is used for the logout button. The "userid" and "password" parameters have to be carried with a login URL. command="ShowTools" toggles the value of the showTools indicator. See the <portal-logic:if/> tag "showtools" attribute in for an example.

commandParam="parameter_name"
This attribute directs the portal engine to obtain the actual command to execute from an HTTP request parameter instead of on the URL directly. The name of the parameter is the value of the commandParam attribute. This is useful in situations where different commands need to be conditionally executed yet only one URL can be specified. Such is the case when using a <form> tag with a <select>. This enables use of the HTML form without requiring JavaScript. For example:
   
<form name="someFormName" 
      method="GET" style="margin-bottom: 0"
      action='<portal-navigation:url 
      commandParam="requestParamName"/>'>

    <select name="requestParamName" onchange="javascript: this.form.submit(); ">
        <portal-navigation:someLoop>
             <option value="<%= theUrl %>" >Some title goes here      
        </portal-navigation:someLoop>
    </select>
    <noscript>
        <input type="image" border=0 align=absmiddle src='go.gif'/>Go
    </noscript>
   </form>       
The previous code example works both with and without JavaScript enabled.
ssl="yes|no|true|false"

Create a secure URL (HTTPS).

forceAbsolute = "true|false"

Optional. It specifies whether the URL generated by this tag is to be absolute or not. If true, absolute URLs are enforced; in this case other settings that affect the generation of URLs might be overridden.
Example: The following example shows part of a user login form that uses the <portal:url> tag to process input fields, user ID, and password.
    <FORM method="POST"
         action='<portal-navigation:url command="LoginUser"/>'
         enctype="application/x-www-form-urlencoded"
         name="LoginPage">
<portal-navigation:urlGeneration attribute="value">
This tag creates a URL to pages or portlets. The tag is conditional. If the URL cannot be found, the body of the tag is not evaluated. Inside the body of the tag, the <% wpsURL %> scripting variable can be used to write the URL directly to the output stream. For example:
<a class="wpsToolBarLink" href='<% wpsURL.write(out); %>'>My page</a>

Attributes are as follows:
accessControlCheck="permission_constant"

This attribute indicates the permissions to be checked. The following constants can be used:

CreatePage
EditLayout
DeletePage
AssignRoles
NoCheck
EditApplicationProperties
EditApplicationLayout
AssignApplicationMember
ManageApplicationRoles
SaveAsTemplate

If the user does not have the required permission, the body of the tag is not executed. If the user has the necessary permissions, the current page ID is appended to the URL. If the parameter is set to 'NoCheck', the current page ID is appended without checking the access control permissions. This is necessary for the target page or portlet to create a back button.

actionName="name"
Name of an action that would be called by the URL to an IBM portlet. The following example generates a URL that calls the myAction action of the portlet which is contained by my.LayoutNode on my.ContentNode.
<portal-navigation:urlGeneration actionName="myAction" 
                                 contentNode="my.ContentNode" 
                                 layoutNode="my.LayoutNode">

   <a href="<%wpsURL.write(out);%>">Link to portlet with myAction</a>
</portal-navigation:urlGeneration>  
The following code is from the actionPerformed() aspect of the portlet that handles the myAction action.
PortletURI actionURL = portletResponse.createURI();
     actionURL.addAction("myAction");     
allowRelativeURL="true|false"

Whether a fully qualified or relative URL is generated. The default is set by the property com.ibm.portal.state.accessors.url.URLContext.enableRelative in the StateManagerService.

contentNode="id|name"

ID or unique name of the page. The name or ID of the content node is also used to specify the page where the portlet can be found.

keepNavigationalState="true|false"

If false, the current navigational state that includes all portlet modes, states, and render parameters is not included in the URL, and the portal is reset to its default state. If this value is set to true, the navigational state is included. True is the default setting.

layoutNode="id|name|wp.currentSelectedPortlet"

ID or unique name of the control that holds the portlet. It must be used in combination with contentNode to identify the page where the portlet is located. The value wp.currentSelectedPortlet can be used inside a control when you generate a URL to the portlet within that control.

newWindow="true|false"

Create a session partition. For portlet URLs, this should be used to display the portlet either in a new window or in an iFrame. Default is false. The portlet window state for the addressed portlet in the new window is set to maximized. The portlet mode is set to the value of the current parent window. In the control.jsp of skins that use iFrames, the <portal:if/> tag can be used to distinguish between rendering in the main window or in an iFrame or detached window.

portletMode="view|help|edit|edit_defaults|configure"

For URLs to a portlet as specified by the parameter layoutNode, this attribute sets the portlet mode. This parameter is ignored if the parameter layoutNode is not set. Specifying portletMode="edit_defaults" opens the portlet in the Edit defaults mode directly.

portletParameterType="render|action"

This attribute generates URLs to a standard portlet's render or action processing methods. If this attribute is omitted, the render method of the portlet is called. Any parameters added to the body of the tag that uses <portal-navigation:urlParam/> are passed to the corresponding method.

portletWindowState="maximized|minimized|solo|normal"

For a portlet, this attribute indicates the state of the portlet window when it is displayed. If portlet state is not specified, the page is shown with the previous state of the portlet. This parameter is ignored if layoutNode is not set.
Use caution when we use this tag to address portlets in solo state. The portlet must be able to exist in solo state that uses the createReturnURI() method. If a portlet without this method is placed in solo state, then users are forced to log out or close their browser windows to return to the portal.

themeTemplate="template_name"

This specifies the theme template that is taken for rendering the requested page. Can be referenced as either a JSP or a class and is used as theme for this URL.

normalize="true|false"
This attribute indicates the URL to be generated should be normalized. If more parameters are set, the normalization is executed first and afterward the other state modifications are accomplished. Setting the "normalize" parameter to true normalizes the URL with the same XSL file used to normalize URLs for search engines. The normalized representation of the URL can also be used to bookmark a page. The following example shows how to use the tag with this attribute:
<portal-navigation:urlGeneration normalize="true" >
      <a href="<% wpsURL.write(out); %>">
        The normalized URL of the current selected page.
      </a>    </portal-navigation:urlGeneration>
If more parameters are set for the <portal-navigation:urlGeneration> tag the XSL transformation is executed first and all other state modifications is accomplished afterward.
forceAbsolute = "true|false"

Optional. It specifies whether the URL generated by this tag is to be absolute or not. If true, absolute URLs are enforced; in this case other settings that affect the generation of URLs might be overridden.
<portal-navigation:urlParam name="parameter_name" value="parameter_value">

This tag is used to add parameters to the parent URL. Parent tags include <portal-navigation:url/> and <portal-navigation:urlGeneration/>. Parameters added to the <urlGeneration/> tag occur as unscoped query parameters unless the attributes specified on <urlGeneration/> specify otherwise. Parameter handling depends on the target of the URL. If the URL points to a page, the parameters are visible to all IBM portlets on that page. Parameters are not visible to standard portlets if the URL does not point specifically to that portlet.
Attributes are as follows:

name

Required. It indicates the name of the parameter.

value

Required. It indicates the value of the parameter.

type

Optional. It indicates one of the following types:

query

The name-value pair is added to the URL as a query parameter. Default value if type is not specified.

render

The parameter is available as a render parameter for the portlet.

action

The parameter is available as an action parameter for the portlet.
<portal-navigation:url command="ChangeLanguage">
This tag is used to change the active language in the navigational state in which the URL is generated.
The following code example uses this tag to change the language to German.
<a href='<portal-navigation:url command="ChangeLanguage"><portal-navigation:urlParam 
                                   name="locale" 
                                   value="de"/></portal-navigation:url>'>Diese Seite in deutsch </a>
Parent Tags used by the portal theme JSPs