Introduction aux frameworks JSF2, Primefaces et Primefaces mobile


précédentsommairesuivant

VI. Introduction à la bibliothèque de composants PrimeFaces

VI-A. La place de Primefaces dans une application JSF

Revenons à l'architecture d'une application JSF telle que nous l'avons étudiée au début de ce document :

Image non disponible

Les pages JSF étaient construites avec trois bibliothèques de balises :

 
CacherSélectionnez
  • ligne 2 : les balises <h:x> de l'espace de noms [http://java.sun.com/jsf/html] qui correspondent aux balises HTML,
  • ligne 3 : les balises <f:y> de l'espace de noms [http://java.sun.com/jsf/core] qui correspondent aux balises JSF,
  • ligne 4 : les balises <ui:z> de l'espace de noms [http://java.sun.com/jsf/facelets] qui correspondent aux balises des facelets.

Pour construire les pages JSF, nous allons ajouter une quatrième bibliothèque de balises, celles des composants Primefaces.

 
CacherSélectionnez
  • ligne 3 : les balises <p:z> de l'espace de noms [http://primefaces.org/ui] correspondent aux composants Primefaces.

C'est la seule modification qui va apparaître. Elle apparaît donc dans les vues. Les gestionnaires d'événements et les modèles restent ce qu'ils étaient avec JSF. C'est un point important à comprendre.

L'utilisation des composants Primefaces permet de créer des interfaces web plus conviviales grâce au nombreux composants de cette bibliothèque et plus fluides grâce à la technologie AJAX qu'elle utilise nativement. On parle alors d'interfaces riches ou RIA (Rich Internet Application).

L'architecture JSF précédente deviendra l'architecture PF (Primefaces) suivante :

Image non disponible

VI-B. Les apports de Primefaces

