<portal-navigation/> tags

Les balises <portal-navigation/> sont utilisées pour implémenter des tâches de navigation telles que la génération d'URL et l'exploration du modèle de navigation du portail.

La section suivante contient des descriptions détaillées des balises JSP <portal-navigation/>.

<portal-navigation:uiNavigationModel var="uiNavigationModel" mobileDeviceClassTest="device class equation" showHidden="true|false" selectedNodeID="page ID" selectionPath="page IDs" selectionPathSeparator="selectionPath delimiter">

La balise uiNavigationModel permet au développeur JSP de se concentrer sur la construction de la navigation plutôt que sur les détails d'implémentation spécifiques au portail.

Par défaut, la balise uiNavigationModel répertorie les pages visibles dans le cadre de son itérateur. Lorsque l'option Afficher les pages masquées est sélectionnée dans la barre d'outils, elle répertorie également les pages masquées. Il existe un indicateur de masquage mobile spécial pour les pages. Le modèle vous permet également de spécifier une expression de classe d'appareil de test mobile, qui est utilisée pour déterminer si le système est affiché dans le cadre d'une demande mobile.

La balise uiNavigationModel rend le bean ELuiNavigationModel disponible sous forme d'une variable pouvant être spécifiée avec l'attribut var.

Exemple :

<portal-navigation:uiNavigationModel var="uiNavigationModel" mobileDeviceClassTest="smartphone/tablet" >
    <%-- loop through all children of the page at the given curLevel --%>
    <c:forEach var="node" items="${uiNavigationModel.children[selectionPath[curLevel]]}">

        <%-- print out the page and highlight it if it is in the selection path 
             (the current page or an ancestor of the current page) --%>
        <li class="wpthemeNavListItem wpthemeLeft<c:if test="${node.isInSelectionPath}"> wpthemeSelected</c:if>">

            <%-- output a link to the page --%>
            <a href="${fn:escapeXml(node.urlGeneration)}" class="wpthemeLeft ${node.isHidden ? 
                 'wpthemeHiddenPageText' : ''} ${node.isDraft? 'wpthemeDraftPageText' : ''}">

                <%-- start page title markup --%>
                <span lang="${node.title.xmlLocale}" dir="${node.title.direction}"><%--
                    
                    <!-- print out the page title -->
                    --%><c:out value="${node.title}"/><%--
                    
                    <!-- mark the page if it is currently selected for accessibility -->
                    --%><c:if test="${node.isSelected}"><span class="wpthemeAccess">
                    <portal-fmt:text key="currently_selected" bundle="nls.commonTheme"/></span></c:if><%--

                --%></span><%-- end page title markup --%>
            </a>
        </li>
    </c:forEach>
</portal-navigation:uiNavigationModel>

Paramètres obligatoires :

var: Cet attribut obligatoire indique le nom d'une variable de scriptage qui est exposée dans le corps de la balise. Cette variable est un bean EL uiNavigationModel EL Bean.
mobileDeviceClassTest: Cet attribut est une équation de clase d'appareil, qui indique si la demande fait partie d'un appareil mobile ou non.

Les paramètres suivants sont tous facultatifs. S'ils ne sont pas fournis, les informations sont automatiquement extraites de la demande. Dans certains cas, les informations de sélection ne sont pas disponibles et doivent être transmises de manière explicite. Dans ce cas, utilisez les attributs suivants :

showHidden: Indique si les pages masquées doivent être affichées ou non.
selectedNodeID: Chaîne. Indique l'ID de page sélectionné.
selectionPath: Chaîne. Liste d'ID de page qui définit le chemin de sélection ou élément de navigation dans une chaîne. Le délimiteur peut être configuré via selectionPathSeparator.
selectionPathSeparator: Chaîne. Délimiteur utilisé pour faire une analyse syntaxique de selectionPath.

Renvoie : Chaque nœud de navigation renvoyé par la balise uiNavigationModel est également un encapsuleur autour du bean EL NavigationNode et fournit des informations supplémentaires, telles que isHidden, isDraft, isInSelectionPath et isSelected. Pour plus d'informations, voir uiNavigationModel

<portal-navigation:url command="ChangeLanguage">

Cette balise est utilisée pour modifier la langue active dans l'état de navigation dans lequel l'URL est générée.

L'exemple de code suivant utilise cette balise pour définir la langue sur allemand.

