Etiquettes de <portal-fmt/>

Les balises <portal-fmt/> sont utilisées pour fournir des fonctionnalités de formatage étendues.

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-fmt/>
Balise	Description
<portal-fmt:answer/>	Retourne le texte de réponse pour une clé dans la langue spécifiée. Cette balise peut être utilisée uniquement dans une balise <portal-skin:portletRender/> ou <portal-core:pageRender/>.
<portal-fmt:bidi/>	Cette balise est utilisée pour prendre en charge l'affichage de langues bidirectionnelles.
<portal-fmt:description/>	Fournit la description d'un objet qui implémente l'interface `Localized`. Cette balise peut être utilisée dans les fichiers JSP des thèmes et des habillages.
<portal-fmt:identification/>	Transforme une représentation sous forme de chaîne de l'ID objet en ID objet, et vice versa.
<portal-fmt:problem/>	Retourne le texte du problème pour une clé dans la langue spécifiée. Cette balise peut être utilisée uniquement dans une balise `<portal-skin:portletRender/>` ou `<portal-core:pageRender/>`.
<portal-fmt:text/>	Retourne le texte pour une clé dans la langue spécifiée. Pour plus d'informations sur la définition du regroupement approprié, reportez-vous à la balise `portletExt:setBundle` dans la rubrique Balises JSP pour portlets standard.
<portal-fmt:textParam/>	Si le texte récupéré contient des marques de réservation sous la forme "{0}", "{1}", "{2}", il peut être défini avec cette balise. Cette balise peut être utilisée uniquement dans le corps de la balise `<portal-fmt:text/>`.
<portal-fmt:title/>	Fournit le titre d'un objet qui implémente l'interface. Cette balise peut être utilisée dans les fichiers JSP des thèmes et des habillages.
<portal-fmt:user/>	Si l'utilisateur est connecté, cette balise renvoie l'une des valeurs attribute spécifiées.

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

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

<portal-fmt:answer bundle="bundle">

Retourne le texte de réponse pour une clé dans la langue spécifiée. Les clés suivantes peuvent faire l'objet d'une recherche dans l'ensemble des ressources.

content.not.available.answer
login.invalid.answer
password.invalid.answer
userid.invalid.answer
portlet.not.active.answer
portlet.not.authorized.answer
portlet.not.available.answer
portlet.title.not.available.answer

Chaque clé correspond à la clé d'un problème (sans le suffixe .answer). Pour une description complète de chaque problème et un exemple, reportez-vous à la balise <portal-fmt:problem>.

<portal-fmt:bidi dir="rtl|ltr" attribute="portlet" locale="locale">

Cette balise est utilisée pour la prise en charge des langues bidirectionnelles. Les langues bidirectionnelles contiennent du texte qui se lit dans les deux sens. Par exemple, des URL, des exemples de code, ou des noms de répertoire et de fichier peuvent être lus dans le sens opposé à celui du reste du texte.

Attributs :

dir
Indique la direction normale du texte dans la langue. Cet attribut est obligatoire.
- Pour dir="rtl", le contenu de la balise n'est écrit que si l'environnement local du client appartient à une langue bidirectionnelle. Il s'agit de la valeur par défaut si dir n'est pas spécifié.
- Pour dir="ltr", le contenu de la balise n'est écrit que si l'environnement local du client n'appartient pas à une langue bidirectionnelle.
attribute="portlet"
Indique que le texte est destiné au titre d'un portlet. Cet attribut est facultatif.
locale
Le contenu de la balise est rédigé uniquement si la langue appartient aux langues bidirectionnelles définies dans par le portail. Si l'attribut est spécifié, l'environnement local est ignoré.

HCL Portal Les fichiers JSP utilisent cette balise dans un fichier BidiInclude.jsp qui crée les variables de script suivantes, lesquelles sont souvent plus faciles à utiliser que la balise <portal-fmt:bidi/>.