Le site de Primefaces [http://www.primefaces.org/showcase/ui/home.jsf] donne la liste des composants utilisables dans une page PF :

Image non disponible

Dans les exemples à venir, nous utiliserons les deux premières caractéristiques de Primefaces :

  • certains de la centaine de composants offerts,
  • le comportement AJAX natif de ceux-ci.

Parmi les composants offerts :

Image non disponible

Nous n'utiliserons qu'une quinzaine d'entre-eux dans nos exemples, mais ce sera suffisant pour comprendre les principes de construction d'une page Primefaces.

VI-C. Apprentissage de Primefaces

Primefaces offre des exemples d'utilisation de chacun de ses composants. Il suffit de cliquer sur son lien. Regardons un exemple :

Image non disponible
  • en [1], l'exemple pour le composant [Spinner],
  • en [2], la boîte de dialogue affichée après un clic sur le bouton [Submit].

Il y a là pour nous, trois nouveautés :

  • le composant [Spinner] qui n'existe pas de base en JSF,
  • idem pour la boîte de dialogue,
  • enfin, le POST provoqué par le [Submit] est ajaxifié. Si on observe bien le navigateur lors du POST, on ne voit pas le sablier. La page n'est pas rechargée. Elle est simplement modifiée : un nouveau composant, ici la boît de dialogue apparaît dans la page.

Voyons comment tout cela est produit. Le code XHTML de l'exemple est le suivant :

 
CacherSélectionnez

Tout d'abord, constatons qu'on retrouve des balises JSF classiques : <h:form> ligne 1, <h:panelGrid> ligne 3, <h:outputLabel> ligne 4. Certaines balises JSF sont reprises par PF et enrichies : <p:commandButton> ligne 21. Ensuite, on trouve des balises PF de mise en forme : <p:panel> ligne 2, <p:outputPanel> ligne 13, <p:dialog> ligne 23. Enfin, on a des balises de saisie : <p:spinner> ligne 5.

Analysons ce code en correspondance avec la vue :

Image non disponible
  • en [1], le composant obtenu avec la balise <p:panel> de la ligne 2,
  • en [2], le champ de saisie obtenu par la combinaison d'une balise <p:outputLabel> et <p:spinner>, lignes 6 et 7,
  • en [3], le bouton du POST obtenu avec la balise <p:commandButton> de la ligne 21,
  • en [4], la boîte de dialogue des lignes 23-25,
  • en [5], un conteneur invisible pour deux composants. Il est créé par la balise <p:outputPanel> de la ligne 13.

Analysons le code suivant qui met en œuvre une action AJAX :

 
CacherSélectionnez

Ce code génère la vue suivante :

Image non disponible
  • ligne 1 : affiche le texte [1]. Est en même temps un libellé pour le composant d'id=ajaxspinner (attribut for). Ce composant est celui de la ligne 3(attribut id),,
  • lignes 3-5 : affichent le composant [2]. Ce composant est un composant de saisie / affichage associé au modèle #{spinnerController.number5} (attribut value),
  • ligne 6 : affiche le composant [3]. Ce composant est un composant d'affichage lié au modèle #{spinnerController.number5} (attribut value),
  • ligne 4 : la balise <p:ajax> ajoute un comportement AJAX au spinner. A chaque fois que celui-ci change de valeur, un POST de cette valeur (attribut process="@this") est fait au modèle #{spinnerController.number5}. Ceci fait, une mise à jour de la page est faite (attribut update). Cet attribut a pour valeur l'id d'un composant de la page, ici celui de la ligne 6. Le composant cible de l'attribut update est alors mis à jour avec le modèle. Celui-ci est de nouveau #{spinnerController.number5}, donc la valeur du spinner. Ainsi la zone [3] suit les saisies de la zone [2].

On a là un comportement AJAX, acronyme qui signifie Asynchronous Javascript And XML. De façon générale, un comportement AJAX est le suivant :

Image non disponible
  • le navigateur affiche une page HTML qui contient du code Javascript (J de AJAX). Les éléments de la page forment un objet Javascript qu'on appelle le DOM (Document Object Model),
  • le serveur loge l'application web qui a produit cette page,
  • en [1], un événement se produit dans la page. Par exemple l'incrémentation du spinner. Cet événement est géré par du Javascript,
  • en [2], le Javascript fait un POST à l'application web. Il le fait de façon asynchrone (le A de AJAX). L'utilisateur peut continuer à travailler avec la page. Elle n'est pas gelée mais on peut si nécessaire la geler. Le POST met à jour le modèle de la page à partir des valeurs postées, ici le modèle #{spinnerController.number5},
  • en [3], l'application web renvoie au Javascript, une réponse XML (le X de AJAX) ou JSON (JavaScript Object Notation),
  • en [4], le Javascript utilise cette réponse pour mettre à jour une zone précise du DOM, ici la zone d'id=ajaxspinnervalue.

Lorsqu'on utilise JSF et Primefaces, le Javascript est généré par Primefaces. Cette bibliothèque s'appuie sur la bibliothèque Javascript JQuery. De même les composants Primefaces s'appuient sur ceux de la bibliothèque de composants JQuery UI (User Interface). Donc JQuery est à la base de Primefaces.

Revenons à notre exemple et présentons maintenant le POST du bouton [Submit] :

Image non disponible

Le code associé au POST est le suivant :

 
CacherSélectionnez
  • ligne 1 : le POST est provoqué par le bouton de la ligne 1. Dans Primefaces, les balises qui provoquent un POST le font par défaut sous la forme d'un appel AJAX. C'est pourquoi ces balises ont un attribut update pour indiquer la zone à mettre à jour, une fois la réponse du serveur reçue. Ici, la zone mise à jour est le panelGrid de la ligne 4. Donc au retour du POST, cette zone va être mise à jour par les valeurs postées au modèle. Cependant, elles sont à l'intérieur d'une boîte de dialogue non visible par défaut. C'est l'attribut oncomplete de la ligne 1 qui l'affiche. Cet événement se produit à la fin du traitement du POST. La valeur de cet attribut est du code Javascript. Ici, on affiche la boîte de dialogue qui a l'id=dialog, donc celle de la ligne 3 (attribut widgetVar),
  • ligne 3 : on voit divers attributs de la boîte de dialogue. Il faut expérimenter pour voir ce qu'ils font.

Nous avons parlé du modèle mais ne l'avons pas encore présenté. C'est celui-ci :

 
CacherSélectionnez

De façon générale, on peut procéder comme suit :

  • repérer le composant Primefaces qu'on veut utiliser,
  • étudier son exemple. Les exemples de Primefaces sont bien faits et facilement compréhensibles.

VI-D. Un premier projet Primefaces : mv-pf-01

Construisons un projet web Maven avec Netbeans :

Image non disponible
  • [1, 2, 3] : on construit un projet Maven de type [Web Application],
    Image non disponible
  • [4] : le serveur sera Tomcat,
  • en [5], le projet généré,
  • en [6], on le nettoie du fichier [index.jsp] et du paquetage Java,
    Image non disponible
  • en [7, 8] : dans les propriétés du projet, on ajoute un support pour Java server Faces,
    Image non disponible
  • en [9], dans l'onglet [Components] on choisit la bibliothèque de composants Primefaces. Netbeans offre un support pour d'autres bibliothèques de composants : ICEFaces et RichFaces.
  • en[10], le projet généré. En [11], on notera la dépendance sur Primefaces.

En clair, un projet Primefaces est un projet JSF classique auquel on a ajouté une dépendance sur Primefaces. Rien de plus.

Ayant compris cela, nous modifions le fichier [pom.xml] pour travailler avec les dernières versions des bibliothèques :

[pom.xml]
CacherSélectionnez

Lignes 26-30, on notera le dépôt Maven pour Primefaces. Ces modifications faites, on construit le projet pour lancer le téléchargement des dépendances. On obtient alors le projet [12].

Maintenant, essayons de reproduire l'exemple que nous avons étudié. La page [index.xhtml] devient la suivante :

[index.xhtml]
CacherSélectionnez

On n'oubliera pas la ligne 5 qui déclare l'espace de noms de la bibliothèque de balises Primefaces. On rajoute au projet, le bean qui sert de modèle à la page :

Image non disponible

Le bean est le suivant :

 
CacherSélectionnez

La classe est un bean (ligne 6) de portée requête (ligne 7). Comme on n'a pas indiqué de nom, le bean porte le nom de la classe avec le premier caractère en minuscule : spinnerController.

Lorsqu'on exécute le projet, on obtient la chose suivante :

Image non disponible

Nous venons ainsi de montrer comment tester un exemple pris sur le site de Primefaces. Tous les exemples peuvent être testés de cette façon.

Dans la suite, nous allons nous intéresser qu'à certains composants de Primefaces. Nous allons tout d'abord reprendre les exemples étudiés avec JSF et remplacer certaines balises JSF par des balises Primefaces. L'aspect des pages sera un peu modifié, elles auront un comportement AJAX mais les beans associés n'auront pas à être changés. Dans chacun des exemples à venir, nous nous contentons de présenter le code XHTML des pages et les copies d'écran associées. Le lecteur est invité à tester les exemples afin de déceler les différences entre les pages JSF et les pages PF.

VI-E. Exemple mv-pf-02 : gestionnaire d'événement - internationalisation - navigation entre pages

Ce projet est le portage du projet JSF [mv-jsf2-02] (paragraphe , page ) :

Image non disponible

Le projet Netbeans est le suivant :

Image non disponible

La page [index.xhtml] est la suivante :

[index.xhtml]
CacherSélectionnez

Aux lignes 15, 16 et 19 les balises <h:commandLink> ont été remplacées par des balises <p:commandLink>. Cette balise a un comportement AJAX par défaut qu'on peut inhiber en mettant l'attribut ajax="false". Donc ici, les balises <p:commandLink> se comportent comme des balises <h:commandLink> : il y aura un rechargement de la page lors d'un clic sur ces liens.

VI-F. Exemple mv-pf-03 : mise en page à l'aide des facelets

Ce projet présente la création de pages XHTML à l'aide des modèles facelets de l'exemple [mv-jsf2-09] (paragraphe , page ) :

Image non disponible

Le projet Netbeans est le suivant :

Image non disponible
  • en [1], les fichiers de configuration du projet JSF,
  • en [2], les pages XHTML,
  • en [3], le bean support pour le changement de langues,
  • en [4], les fichiers de messages,
  • en [5], les dépendances.

Les pages du projet ont pour modèle la page [layout.xhtml] :

[layout.xhtml]
CacherSélectionnez
  • ligne 9 : une balise <f:view> encadre toute la page afin de profiter de l'internationalisation qu'elle permet,
  • ligne 15 : un formulaire d'id formulaire. Ce formulaire forme le corps de la page. Dans ce corps, il n'y a qu'une partie dynamique, celle des lignes 28-30. C'est là que viendra s'insérer la partie variable de la page :
    Image non disponible
  • la zone encadrée ci-dessus sera mise à jour par des appels AJAX. Afin de l'identifier, nous l'avons incluse dans un conteneur Primefaces généré par la balise <p:outputPanel> (ligne 27). Et ce conteneur a été nommé contenu (attribut id). Comme il se trouve dans un formulaire qui est lui-même un conteneur de nom formulaire, le nom complet de la zone dynamique est :formulaire:contenu. Le premier : indique qu'on part de la racine du document, puis on passe dans le conteneur de nom formulaire, puis dans le conteneur de nom contenu. Une difficulté avec AJAX est de nommer correctement les zones à mettre à jour par un appel AJAX. Le plus simple est de regarder le code source de la page HTML reçue :
 
CacherSélectionnez

Ci-dessus, on voit que la balise <h:outputPanel> a généré une balise HTML <span>. Dans cet exemple, le nom relatif formulaire:contenu (sans le : de départ) et le nom complet :formulaire:contenu (avec le : de départ) désignent le même objet.

On retiendra que les appels AJAX (<p:commandButton>, <p:commandLink>) mettant à jour la zone dynamique auront l'attribut update=":formulaire:contenu".

La page [index.xhtml] est l'unique page affichée par le projet :

[index.xhtml]
CacherSélectionnez
  • ligne 8, le modèle de [index.xhtml] est la page [layout.xhtml] qu'on vient de présenter,
  • ligne 9, c'est la zone d'id contenu qui est mise à jour par [index.xhtml]. Dans cette zone, il y a deux fragments :
  • le fragment [page1.xhtml] ligne 11 ;
  • le fragment [page2.xhtml] ligne 14.

Ces deux fragments sont exclusifs l'un de l'autre.

  • ligne 10 : le fragment [page1.xhtml] est affiché si la requête a l'attribut page1 à true ou si l'attribut page2 n'existe pas. C'est le cas de la toute première requête où aucun de ces attributs ne sera présent dans la requête. Dans ce cas, on affichera le fragment [page1.xhtml],
  • ligne 11, le fragment [page2.xhtml] est affiché si la requête a l'attribut page2 à true

Le fragment [page1.xhtml] est le suivant :

[page1.xhtml]
CacherSélectionnez

et affiche le contenu suivant :

Image non disponible
  • lignes 11 et 12, les deux liens pour changer la langue. Ces deux liens provoquent des appels AJAX (ajax=true). C'est la valeur par défaut. On peut donc ne pas mettre l'attribut ajax=true. Nous ne le ferons plus par la suite. On notera que ces deux liens mettent à jour la zone :formulaire:contenu (attribut update), celle qui est encadrée ci-dessus,
  • ligne 15 : un lien AJAX de navigation qui là encore met à jour la zone :formulaire:contenu,
  • ligne 16 : on utilise la balise <h:setPropertyActionListener> pour mettre l'attribut page2 dans la requête avec la valeur true. Cela va avoir pour effet d'afficher le fragment [page2.xhtml] (ligne 6 ci-dessous) dans la page [index.xhtml] :
 
CacherSélectionnez

Le fragment [page2.xhtml] est analogue :

Image non disponible

Le code de [page2.xhtml] est le suivant :

[page2.xhtml]
CacherSélectionnez

De cet exemple, nous retiendrons les points suivants pour la suite :

  • nous utiliserons le modèle [layout.xhtml] comme modèle des pages,
  • la zone dynamique sera identifiée par l'id :formulaire:contenu et sera mise à jour par des appels AJAX.

VI-G. Exemple mv-pf-04 : formulaire de saisie

Ce projet est le portage du projet JSF2 [mv-jsf2-03] (cf paragraphe , page ) :

Image non disponible

Le projet Netbeans est le suivant :

Image non disponible

Ci-dessus, en [1], les pages XHTML du projet. La mise en page est assurée par le modèle [layout.xhtml] étudié précédemment. La page [index.xhtml] est l'unique page du projet. Elle s'affiche dans la zone :formulaire:contenu. Son code est le suivant :

[layout.xhtml]
CacherSélectionnez

Elle se contente d'afficher le frament [page1.xhtml]. Celui-ci est l'équivalent du formulaire étudié dans l'exemple [mv-jsf2-03]. Rappelons que celui-ci avait pour but de présenter les balises JSF de saisie. Ces balises ont été ici remplacées par des balises Primefaces.

PanelGrid

Pour mettre en forme les éléments de [page1.xhtml], nous utilisons la balise <p:panelGrid>. Par exemple, pour les deux liens des langues :

 
CacherSélectionnez

Cela donne le rendu suivant :

Image non disponible

Une autre forme de la balise <p:panelGrid> est la suivante :

 
CacherSélectionnez

Les lignes et les colonnes du tableau sont identifiées par les balises <p:row> et <p:column>.

Les lignes 3-12 définissent l'entête du tableau :

Image non disponible

Les lignes 14-25 définissent une ligne du tableau :

Image non disponible

Les lignes 27-35 définissent le pied de page du tableau :

Image non disponible

inputText

 
CacherSélectionnez
Image non disponible

password

 
CacherSélectionnez
Image non disponible

Ligne 7, l'attribut feedback=true permet d'avoir un retour sur la qualité [1] du mot de passe.

inputTextArea

 
CacherSélectionnez
Image non disponible

Ligne 7, la balise <p:editor> affiche un éditeur riche qui permet de mettre en forme le texte (police, taille, couleur, alignement…). Ce qui est posté au serveur est le code HTML du texte saisi [2].

selectOneListBox

 
CacherSélectionnez
Image non disponible

selectOneMenu

 
CacherSélectionnez
Image non disponible

selectManyMenu

 
CacherSélectionnez
Image non disponible

Ligne 14, on notera que le lien [Raz] fait une mise à jour AJAX de la zone :formulaire:selectManyMenu qui correspond au composant de la ligne 6. Néanmoins, il faut savoir que lors du POST AJAX, toutes les valeurs du formulaire sont postées. Donc c'est la totalité du modèle qui est mis à jour. Avec ce modèle, on ne met cependant à jour que la zone :formulaire:selectManyMenu.

selectBooleanCheckbox

 
CacherSélectionnez
Image non disponible

selectManyCheckbox

 
CacherSélectionnez
Image non disponible

selectOneRadio

 
CacherSélectionnez
Image non disponible

VI-H. Exemple : mv-pf-05 : listes dynamiques

Ce projet est le portage du projet JSF2 [mv-jsf2-04] (cf paragraphe , page ) :

Image non disponible

Ce projet n'amène pas de nouvelles balises Primefaces vis à vis du projet précédent. Aussi ne le commenterons-nous pas. Il fait partie de la liste des exemples mis à disposition du lecteur sur le site du document.

VI-I. Exemple : mv-pf-06 : navigation - session - gestion des exceptions

Ce projet est le portage du projet JSF2 [mv-jsf2-05] (cf paragraphe , page ) :

Image non disponible

De nouveau, cet exemple n'amène pas de balises Primefaces nouvelles. Nous ne commenterons que le tableau des liens encadré ci-dessus :

 
CacherSélectionnez
  • les liens ont tous l'attribut ajax=false. Il y a donc un chargement de page normal,
  • on notera lignes 2 et 4, la façon de faire une redirection.

VI-J. Exemple : mv-pf-07 : validation et conversion des saisies

Ce projet est le portage du projet JSF2 [mv-jsf2-06] (cf paragraphe , page ) :

Image non disponible

L'application introduit deux nouvelles balises, la balise <p:messages> :

 
Sélectionnez
1.
<p:messages globalOnly="true"/>
Image non disponible

et la balise <p:message> :

 
CacherSélectionnez
Image non disponible

Vis à vis de la balise <h:message> de JSF, la balise <p:message> de PF amène les changements suivants :

  • l'apparence du message d'erreur est différente [1],
  • la zone de saisie erronée est entourée d'un cadre rouge [2].

VI-K. Exemple : mv-pf-08 : événements liés au changement d'état de composants

Ce projet est le portage du projet JSF2 [mv-jsf2-07] (cf paragraphe , page ) :

Image non disponible

Le projet JSF introduisait la notion de listeners. La gestion du listener avec Primefaces a été faite différemment.

Avec JSF :

 
CacherSélectionnez

Avec Primefaces :

 
CacherSélectionnez
  • ligne 2 : la balise <h:selectOneMenu> sans attribut valueChangeListener,
  • ligne 4 : la balise <p:ajax> ajoute un comportement AJAX à sa balise parent <h:selectOneMenu>. Par défaut, elle réagit à l'événement " changement de valeur " de la liste combo1. Sur cet événement, les valeurs du formulaire auquel elle appartient vont être postées au serveur par un appel AJAX. Le modèle est donc mis à jour. On utilise ce nouveau modèle pour mettre à jour la liste déroulante identifiée par combo2 (ligne 10). On notera, ligne 4, que l'appel AJAX n'exécute pas de méthode du modèle. C'est inutile ici. On veut simplement changer le modèle par le POST des valeurs saisies.

VI-L. Exemple : mv-pf-09 : saisie assistée

Ce projet présente des balises de saisie spécifiques à Primefaces qui facilitent la saisie de certains types de données :

Image non disponible

VI-L-1. Le projet Netbeans

Le projet Netbeans est le suivant :

Image non disponible

L'intérêt du projet réside dans :

  • l'unique page [index.xhtml] affichée par celui-ci,
  • le modèle [Form.java] de cette dernière.

VI-L-2. Le modèle

Le formulaire présente quatre champs de saisie associés au modèle suivant :

 
CacherSélectionnez

Les quatre saisies sont associées aux champs des lignes 14-17.

VI-L-3. Le formulaire

Le formulaire est le suivant :

[index.xhtml]
CacherSélectionnez

Examinons les quatre champs de saisie.

VI-L-4. Le calendrier

La balise <p:calendar> permet de sélectionner une date à partir d'un calendrier. Cette balise admet différents attributs.

 
CacherSélectionnez

Ligne 2, on indique que la date doit être affichée au format " jj/mm/aaaa " et que la zone horaire est celle de Paris. Lorsqu'on place le curseur dans la zone de saisie, un calendrier est affiché :

Image non disponible

VI-L-5. Le slider

La balise <p:slider> permet de saisir un entier en faisant glisser un curseur le long d'une barre :

Image non disponible

Le code de la balise est le suivant :

 
CacherSélectionnez
  • ligne 3 : on a là une balise <p:inputText> classique qui permet de saisir le nombre entier. Celui-ci peut être également saisi grâce au slider,
  • ligne 4 : la balise <p:slider> est associée à la balise de saisie <p:inputText> (attribut for). On lui fixe une valeur minimale et une valeur maximale.

VI-L-6. Le spinner

On a eu déjà l'occasion de présenter ce composant :

 
CacherSélectionnez

Ligne 3, le spinner permet une saisie d'un nombre entier entre 1 et 12. On peut saisir le nombre directement dans la zone de saisie du spinner ou bien utiliser les flèches pour augmenter / diminuer le nombre saisi.

Image non disponible

VI-L-7. La saisie assistée

La saisie assistée consiste à taper les premiers caractères de la saisie. Des propositions apparaissent alors dans une liste déroulante. On peut sélectionner l'une d'elles. On utilise ce composant à la place des listes déroulantes lorsque celles-ci ont un contenu trop important. Supposons que l'on veuille proposer une liste déroulante des villes de France. Cela fait plusieurs milliers de villes. Si on laisse l'utilisateur taper les trois premiers caractères de la ville, on peut alors lui proposer une liste réduite des villes commençant par ceux-ci.

Image non disponible

Le code de ce composant est le suivant :

 
CacherSélectionnez

La balise <p:autoComplete> de la ligne 2 est celle qui permet la saisie assistée. Le paramètre qui nous intéresse ici est l'attribut completeMethod dont la valeur est le nom d'une méthode du modèle, responsable de faire des propositions correspondant aux caractères tapés par l'utilisateur. Cette méthode est ici la suivante :

 
CacherSélectionnez
  • ligne 1 : la méthode reçoit comme paramètre la chaîne des caractères tapés par l'utilisateur dans la zone de saisie. Elle rend une liste de propositions,
  • lignes 4-6 : on construit une liste de 10 propositions qui reprend les caractères reçus en paramètres et leur ajoute un chiffre de 0 à 9.

VI-L-8. La balise <p:growl>

La balise <p:growl> est un remplacement possible de la balise <p:messages> qui affiche les messages d'erreur du formulaire.

 
Sélectionnez
1.
<p:growl id="messages" autoUpdate="true"/>

Ci-dessus, l'attribut id n'est pas utilisé. L'attribut autoUpdate=true indique que la liste des messages d'erreurs doit être réactualisée à chaque POST du formulaire.

Supposons que l'on valide le formulaire suivant [1] :

Image non disponible
  • en [2], la balise <p:growl> affiche alors les messages d'erreurs associés aux saisies erronées.

VI-M. Exemple : mv-pf-10 : dataTable - 1

Ce projet présente la balise <p:dataTable> qui sert à afficher des listes de données

Image non disponible

VI-M-1. Le projet Netbeans

Le projet Netbeans est le suivant :

Image non disponible

L'intérêt du projet réside dans :

  • l'unique page [index.xhtml] affichée par celui-ci,
  • le modèle [Form.java] de cette dernière et le bean [Personne].

VI-M-2. Le fichier des messages

Le fichier [messages_fr.properties] est le suivant :

[messages_fr.properties]
CacherSélectionnez

VI-M-3. Le modèle

Le bean [Personne] représente une personne :

[Personne]
CacherSélectionnez

Le modèle de la page [index.xhtml] est la classe [Form] suivante :

[Form]
CacherSélectionnez
  • lignes 9-10 : le bean est de portée session,
  • lignes 18-24 : le constructeur crée une liste de trois personnes, liste qui va donc vivre au fil des requêtes,
  • ligne 15 : le n° d'une personne à supprimer de la liste,
  • lignes 26-28 : la méthode de suppression.

VI-M-4. Le formulaire

Le formulaire est le suivant [index.xhtml] :

[index.xhtml]
CacherSélectionnez

Cela produit la vue suivante (encadré ci-dessous) :

Image non disponible
  • ligne 12 : génère le tableau encadré ci-dessus. L'attribut value désigne la collection affichée par le tableau, ici la liste des personnes du modèle. L'attribut emptyMessage et facultatif. Il désigne le message à afficher lorsque la liste est vide. Par défaut c'est 'no records found'. Ici, ce sera :
    Image non disponible
  • lignes 13-15 : génèrent l'entête [1],
  • lignes 16-21 : génèrent la colonne [2],
  • lignes 22-27 : génèrent la colonne [3],
  • lignes 28-33 : génèrent la colonne [4],
  • lignes 34-41 : génèrent la colonne [5].

Le lien [Retirer] permet de retirer une personne de la liste. Ligne [38], c'est la méthode [Form].retirerPersonne qui fait ce travail. Elle a besoin de connaître le n° de la personne à retirer. Celui-ci lui est donné ligne 39. Ligne 38, on a utilisé l'attribut action. A d'autres occasions, on a utilisé l'attribut actionListener. Je ne suis pas sûr de bien comprendre la différence fonctionnelle entre ces deux attributs. A l'usage, on remarque cependant que les attributs positionnés par les balises <setPropertyActionListener> le sont avant exécution de la méthode désignée par l'attribut action, et que ce n'est pas le cas pour l'attribut actionListener. En clair, dès qu'on a des paramètres à envoyer à l'action appelée, il faut utiliser l'attribut action.

La méthode pour retirer une personne est la suivante :

 
CacherSélectionnez

VI-N. Exemple : mv-pf-11 : dataTable - 2

Ce projet présente un tableau affichant une liste de données où une ligne peut être sélectionnée :

Image non disponible

Le fait de sélectionner une ligne du tableau envoie, au moment du POST, des informations au modèle sur la ligne sélectionnée. Du coup, on n'a plus besoin d'un lien [Retirer] par personne. Un seul pour l'ensemble du tableau est suffisant.

Le projet Netbeans est identique au précédent à quelques détails près : le formulaire et son modèle. Le formulaire [index.xhtml] est le suivant  :

[index.xhtml]
CacherSélectionnez
  • ligne 13 : l'attribut selectionMode permet de choisir un mode de sélection single ou multiple. Ici, nous avons choisi de ne sélectionner qu'une seule ligne,
  • ligne 13 : l'attribut rowkey désigne un attribut des éléments affichés qui permet de les sélectionner de façon unique. Ici, nous avons choisi l'id de la personne sélectionnée,
  • ligne 13 : l'attribut selection désigne l'attribut du modèle qui recevra une référence de la personne sélectionnée. Grâce à l'attribut rowkey précédent, côté serveur une référence de la personne sélectionnée va pouvoir être calculée. On n'a pas les détails de la méthode utilisée. On peut imaginer que la collection est parcourue séquentiellement à la recherche de l'élément correspondant au rowkey sélectionné. Cela veut dire que si la méthode qui associe rowkey à selection est plus complexe, alors cette méthode n'est pas utilisable,

Ceci expliqué, la méthode [Form].retirerPersonne évolue comme suit :

[Form]
CacherSélectionnez
  • ligne 9 : à chaque POST, la référence de la ligne 9 est initialisée avec la référence, dans la liste de la ligne 8, de la personne sélectionnée,
  • en 18 : la suppression de la personne s'en trouve simplifiée. La recherche que nous avions faite dans l'exemple précédent a été faite par la balise <dataTable>.

VI-O. Exemple : mv-pf-12 : dataTable - 3

Ce projet est analogue au précédent. La vue est notamment identique :

Image non disponible

Le projet Netbeans est identique au précédent à quelques détails près que nous allons passer en revue. Le formulaire [index.xhtml] évolue comme suit :

[index.xhtml]
CacherSélectionnez
  • ligne 6, l'attribut rowkey a disparu, l'attribut selection reste. Le lien entre les attributs rowkey et selection se fait désormais au travers d'une classe. L'attribut value de la ligne 5 a désormais pour valeur une instance de l'interface Primefaces SelectableDataModel<T>. La méthode [Form].getPersonnes du modèle évolue comme suit :
 
CacherSélectionnez

Un nouveau bean est ainsi ajouté au projet :

Image non disponible

Ce bean est le suivant :

 
CacherSélectionnez
  • ligne 7 : la classe est une instance de l'interface SelectableDataModel. Deux classes au moins implémentent cette interface : ListDataModel dont le constructeur admet une liste pour paramètre, et ArrayDataModel dont le constructeur admet un tableau pour paramètre. Ici, notre bean étend la classe ListDataModel,
  • lignes 13-15 : le constructeur admet pour paramètre la liste des personnes que nous gérons. Ce paramètre est passé à la classe parent,
  • ligne 18 : la méthode getRowKey joue le rôle de l'attribut rowkey qui a été enlevé. Elle doit rendre l'objet qui permet d'identifier une personne de façon unique, ici l'id de la personne,
  • ligne 23 : la méthode getRowData doit rendre l'objet sélectionné, à partir de son rowkey. Donc ici, rendre une personne à partir de son id. La référence ainsi obtenue sera affectée à l'objet cible de l'attribut selection dans la balise dataTable, ici l'attribut selection="#{form.personneChoisie}". Le paramètre de la méthode est le rowkey de l'objet sélectionné par l'utilisateur, sous forme d'une chaîne de caractères,
  • lignes 24-35 : délivrent la référence sur la personne dont on a reçu l'id. Cette référence sera affectée au modèle [Form].personneChoisie. La méthode [retirerPersonne] reste donc inchangée :
 
CacherSélectionnez

C'est la technique à utiliser lorsque le lien entre les attributs rowkey et selection n'est pas un simple lien de propriété (rowkey) à objet (selection).

VI-P. Exemple : mv-pf-13 : dataTable - 4

Ce projet est analogue au précédent si ce n'est que le mode de sélection de la personne à retirer change :

Image non disponible

Ci-dessus, nous voyons que l'objet est sélectionné grâce à un menu contextuel (clic droit). Une confirmation de la suppression est demandée :

Image non disponible

Le formulaire [index.xhtml] évolue comme suit :

 
CacherSélectionnez
  • lignes 9-11 : définissent un menu contextuel pour (attribut for) le dataTable de la ligne 21 (attribut id). C'est donc sur un clic droit sur le tableau des personnes que ce menu contextuel apparaît,
  • ligne 10 : notre menu n'a qu'une option (balise menuItem). Lorsque cette option est cliquée, le code Javascript de l'attribut onclick est exécuté. Le code Javascript [confirmation.show()] fait afficher la boîte de dialogue de la ligne 14 (attribut widgetVar). Celle-ci est la suivante :
    Image non disponible
  • ligne 14 : l'attribut message fait afficher [3], l'attribut header fait afficher [1], l'attribut severity fait afficher l'icône [2],
  • ligne 16 : fait afficher [4]. Sur un clic, la personne est supprimée (attribut action), puis la boîte de dialogue est fermée (attribut oncomplete). L'attribut oncomplete est du code Javascript qui est exécuté une fois que l'action côté serveur a été exécutée,
  • ligne 17 : fait afficher [5]. Sur un clic, la boîte de dialogue est fermée et la personne n'est pas supprimée.

VI-Q. Exemple : mv-pf-14 : dataTable - 5

Ce projet montre qu'il est possible d'avoir un retour du serveur après exécution d'un appel AJAX. On utilise pour cela l'attribut oncomplete de l'appel AJAX :

Image non disponible

Le formulaire [index.xhtml] évolue comme suit :

[index.xhtml]
CacherSélectionnez
  • ligne 7 : l'attribut oncomplete appelle la fonction Javascript des lignes 13-18,
  • ligne 13 : la signature de la méthode doit être celle-ci. args est un dictionnaire que le modèle côté serveur peut enrichir,
  • ligne 15 : on regarde si le dictionnaire args a un attribut nommé 'msgErreur'. Si oui, il est affiché (ligne 16).

Dans le modèle, la méthode [retirerPersonne] évolue comme suit :

 
CacherSélectionnez
  • ligne 3 : on tire un nombre aléatoire 0 ou 1,
  • lignes 4-6 : si c'est 0, la personne sélectionnée par l'utilisateur est supprimée de la liste des personnes,
  • lignes 9 : sinon, on construit un message d'erreur internationalisé :
 
Sélectionnez
1.
2.
form.msgErreur=La personne n'a pu \u00eatre supprim\u00e9e. Veuillez r\u00e9essayer ult\u00e9rieurement.
form.msgErreur_detail=La personne n'a pu \u00eatre supprim\u00e9e. Veuillez r\u00e9essayer ult\u00e9rieurement.
  • ligne 10 : une instruction compliquée qui a pour but d'ajouter dans le dictionnaire args dont nous avons parlé, l'attribut nommé 'msgErreur' avec la valeur msgErreur construite ligne 9. Cet attribut est récupéré ensuite par la méthode Javascript de [index.xhtml] :
 
CacherSélectionnez

VI-R. Exemple : mv-pf-15 : la barre d'outils

Dans ce projet nous construisons une barre d'outils :

Image non disponible

La barre d'outils est le composant encadré ci-dessus. Elle est obtenue avec le code XHTML suivant [index.xhtml] :

 
CacherSélectionnez
  • lignes 15-22 : la barre d'outils,
  • lignes 16-18 : définissent le groupe de composants à gauche de la barre,
  • lignes 19-21 : idem pour les composants à droite.

Les composants à gauche de la barre d'outils sont les suivants :

 
CacherSélectionnez

Ils affichent la vue ci-dessous :

Image non disponible
  • ligne 2 : affiche [1],
  • ligne 3 : affiche un espace de 30 pixels [2],
  • lignes 4-6 : affichent une liste déroulante avec une liste de personnes [3],
  • ligne 7 : affiche un séparateur [4],
  • ligne 8 : affiche un bouton [5] chargé de supprimer la personne sélectionnée dans la liste déroulante. Le bouton a une icône. Ces icônes sont celles de JQuery UI. On trouve leur liste à l'URL [http://jqueryui.com/themeroller/] [6] :
    Image non disponible
  • pour connaître le nom d'une icône, il suffit de placer la souris dessus. Ensuite ce nom est utilisé dans l'attribut icon du composant <commandButton>, par exemple icon="ui-icon-trash". On notera que ci-dessus, le nom donné sera .ui-icon-trash et qu'on enlève le point initial de ce nom dans l'attribut icon,
  • ligne 9 : crée une bulle d'aide pour le bouton (attribut for). Lorsqu'on laisse le curseur sur le bouton, le message d'aide s'affiche [7].

Le modèle associé à ces composants est le suivant :

 
CacherSélectionnez

Les composants à droite de la barre d'outils sont les suivants :

 
CacherSélectionnez

Ils affichent la vue ci-dessous :

Image non disponible
  • lignes 6-9 : un bouton menu. Il contient des options de menu,
  • ligne 7 : l'option pour passer le formulaire en français,
  • ligne 8 : celle pour le passer en anglais.

VI-S. Conclusion

Nous en savons assez pour porter notre application exemple sur Primefaces. Nous n'avons vu qu'une quinzaine de composants alors que la bibliothèque en possède plus de 100. Le lecteur est invité à chercher le composant qui lui manque, directement sur le site de Primefaces.

VI-T. Les tests avec Eclipse

Les projets Maven sont disponibles sur le site des exemples [1] :

Image non disponible

Une fois importés dans Eclipse, on peut les exécuter [2]. On sélectionne Tomcat en [3]. Ils s'affichent alors dans le navigateur interne d'Eclipse [3].

Image non disponible

précédentsommairesuivant

Vous avez aimé ce tutoriel ? Alors partagez-le en cliquant sur les boutons suivants : Viadeo Twitter Facebook Share on Google+   

  

Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright © 2012 Serge Tahé. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.