Etiquettes de <portal-skin/>

Les balises <portal-skin/> sont utilisées pour créer une barre de titre de portlet et y ajouter des icônes de fonctions.

Le tableau suivant contient un bref descriptif de chaque balise.

Remarque : N'utilisez pas les balises de portail dans les fichiers JSP des portlets. Les balises ci-après ne doivent être utilisées que dans les fichier JSP des thèmes et habillages.
Tableau 1. Description des balises <portal-skin/>
Balise Description
<portal-skin:layoutNodeLoop/> Génère la mise à jour pour la zone de la page du portail comprenant les portlets. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.
<portal-skin:layoutNodeProperty/> Affiche la valeur d'une propriété d'un noeud de mise en page donné ou expose la valeur de la propriété dans une variable de script.
<portal-skin:layoutNodeRender/> Rend un élément du modèle de mise en page. Cette balise doit uniquement être utilisée dans un fichier <portal-skin:layoutnodeLoop/>.
<portal-skin:portletBack/> Sert à rendre un lien de la barre de titre du portlet permettant à l'utilisateur de définir le portlet avec le mode connu au préalable. Cette balise doit être utilisée dans les fichiers JSP d'habillage uniquement.
<portal-skin:portletConfigure/> Sert à rendre l'icône de la barre de titre du portlet permettant à l'administrateur de configurer le portlet. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.
<portal-skin:portletEdit/> Sert à rendre l'icône de la barre de titre du portlet permettant à l'utilisateur de modifier le portlet. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.
<portal-skin:portletEditDefaults/> Sert à rendre l'icône de la barre de titre du portlet permettant à l'utilisateur de modifier le portlet. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.
<portal-skin:portletHelp/> Sert à rendre l'icône de la barre de titre du portlet permettant d'afficher l'aide du portlet. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.
<portal-skin:portletMaximize/> Sert à rendre l'icône de la barre de titre du portlet permettant à l'utilisateur d'agrandir le portlet. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.
<portal-skin:portletMinimize/> Sert à rendre l'icône de la barre de titre du portlet permettant à l'utilisateur de réduire le portlet. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.
<portal-skin:portletRender/> Rend le contenu du portlet dans la mise en page de la page actuellement générée. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.
<portal-skin:portletRestore/> Sert à rendre l'icône de la barre de titre du portlet permettant à l'utilisateur de restaurer la taille d'origine du portlet. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.
<portal-skin:portletTitle/> Ecrit le titre d'un portlet. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.
<portal-skin:urlParent/> Crée une URL prenant en charge l'une des balises environnantes suivantes.

Description détaillée des balises <portal-skin/>

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

<portal-skin:layoutNodeLoop var="var_name">
Génère la mise à jour pour la zone de la page du portail comprenant les portlets. Les noeuds de mise en page sont utilisés pour disposer les conteneurs (lignes, colonnes) ou les commandes (portlets). La balise itère les enfants d'un noeud de mise en page. Si vous spécifiez l'attribut var, le nœud de mise en page actuellement utilisé peut être mis à disposition dans d'autres balises qui attendent des noms de variables de script. 

<table border="0" width="100%" cellpadding="0" cellspacing="0" align="center">
<tr height="100%">
  <portal-skin:layoutNodeLoop var="node">
  <td valign="top" width=<portal-skin:layoutNodeProperty varname="node" propertyname="WIDTH"/>>
    <portal-skin:layoutNodeRender/>
  </td>
  </portal-skin:layoutNodeLoop>
</tr>
</table>
<portal-skin:layoutNodeProperty/>
Affiche la valeur d'une propriété d'un noeud de mise en page donné ou expose la valeur de la propriété dans une variable de script. Les attributs obligatoires sont les suivants :
  • varname - nom de la variable régissant le nœud de mise en page
  • propertyName - nom de la propriété permettant la récupération (par exemple, "LARGEUR" ou "ORIENTATION")

L'attribut facultatif var peut être utilisé pour exposer la valeur de la propriété dans une variable de script portant le nom donné au lieu de l'écrire directement dans la sortie.

Exemple :