<%=bidiAlignRight%>: Est résolue comme la valeur left pour les langues bidirectionnelles, right pour toutes les autres. Elle est principalement destinée à l'alignement du texte, par exemple dans la cellule d'un tableau.
<%=bidiAlignLeft%>: Est résolue comme la valeur right pour les langues bidirectionnelles, left pour toutes les autres. Elle est principalement destinée à l'alignement du texte, par exemple dans la cellule d'un tableau.
<%=bidiImageRight%>: Est résolue comme la valeur Left pour les langues bidirectionnelles, Right pour toutes les autres. Elle est principalement destinée à annexer la valeur au nom du fichier pour une image. Par exemple, le répertoire des thèmes fournit deux fichiers d'image pouvant être utilisés dans la fenêtre d'un portlet, Album_Border_TopLeft.gif et Album_Border_TopRight.gif.
<%=bidiImageLeft%>: Est résolue comme la valeur Right pour les langues bidirectionnelles, Left pour toutes les autres. Elle est principalement destinée à annexer la valeur au nom du fichier pour une image. par exemple, le répertoire des thèmes fournit deux fichiers d'image pouvant être utilisés dans la fenêtre d'un portlet, Album_Border_TopLeft.gif et Album_Border_TopRight.gif.
<%=bidiImageRTL%>: est résolue comme la valeur _rtl pour les langues bidirectionnelles, nulle pour toutes les autres langues. Elle est principalement destinée aux images graphiques. Par exemple, les aperçus des habillages fournissent deux fichiers d'images permettant de prévisualiser l'habillage, preview.gif et preview_rtl.gif.

L'exemple suivant présente l'appel d'une image directionnelle. La variable de script <%=bidiImageRTL%> est utilisée pour appeler l'icône appropriée, par exemple tab_next_rtl.gif, lorsque l'emplacement appartient à une langue bidirectionnelle.



       <img alt="<portal-fmt:text key="link.next" bundle="nls.engine"/>" 
            src="<portal-logic:urlFindInTheme file='<%="tab_next"+bidiImageRTL+".gif"%>'/>" 
            border="0" align="absmiddle">

<portal-fmt:description locale="locale" varname="scripting_variable" />

Fournit la description de l'objet défini par varname ou du noeud de navigation défini dans la balise <portal-navigation:navigationLoop/>. Cette balise peut être utilisée dans les fichiers JSP des thèmes et des habillages.

Attributs

locale: Facultatif. Remplace le paramètre de langue actuel.
varname: Facultatif. Spécifie le nom de la variable de script contenant l'objet. La balise <portal:navigation/> définit cet objet comme <%=wpsNavNode%>.


<portal-navigation:navigationLoop>
  <!-- write the description of the node in the current locale -->
    <portal-fmt:description varname="<%=wpsNavNode%>"/>
  <!-- write the description of the node in chinese -->
    <portal-fmt:description varname="<%=wpsNavNode%>" locale="zh"/>
</portal-navigation:navigationLoop>

<portal-fmt:identification action="setting" object="object_name" var="variable_name"/>

Transforme une représentation sous forme de chaîne de l'ID objet en ID objet, et vice versa.

Attributs :

action: Indique l'opération à effectuer sur l'objet. Les valeurs permises sont "serialize" et "deserialize".
object: Indique l'objet à manipuler. Les valeurs autorisées sont un objet de type com.ibm.portal.Identifiable ou java.lang.String.
var: Indique le nom de la variable de script dans laquelle la valeur générée est stockée.

L'exemple suivant montre comment cette balise est utilisée pour définir un objet identifiable et le traduire en représentation sous forme de chaîne :

<portal-fmt:identification object="<%=contentNode%>" action="serialize" var="oid_string">
	<p><portal-fmt:title varname="<%=contentNode%>"/> has the ObjectID <%=oid_string%></p>
</portal-fmt:identification>

L'exemple suivant montre comment cette balise est utilisée pour définir un nom unique, qui peut également être une représentation sous forme de chaîne d'un ID objet, et le traduire en ID objet :

<portal-fmt:identification object="ibm.portal.Home" action="deserialize" var="oid">
	<% if (oid instanceof com.ibm.portal.ObjectID) { %>
		<p>This is how it works</p>
	<% } %>
</portal-fmt:identification>

<portal-fmt:problem bundle="bundle">

Retourne le texte du problème pour une clé donnée dans la langue spécifiée. Les clés suivantes peuvent faire l'objet d'une recherche dans l'ensemble des ressources.