<a href='<portal-navigation:url 
         command="ChangeLanguage"><portal-navigation:urlParam name="locale" 
         value="de"/></portal-navigation:url>'>Diese Seite in deutsch
</a>

<portal-navigation:urlParam name="parameter_name" value="parameter_value">

Cette balise permet d'ajouter des paramètres à l'URL parente. Les balises parent sont notamment <portal-navigation:url/> et <portal-navigation:urlGeneration/>. Les paramètres ajoutés à la balise <urlGeneration/> apparaissent sous forme de paramètres de requête indéfinis, sauf si les attributs spécifiés dans <urlGeneration/> les définissent. La gestion des paramètres dépend du contenu de la cible de l'URL. Si l'URL est pointée sur une page, les paramètres sont visibles pour tous les portlets HCL de cette page. Les paramètres ne sont pas visibles pour les portlets standard si l'URL ne pointe pas spécifiquement sur de portlet.

Les attributs sont les suivants :

nom

Cet attribut est obligatoire. Indique le nom du paramètre.

valeur

Cet attribut est obligatoire. Indique la valeur du paramètre.

type

Cet attribut est facultatif. Il indique l'un des types suivants :

query: La paire nom-valeur est ajoutée à l'URL en tant que paramètre de requête. Il s'agit de la valeur par défaut si le type n'est pas spécifié.
rendre: Le paramètre est disponible sous forme de paramètre de rendu pour le portlet.
action: Le paramètre est disponible sous forme de paramètre d'action pour le portlet.

<portal-navigation:urlGeneration attribute="value">

Cette balise crée une URL vers des pages ou des portlets. Cette balise est conditionnelle. Si l'URL est introuvable, le corps de la balise n'est pas évalué. Dans le corps de la balise, la variable de script <% wpsURL %> peut être utilisée pour écrire l'URL directement dans le flux de sortie. Par exemple:

<a class="wpsToolBarLink" href='<% wpsURL.write(out); %>'>My page</a>

Les attributs sont les suivants :

home="public|protected"

Cet attribut crée une URL pointant vers la page publique ou protégée (connectée) du portail.

accessControlCheck="permission_constant"

Cet attribut indique les droits à vérifier. Les constantes suivantes peuvent être utilisées :

CreatePage
EditLayout
DeletePage
AssignRoles
NoCheck
EditApplicationProperties
EditApplicationLayout
AssignApplicationMember
ManageApplicationRoles
SaveAsTemplate

Si l'utilisateur ne dispose pas des droits requis, le corps de la balise n'est pas exécuté. Si l'utilisateur dispose des droits requis, l'ID de la page courante est annexé à l'URL. Si le paramètre a pour valeur 'NoCheck', l'ID de page en cours est ajouté sans vérification des droits de contrôle d'accès. Cette option est nécessaire pour que la page ou le portlet cible crée un bouton de retour.

actionName="name"

Cet attribut indique le nom d'une action qui serait appelée par l'URL vers un portlet IBM. L'exemple suivant génère une URL qui appelle l'action myAction du portlet, laquelle se trouve dans my.LayoutNode sur 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>

Le code suivant provient de l'aspect actionPerformed() du portlet qui traite l'action myAction.

     PortletURI actionURL = portletResponse.createURI();
     actionURL.addAction("myAction");

allowRelativeURL="true|false"

Cet attribut indique si une URL complète ou relative est générée. La valeur par défaut est définie par la propriété com.ibm.portal.state.accessors.url.URLContext.enableRelative dans StateManagerService.

contentNode="id|name"

Cet attribut indique l'ID ou le nom unique de la page. Le nom ou l'ID du noeud de contenu est également utilisé pour spécifier la page dans laquelle se trouve le portlet.

keepNavigationalState="true|false|auto"

Si vous affectez la valeur false à cet attribut, l'état de navigation en cours, à savoir tous les modes et tous les états de portlet et tous les paramètres de rendu, n'est pas inclus dans l'URL et l'état par défaut du portail est restauré. Si cet attribut a pour valeur true, l'état de navigation est inclus. True est le paramètre par défaut. Si cet attribut a pour valeur auto, la configuration détermine si l'état de navigation est inclus. Voir les descriptions pour stateless.urls.enabled et generate.stateless.urls dans le document Configuration Service.

layoutNode="id|name|wp.currentSelectedPortlet"