<portal-skin:layoutNodeLoop var="wpsLayoutNode">
  <portal-skin:layoutNodeProperty varname="<%=wpsLayoutNode%>" propertyname="WIDTH"/>
       <!-- write the width property !-->
  <portal-skin:layoutNodeProperty varname="<%=wpsLayoutNode%>" propertyname="WIDTH" var="width" />
       <!-- expose width variable !-->
    ... <img width="<%=width>" src="test.gif"> ...
  </portal-skin:layoutNodeProperty>
</portal-skin:layoutNodeLoop>
<portal-skin:layoutNodeRender>
Rend un élément du modèle de mise en page. Il peut s'agir d'un conteneur représentant une ligne, une colonne ou une commande. Cette balise peut uniquement être utilisée au sein d'une balise <portal-skin:layoutNodeLoop>.
<portal-skin:portletBack/>
Sert à rendre un lien de la barre de titre du portlet permettant à l'utilisateur de définir le portlet avec le mode connu au préalable. Le contenu de cette balise doit comprendre un lien (de valeur HREF <%=wpsPortletBackURL%>) et l'image d'une icône ou un texte de lien. Les paramètres d'affichage en cours des portlets standard sont conservés. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage. 

    <portal-skin:portletBack>
       <td class="wpsPortletTitle">
          <a href='<%=wpsPortletBackURL%>'>
             <img border="0" align="absmiddle" width="12" height="12"
                  src="<portal-logic:urlFindInTheme file='<%= "title_back" + 
                      bidiImageRTL + ".gif" %>'/>"
                  alt='<portal-logic:text key="back" bundle="nls.titlebar"/>'
                  title='<portal-fmt:text key="back" bundle="nls.titlebar"/>'></a></td>
    </portal-skin:portletBack>

L'attribut allowRelativeURL indique si une URL absolue ou relative est générée. Voir Création de liens personnalisés vers les portlets et les pages pour plus d'informations.

<portal-skin:portletConfigure/>
Sert à rendre l'icône de la barre de titre du portlet permettant à l'administrateur de configurer le portlet. Le contenu de cette balise doit comprendre un lien (de valeur HREF <%=wpsPortletConfigureURL%>) et l'image d'une icône. L'attribut newWindow n'est pas pris en charge pour ce mode. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.

L'attribut allowRelativeURL indique si une URL absolue ou relative est générée. Voir Création de liens personnalisés vers les portlets et les pages pour plus d'informations.

L'attribut newWindow doit être défini si le mode Config des portlets doit s'afficher dans une fenêtre popup.

<portal-skin:portletEdit/>
Sert à rendre l'icône de la barre de titre du portlet permettant à l'utilisateur de modifier le portlet. Le contenu de cette balise comprend un lien (rendu sous la forme <%=wpsPortletEditURL%> ou <portal-skin:urlParent>) et l'image d'une icône. L'attribut newWindow n'est pas pris en charge pour ce mode. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.

L'attribut allowRelativeURL indique si une URL absolue ou relative est générée. Voir Création de liens personnalisés vers les portlets et les pages pour plus d'informations.

L'attribut newWindow doit être défini si le mode Config des portlets doit s'afficher dans une fenêtre popup.

<portal-skin:portletEditDefaults/>
Utilisée pour rendre l'icône de la barre de titre du portlet permettant à l'utilisateur de modifier les paramètres par défaut du portlet. Le contenu de cette balise comprend un lien (rendu sous la forme <%=wpsPortletEditDefaultsURL%> ou <portal-skin:urlParent>) et l'image d'une icône. L'attribut newWindow n'est pas pris en charge pour ce mode. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.

L'attribut allowRelativeURL indique si une URL absolue ou relative est générée. Voir Création de liens personnalisés vers les portlets et les pages pour plus d'informations.

L'attribut newWindow doit être défini si le mode Config des portlets doit s'afficher dans une fenêtre popup.

<portal-skin:portletHelp/>
Sert à rendre l'icône de la barre de titre du portlet permettant d'afficher l'aide du portlet. Le contenu de cette balise comprend un lien (rendu sous la forme <%=wpsPortletHelpURL%> ou <portal-skin:urlParent>) et l'image d'une icône. L'attribut newWindow indique que, pour le langage HTML, l'aide du portlet doit être affichée dans une nouvelle fenêtre du navigateur. La valeur par défaut est "no" ou "false". Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.

L'attribut allowRelativeURL indique si une URL absolue ou relative est générée. Voir Création de liens personnalisés vers les portlets et les pages pour plus d'informations.