content.not.available - Apparaît si aucun contenu de page ne peut être affiché. Utilisé dans la balise <portal-core:pageRender/>.
login.invalid - Apparaît lorsque l'ID utilisateur, le mot de passe ou les deux sont erronés. Utilisé dans l'écran de connexion.
password.invalid - Apparaît lorsque le champ destiné au mot de passe n'est pas renseigné au cours de la connexion. Utilisé dans l'écran de connexion.
portlet.not.active - Apparaît lorsqu'un portlet n'est pas actif. Utilisé dans la balise <portal-skin:portletRender/>.
portlet.not.authorized - Apparaît lorsqu'un utilisateur ne dispose pas des droits nécessaires sur un portlet. Utilisé dans la balise <portal-skin:portletRender/>.
portlet.not.available - Apparaît lorsqu'une erreur survient, empêchant un portlet de s'afficher. Utilisé dans la balise <portal-skin:portletRender/>.
portlet.title.not.available - Apparaît lorsque le titre d'un portlet n'est pas disponible. Utilisé dans la balise <portal-skin:portletTitle/>.
userid.invalid - Apparaît lorsque le champ ID utilisateur n'est pas renseigné au cours de la connexion. Utilisé dans l'écran de connexion.

Il existe une clé de réponse correspondant à chaque problème (voir la balise <portal-fmt:answer/>).

Le regroupement de ressources doit se trouver dans un répertoire qui figure dans le chemin d'accès aux classes de l'application d'entreprise HCL Portal. Il est conseillé de créer un répertoire pour séparer votre code personnalisé du code de base. Ajoutez le nouveau répertoire au chemin d'accès aux classes de l'application de portail. Pour plus de détails, reportez-vous à la documentation WebSphere® Application Server. L'exemple suivant récupère le texte du problème dans /nls/problem_locale.properties. Le texte s'affiche uniquement lorsqu'une erreur survient au cours du rendu de la page.

Par exemple:


    
    <portal-core:pageRender>
       <p align="center">
         <strong><portal-fmt:problem bundle="nls.problem"/></strong>
         <br>
         <portal-fmt:answer bundle="nls.problem"/>
       </p>
    </portal-core:pageRender>

<portal-fmt:text key="key" bundle="bundle">

Retourne le texte pour une clé dans la langue spécifiée. La clé key indique un paramètre dans un ensemble de ressources ou un fichier de propriétés, indiqué par bundle. Les deux attributs sont obligatoires. Reportez-vous à la description de <portal-fmt:textParam> pour obtenir un exemple et une description plus détaillée des attributs de <portal-fmt:text/>.

Dans la mesure du possible, les balises <i18n:bundle/> et <i18n:message/> provenant de la bibliothèque de balises I18N peuvent être préférées à <portal-fmt:text/>.

<portal-fmt:textParam>

Si le texte récupéré contient des marques de réservation sous la forme "{0}", "{1}", "{2}", cette balise permet de les définir. Cette balise peut être utilisée uniquement dans le corps de la balise <portal-fmt:text/>. Le texte qui doit se substituer aux paramètres fictifs doit être saisi en tant que contenu de cette balise. Il peut même s'agir d'une expression.

Exemples

Le paramètre welcome d'un regroupement de ressources est défini comme suit :


     welcome = Welcome {0}!

Dans l'exemple suivant, la valeur de la balise <portal-fmt:textParam> est inscrite à la place du {0}.


    <portal-fmt:text key="welcome" bundle="nls.engine">
        <portal-fmt:textParam>World</portal-fmt:textParam>
    </portal-fmt:text>

<portal-fmt:title locale="locale" varname="localized_object"/>

Fournit le titre de l'objet indiqué dans varname. La balise indique également l'objet s'il est appelé dans la balise <portal-navigation:navigationLoop/>.

Attributs

locale: Facultatif. Remplace le paramètre de langue actuel.
varname: Facultatif. Spécifie le nom de la variable de script contenant l'objet. La balise <portal-navigation:navigation/> définit cet objet comme <%=wpsNavNode%>.

<portal-fmt:user attribute="value"/>

Si l'utilisateur est connecté, cette balise retourne l'un des attributs spécifiés de l'utilisateur. value peut être n'importe quel attribut de l'utilisateur défini pour le Gestionnaire des membres.