Cet attribut indique l'ID ou le nom unique de la commande régissant le portlet. Il doit être utilisé en combinaison avec contentNode pour identifier la page dans laquelle se trouve le portlet. La valeur wp.currentSelectedPortlet peut être utilisée dans une balise control lorsque vous générez une URL vers le portlet dans cette commande.

newWindow="true|false"

Cet attribut crée une partition de session. Pour les URL de portlet, vous pouvez utiliser cet attribut pour afficher le portlet dans une nouvelle fenêtre ou dans une fenêtre iFrame. La valeur par défaut est false. L'état de la fenêtre du portlet concerné dans la nouvelle fenêtre est défini sur agrandi. Le mode du portlet est défini sur la valeur de la fenêtre parente actuelle. Dans le fichier control.jsp des habillages utilisant des fenêtres iFrames, la balise <portal:if/> peut permettre de distinguer le rendu dans la fenêtre principale du rendu dans une fenêtre iFrame ou une fenêtre distincte.

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

Pour les URL vers un portlet indiqué par layoutNode, cet attribut définit le mode du portlet. Ce paramètre est ignoré si le paramètre layoutNode n'est pas défini. La spécification de portletMode="edit_defaults" ouvre le portlet en mode Edition des valeurs par défaut directement.

portletParameterType="render|action"

Cet attribut génère des URL vers les méthodes de traitement de rendu ou d'action d'un portlet standard. Si cet attribut est omis, la méthode de rendu du portlet est appelée. Tous les paramètres ajoutés au corps de la balise qui utilise <portal-navigation:urlParam/> sont transmis à la méthode correspondante.

portletWindowState="maximized|minimized|solo|normal"

Pour un portlet, cet attribut indique l'état de la fenêtre du portlet lorsqu'elle apparaît. Si l'état du portlet n'est pas spécifié, la page est affichée avec l'état précédent du portlet. Ce paramètre est ignoré si le paramètre layoutNode n'est pas défini.

Remarque : Utilisez cette balise avec prudence pour vous adresser aux portlets à l'état basique. Le portlet doit pouvoir se trouver à l'état basique qui utilise la méthode createReturnURI(). Si un portlet ne comprenant pas cette méthode est placé à l'état basique, les utilisateurs sont obligés de se déconnecter ou de fermer la fenêtre de leur navigateur pour retourner au portail.

themeTemplate="template_name"

Indique le modèle de thème pris en compte pour afficher la page demandée. Peut être désigné comme JSP ou classe et utilisé comme thème pour cette URL.

normalize="true|false"

Cet attribut indique que l'URL à générer doit être normalisée. Si des paramètres supplémentaires sont définis, la normalisation est exécutée en premier et les autres modifications d'état sont ensuite effectuées. La définition du paramètre "normalize" sur true permet de normaliser l'URL avec le même fichier XSL que celui utilisé pour normaliser les URL des moteurs de recherche. La représentation normalisée de l'URL peut également être utilisée pour ajouter un signet à une page. L'exemple suivant montre comment utiliser la balise avec cet attribut :

<portal-navigation:urlGeneration normalize="true" >
      <a href="<% wpsURL.write(out); %>">
        This is the normalized URL of the current 
        selected page.
      </a>    
</portal-navigation:urlGeneration>

Si des paramètres complémentaires sont définis pour la balise <portal-navigation:urlGeneration>, la transformation XSL est exécutée la première et toutes les autres modifications d'état sont effectuées ensuite.

forceAbsolute = "true|false"

Cet attribut est facultatif. Il indique si l'URL générée par cette balise doit être absolue ou non. Si vous définissez cet attribut sur true, des URL absolues sont appliquées ; dans ce cas, d'autres paramètres qui affectent la génération des URL peuvent être écrasés.

<portal-navigation:url>

Crée une URL de portail selon l'attribut spécifié. Les attributs sont les suivants :

home="public|protected"

Cet attribut crée une URL pointée vers la page publique ou protégée (connectée) du portail.

screen="screen_name"

Cet attribut crée une URL pointée vers le nom de l'écran à afficher.

command="LoginUser|LogoutUser|ShowTools"

Cet attribut crée une URL émettant la commande vers le portail. command="LoginUser" est utilisé pour le panneau de connexion et command="LogoutUser" est utilisé pour le bouton de déconnexion. Les paramètres "userid" et "password" doivent être pris en compte par l'URL de connexion. command="ShowTools" fait basculer la valeur de l'indicateur showTools. Pour obtenir un exemple, voir l'attribut "showtools" de balise <portal-logic:if/>.

