Présentation de la Taglib Displaytag

Voici un exemple d'utilisation très simple permettant d'afficher sous la forme d'un tableau une liste nommée « mylist » contenant des objets de type « User ».

public class User {
    int id;
    String nom;
    String prenom;
    String email;
    int age;
            
    // getters and setters
    }

<display:table name="mylist" />

Et le résultat :

Cet exemple permet de préciser les colonnes que vous souhaitez afficher et les noms des entêtes de ces colonnes.
Il suffit de rajouter le tag <display:column property=« … »>. property étant le nom de l'attribut dans le bean User.

<display:table name="mylist" >
    <display:column property="id" title="N°" />
    <display:column property="nom" title="Nom"  />
    <display:column property="prenom" title="Prénom"  />
    <display:column property="email" title="Email"  />
</display:table>

Et le résultat :

Il est possible de créer des colonnes triables. Le composant Displaytag assure un tri « en mémoire » de la liste. Cela est donc très simple d'utilisation et très rapide pour de petites listes. Cela ne convient donc pas aux (très) grandes listes. Dans ce cas, il faudra plutôt paramétrer le composant pour une « pagination externe » avec un tri effectué par la base de données par exemple.
Pour rendre une colonne triable, il suffit d'ajouter sortable=« true ».
Pour préciser le tri par défaut du tableau, il faut ajouter defaultsort=« … ». defaultsort étant le numéro de la colonne à trier.

<display:table name="mylist" defaultsort="2" defaultorder="descending" >
    <display:column property="id" title="N°" />
    <display:column property="nom" title="Nom" sortable="true" />
    <display:column property="prenom" title="Prénom" />
    <display:column property="email" title="Email" sortable="true" />
</display:table>

Et le résultat :

Si vous utilisez Struts (ou une servlet) pour initialiser votre jsp, il vous faudra alors rajouter l'attribut requestURI=« /monAction.do » pour que la page soit repostée sur l'action et non sur la jsp. Quand cet attribut est présent, les liens autogénérés pour les tris, les exports et la pagination sont basés sur ce paramètre.

La gestion de la pagination est entièrement prise en charge par le composant Displaytag. Il suffit de préciser le nombre d'éléments à afficher par page. Le composant va alors générer automatiquement la numérotation et la pagination (liens page précédente, page suivante, première page et dernière page).
Il suffit d'ajouter pagesize=« … » pour préciser le nombre de lignes à afficher par page

<display:table name="mylist" pagesize="5" />

Et le résultat :

En rajoutant les attributs offset=« … » length=« … » par exemple, vous pourrez même restreindre l'affichage à une partie de la liste (ex. : offset=« 3 » length=« 5 »)

Si vous avez des adresses Emails ou des URL Web dans une colonne et que vous souhaitez afficher ces données comme des liens hypertextes, il suffit de rajouter l'attribut autolink=« true ». Displaytag va générer pour vous ces liens.

<display:table name="mylist" >
    <display:column property="id" title="N°" />
    <display:column property="nom" title="Nom" />
    <display:column property="prenom" title="Prénom" />
    <display:column property="email" title="Email" autolink="true" />
</display:table>

Et le résultat :

Le tag column fournit également cinq « struts-like » attributs que vous pouvez utiliser pour créer un lien dynamique (href, paramID, paramName, paramProperty, paramScope).

<display:table name="mylist" >
    <display:column property="id" title="N°" />
    <display:column property="nom" title="Nom" href="details.jsp" paramId="idUtil" paramProperty="id" />
    <display:column property="prenom" title="Prénom" />
    <display:column property="email" title="Email" />
</display:table>

La bibliothèque offre un autre mécanisme appelé Decorator. Il s'agit en fait de classe héritant de la classe TableDecorator.
Dans ces classes, on définit des méthodes qui seront appelées lors de la génération des tables.
Un mapping sera automatiquement effectué entre les attributs property des tags column et ces méthodes.
On peut ainsi facilement modifier le rendu de l'affichage d'une colonne. Par exemple, lorsque l'on veut afficher des monnaies ou des dates ou encore si l'on veut générer dynamiquement des liens html.

public class MyDecorator extends TableDecorator {