L'attribut newWindow doit être défini si le mode Config des portlets doit s'afficher dans une fenêtre popup.

<portal-skin:portletMaximize>
Sert à rendre l'icône de la barre de titre du portlet permettant à l'utilisateur d'agrandir le portlet. Avant d'afficher le bouton d'agrandissement, la balise vérifie si le portlet prend en charge l'état d'agrandissement ou si le portlet est déjà dans cet état. Le contenu de cette balise comprend un lien (rendu sous la forme <%=wpsPortletMaximizeURL%> ou <portal-skin:urlParent>) et l'image d'une icône. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.

L'attribut allowRelativeURL indique si une URL absolue ou relative est générée. Voir Création de liens personnalisés vers les portlets et les pages pour plus d'informations.

<portal-skin:portletMinimize>
Sert à rendre l'icône de la barre de titre du portlet permettant à l'utilisateur de réduire le portlet. Avant d'afficher le bouton de réduction, la balise vérifie si le portlet prend en charge l'état de réduction ou si le portlet est déjà dans cet état. Le contenu de cette balise comprend un lien (rendu sous la forme <%=wpsPortletMinimizeURL%> ou <portal-skin:urlParent">) et l'image d'une icône. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.

L'attribut allowRelativeURL indique si une URL absolue ou relative est générée. Voir Création de liens personnalisés vers les portlets et les pages pour plus d'informations.

<portal-skin:portletRender>
Rend le contenu du portlet dans la mise en page de la page actuellement générée. Cette balise peut uniquement être utilisée au sein de la balise control dans les fichiers JSP d'habillage.

Si un portlet n'est ni actif, ni désactivé, le corps de la balise est exécuté et un message correspondant peut s'afficher avec la balise <portal-fmt:problem/>, ou une autre gestion de l'erreur peut être implémentée. Le corps de la balise peut contenir davantage de code JSP.

Reportez-vous à la balise <portal-fmt:problem> ou <portal-logic:if portletstate> pour obtenir un exemple d'utilisation de cette balise dans Control.jsp .

<portal-skin:portletRestore>
Utilisée dans la balise control pour afficher dans la barre de titre du portlet l'icône permettant à l'utilisateur de restaurer l'état initial du portlet. Le contenu de cette balise comprend un lien (rendu sous la forme <%=wpsPortletRestoreURL%> ou <portal-skin:urlParent>) et l'image d'une icône.

L'attribut allowRelativeURL indique si une URL absolue ou relative est générée. Voir Création de liens personnalisés vers les portlets et les pages pour plus d'informations.

<portal-skin:portletTitle id="identifier">
Ecrit le titre d'un portlet. Si le portlet n'est pas disponible ou est désactivé, un titre spécial est inscrit, indiquant que le titre initial n'est pas disponible. Le contenu de la balise est évalué uniquement si des problèmes surviennent au cours du traitement et peut être utilisé pour le traitement des erreurs. Lorsque l'id est spécifié, la balise lance une variable de script portant la valeur normalement écrite et rien n'est inscrit sur le flux de sortie. La valeur de l'attribut id est le nom de la variable de script. Cette balise doit uniquement être utilisée dans les fichiers JSP d'habillage.

Pour les portlets standard, seuls les titres statiques sont affichés. Les titres définis de manière dynamique à l'aide de la méthode RenderResponse.setTitle() sont ignorés.

Dans cet exemple, le titre est affiché dans une cellule de tableau. L'alignement est déterminé par la variable <%= bidiAlignLeft %>, laquelle est définie dans le fichier BidiInclude.jsp.


    
    <td class="wpsPortletTitle" width="100%" nowrap align="<%= bidiAlignLeft %>" 
              valign="middle">
        <portal-skin:portletTitle>
           <portal-fmt:problem bundle="nls.problem"/>
        </portal-skin:portletTitle> 
           <img alt="" border="0" width="1" height="12"
            src='<portal-logic:urlFindInTheme file="title_minheight.gif"/>'>
    </td>
<portal-skin:urlParent allowRelativeURL="true|false" />
Cette balise crée une URL prenant en charge l'une des balises environnantes suivantes. Pour améliorer ses performances, utilisez la variable de script parente si elle est disponible.

L'attribut allowRelativeURL indique si une URL absolue 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.