commandParam="parameter_name"

Cet attribut dirige le moteur du portail afin qu'il obtienne la commande réelle d'exécution auprès d'un paramètre de requête HTTP au lieu de l'obtenir directement par l'URL. Le nom du paramètre est la valeur de l'attribut commandParam. Cela peut être utile dans les situations où différentes commandes doivent être exécutées de manière conditionnelle et où une seule URL peut être spécifiée. C'est notamment le cas lorsque vous utilisez une balise <form> avec une balise <select>. Cela permet d'utiliser le formulaire HTML sans recourir à JavaScript. Par exemple:

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

L'exemple de code précédent fonctionne, que le JavaScript soit activé ou désactivé.

ssl="yes|no|true|false"

Cet attribut crée une URL sécurisée (HTTPS).

forceAbsolute = "true|false"

Cet attribut est facultatif. Il indique si l'URL générée par cette balise doit être absolue ou non. Si vous définissez cet attribut sur true, des URL absolues sont appliquées ; dans ce cas, d'autres paramètres qui affectent la génération des URL peuvent être écrasés.

Exemple : L'exemple suivant présente une partie du formulaire de connexion qui utilise la balise <portal:url> pour traiter les zones d'entrée, l'ID utilisateur et le mot de passe.

    <FORM method="POST"
         action='<portal-navigation:url command="LoginUser"/>'
         enctype="application/x-www-form-urlencoded"
         name="LoginPage">

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

Crée des URL pour les noeuds de navigation. Cette balise est utilisée dans le corps de la balise <portal-navigation:navigationLoop> et produit des liens pour le nœud de navigation courant en fonction de l'attribut type.

Les attributs sont les suivants :

type

Utilisez l'une des valeurs suivantes :

type="link": Cet attribut crée l'URL permettant de modifier le noeud sélectionné.
type="expand": Cet attribut crée une URL permettant de développer le noeud pour faire apparaître ses noeuds enfants. Cette balise est destinée à développer l'arborescence de navigation.
type="collapse": Cet attribut crée une URL permettant de réduire le noeud afin de masquer les noeuds enfants. Cette balise est destinée à réduire l'arborescence de navigation.
type="launch": Cet attribut crée une URL permettant de démarrer une page si toutes les conditions de lancement sont réunies pour le noeud de navigation ou si elle est similaire à l'URL définie par type="link".

Remarque : Par défaut, l'état global des arborescences de navigation du portail est réduit (à quelques exceptions près, comme la navigation dans l'administration de portail). Vous pouvez configurer l'état par défaut des arborescences de navigation du portail de telle façon que tous les noeuds soient développés en affectant à la propriété de service de configuration de portail navigation.expansion.defaultstate la valeur true.

varname

Cet attribut spécifie un objet de type com.ibm.portal.navigation.NavigationNode pour lequel une URL doit être générée. L'attribut est facultatif.

var

Cet attribut spécifie le nom d'une variable de script qui est affichée dans le corps de la balise. L'attribut est facultatif. La variable affiche un objet qui implémente une URL com.ibm.portal.DisposableURL pouvant être utilisée pour envoyer l'URL vers la sortie. Si le noeud de contenu auquel le noeud de navigation fait référence est une URL interne, le corps est évalué uniquement si la cible de l'URL interne est accessible.

forceAbsolute = "true|false"

keepNavigationalState="true|false|auto"

Si cet attribut est défini sur false, l'état de navigation courant (y compris l'ensemble des modes, états et paramètres d'affichage des portlets) n'est pas inclus dans l'URL et le portail est réinitialisé à son état par défaut. Si elle est définie sur true, qui est la valeur par défaut, l'état de navigation est inclus. Si cet attribut a pour valeur auto, la configuration détermine si l'état de navigation est inclus. Voir les descriptions pour stateless.urls.enabled et generate.stateless.urlsdans le document Configuration Service.

Pour générer le titre ou la description d'un noeud de navigation, utilisez les balises <portal-fmt:title/> ou <portal-fmt:description/>. Cette balise est utilisée dans les fichiers JSP de thème.

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

Cette balise est utilisée dans la navigation pour créer une URL permettant de faire défiler le contenu jusqu'à l'ensemble suivant de liens de page lorsque le nombre de pages disponibles dépasse maxPages. L'attribut by indique le nombre de liens de page à faire défiler. Si cette balise n'est pas utilisée, tous les liens de page relatifs au niveau actuel sont affichés.