    public String getMyLink()
    {
        User user= (User) getCurrentRowObject();
        int lId= user.getId();
        
        return "<a href=\"details.jsp?idUtil=" + lId + "\">Modifier</a>";
    }

}

<display:table name="mylist" decorator="MyDecorator" />
    <display:column property="id" title="N°" />
    <display:column property="nom" title="Nom" />
    <display:column property="prenom" title="Prénom" />
    <display:column property="email" title="Email" />
    <display:column property="myLink" title="" />
</display:table>

Et le résultat :

La configuration par défaut de Displaytag est définie dans le fichier displaytag.properties contenu dans la bibliothèque displaytag.jar.
Il y a deux possibilités pour modifier cette configuration :

• pour toute l'application web, créer un fichier personnalisé nommé displaytag.properties et le sauvegarder dans le classpath (WEB-INF/classes) ;
• pour un tableau spécifique, en utilisant dans le tableau les tags <display:setProperty …>

basic.empty.showtable=true
basic.msg.empty_list=No results matched your criteria.

#paging.banner.placement=top
paging.banner.placement=bottom

export.types=csv excel xml pdf rtf
export.excel=true
export.csv=true
export.xml=true
export.pdf=true
export.rtf=true
export.excel.class=org.displaytag.export.ExcelView
export.pdf.class=org.displaytag.export.DefaultPdfExportView
export.rtf.class=org.displaytag.export.DefaultRtfExportView
# if set, file is downloaded instead of opened in the browser window
#export.[mymedia].filename=

Pour avoir la liste de toutes les options configurables, reportez-vous à la documentation.

Pour exporter les tableaux, il faut copier dans le répertoire %WebAppRoot%/WEB-INF/lib de votre application, les bibliothèques itext.jar et displaytag-export-poi.jar.
Quand vous précisez le flag export=« true » dans le tag table, le composant offre alors la possibilité d'exporter le tableau affiché (WYSIWYG) sous la forme d'un fichier au format csv, excel, xml, pdf ou rtf.
En spécifiant le tag media=« … », vous pouvez préciser quelles colonnes seront exportées et dans quelle sortie.
Par exemple media=« html excel » permet de n'afficher la colonne que dans les pages html et dans les fichiers Excel

<display:table name="mylist" export="true" />

Et le résultat :

Lors de l'export, si vous rencontrez des erreurs liées au content type, il faudra installer un filtre. Reportez-vous à la documentation.

Si vous souhaitez utiliser Displaytag dans une application multilingue, vous aurez besoin de traduire les messages et libellés html utilisés par le composant. Pour cela, il suffit de créer un fichier par langue et de les nommer displaytag_LANGUAGE.properties (ex. : displaytag_en.properties, displaytag_it.properties).
Si vous utilisez Displaytag avec Struts, vous pourrez utiliser les fichiers messages.properties de Struts pour gérer les traductions des entêtes de colonnes. Pour cela, ajoutez la ligne suivante dans le fichier de configuration de Displaytag :

locale.provider=org.displaytag.localization.I18nStrutsAdapter

Le tag titleKey permet pour chaque colonne de préciser le code du libellé correspondant dans le fichier messages.properties ou displaytag.properties :

utilisateurs.text.TitreColId=N°
utilisateurs.text.TitreColNom=Nom
utilisateurs.text.TitreColPrenom=Prénom
utilisateurs.text.TitreColPrenom=Email

<display:table name="mylist" >
    <display:column property="id" titleKey="utilisateurs.text.TitreColId" />
    <display:column property="nom" titleKey="utilisateurs.text.TitreColNom" />
    <display:column property="prenom" titleKey="utilisateurs.text.TitreColPrenom" />
    <display:column property="email" titleKey="utilisateurs.text.TitreColEmail" />
</display:table>

Les Displaytag offrent de nombreuses autres possibilités :

• lorsque vous avez une liste dont les objets sont triés et regroupés sur plusieurs colonnes : au lieu de répéter les mêmes valeurs dans toutes ces colonnes, seules les valeurs qui changent seront affichées ;
• la totalisation d'une colonne ;
• un entête (header) et un bas de page (footer) au tableau ;
• le formatage des dates et des nombres ;
• la pagination externe. Cela permet de gérer manuellement par programmation le tri et la pagination. Lire cet article.