Cette balise est imbriquée dans la balise <portal-navigation:navigation> et requiert des valeurs pour les attributs startLevel et stopLevel de la balise <portal-navigation:navigation> pour fonctionner correctement.

<portal-navigation:navigationLoop>

Cette balise traverse le modèle de navigation. Cette balise est imbriquée dans la balise <portal-navigation:navigation/> lors de son utilisation. Cette balise indique la partie du balisage qui sera répétée une fois pour chaque noeud de navigation. Cette balise ne possède pas d'attribut. Le corps de cette balise est exécuté pour chaque noeud de navigation. Cette balise rend disponibles plusieurs variables de script permettant d'obtenir des informations relatives à la navigation. Ces variables de script sont uniquement accessibles au sein du corps de la balise.

<portal-navigation:navigation>

Cette balise initialise un ensemble d'objets et les rend disponibles par le biais de variables de script. Ces objets sont nécessaires pour le processus de rendu de la navigation. Les variables de script sont uniquement accessibles au sein du corps de la balise. Les paramètres des attributs startLevel et stopLevel déterminent si le contenu de la balise de navigation est évalué ou non. La balise de navigation utilise une branche transversale "en ordre" de l'arborescence de navigation pour sélectionner les noeuds.

Les attributs sont les suivants :

startLevel

Facultatif. Niveau auquel cette navigation doit commencer à afficher des informations. Si aucun niveau de début n'est indiqué, cette balise débute au noeud de navigation suivant les niveaux affichés par les autres fichiers JSP. Dans les autres cas, le niveau par défaut est 1.

stopLevel

Facultatif. Niveau auquel cette navigation doit cesser d'afficher des informations. Par défaut, tous les niveaux sont affichés.

computeNumLevelsToDisplay

Facultatif. Calcul du nombre de niveaux qui apparaissent réellement dans cette navigation. Lorsque cet attribut est défini sur true, une variable de script est rendue disponible à l'intérieur du corps de la balise de navigation nommée wpsNumLevelsToDisplay de type java.lang.Integer.

scopeUniqueName

Indique où commencer le rendu de la navigation du portail. La valeur prévue est un nom unique ou une représentation sous forme de chaîne de l'ID objet du noeud de navigation. Ce paramètre remplace également la balise <portal:favoritesLoop/> pour l'activation de la fonctionnalité Organisation des favoris. L'exemple de code suivant montre comment utiliser <portal-navigation:navigation> avec l'attribut scopeUniqueName pour activer la fonctionnalité Organisation des favoris :

<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:favoritesLoop/>

Cette balise est obsolète et doit être remplacée par la balise <portal-navigation:navigation/> avec son attribut scopeUniqueName.

L'exemple de code suivant utilise cette balise pour créer la fonctionnalité Organiser les favoris. Pour pouvoir utiliser ce code, vous devez le placer dans les thèmes pour lesquels vous voulez que cette fonctionnalité soit disponible.

<%@ 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"> 
	 action='<portal-navigation:url commandParam="favoritesCommand"/>'>	<select name="favoritesCommand" onchange="document.location.href=  
		this.options[this.selectedIndex].value">"javascript: if 
  (this.options[this.selectedIndex].value.charAt(0) == '@')
 { 			window.open(this.options[this.selectedIndex].value.substring(1),
  '_blank'); this.selectedIndex=0; return false;} 
 else {	this.form.submit(); return false; }">
			<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++) {%>&nbsp;&nbsp;&nbsp;&lt;% } %><%= wpsFavoritesTitle %>
					<%
					}
					}
					else
					{
					%>
					<option value="#" ><% for (int favSpace=1; 
					favSpace < wpsFavoritesLevel.intValue();
					favSpace++) {%>&nbsp;&nbsp;&nbsp;&lt;% } %>--<%= wpsFavoritesTitle %>--
					<%
					}
					%>
					</portal:favoritesLoop>
				</select>
				<noscript>
				<input type="image" border="0" align="absmiddle"
				src='<portal-logic:urlFindInTheme file="go.gif"/>'/>
				<span class="wpsPlaceBarLink" >&nbsp;&lt;portal-fmt:text key="go"
				bundle="nls.button"/></span>
				</noscript>
				</form>
				</td>
			</tr>
		</table>
		</td>
	</tr>
</table>
</portal-logic:if>