Java JSF

Enumération en JSF

Interface de saisie WEB pour un enum

Exemple d’une interface en JSF pour saisir un type enum Java

Depuis Java 5, nous disposons d’un nouveau type de donnée, les énumérations. Ce type permet de définir une valeur à partir d’une liste prédéfinie. Un bon choix de composants de saisie pourrait être l’utilisation de boutons radio. Voyons comment réaliser cela en WEB avec des composants JSF .

Sommaire

Présentation

Cet exemple montre l’utilisation de boutons radios dans une interface web/JSF pour saisir une donnée de type enum Java. Pour cela nous allons créer une petite application web qui sera principalement composée de la définition d’un type enum, un fichier d’interface xhtml et d’un bean de gestion de l’interface. L’application aura pour but de sélectionner l’un des 7 jours de la semaine.

Définition de l’énumération

Le type enum définit les 7 jours de la semaine. Ce qui correspond au code suivant :

package testjsf.metier;
public enum JourSemaine
{
LUNDI, MARDI, MERCREDI, JEUDI, VENDREDI, SAMEDI, DIMANCHE;
}

Télécharger

Définition du Bean de gestion de la page JSF

Définissons maintenant un bean de gestion de la page JSF :

@Named
@RequestScoped
public class TestSaisieEnumView
{
public JourSemaine[] getJoursSemaine()
{
return JourSemaine.values();
}
@PostConstruct
public void init()
{
jour = JourSemaine.LUNDI;
}
@Getter @Setter private JourSemaine jour;
}

Télécharger

Cette classe définie un attribut jour de type JourSemaine qui sera la données à saisir. La méthode getJoursSemaine() renvoi un tableau contenant la liste composant l’énumération. La méthode init() permet de définir une valeur par défaut pour le jour à sélectionner.

Remarque : les annotaions @Getter/@Setter sont fournies par la librairie lombok que j’utilise dans mes projets pour éviter d’avoir à définir les méthodes Get/Set.

Définition du fichier xhtml

Il ne reste plus qu’à définir l’interface dans un fichier xhtml :

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"
      xmlns:h="http://xmlns.jcp.org/jsf/html"
      xmlns:f="http://xmlns.jcp.org/jsf/core">
  <h:head>
    <title>Exemple Enum/JSF</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
  </h:head>
  <h:body>
    <h1>Formulaire de saisie d'un Enum Java</h1>
    <h:form>
      <fieldset>
        <legend>Choix du jour de la semaine</legend>
        <h:selectOneRadio id="jour" value="#{testSaisieEnumView.jour}">
          <f:selectItems value="#{testSaisieEnumView.joursSemaine}" />        
        </h:selectOneRadio>
      </fieldset>
      <br />
      <h:commandButton value="Valider" />
      <br /><br /><hr /><br />
      <h:outputText value="Vous avez choisi: #{testSaisieEnumView.jour}" />
    </h:form>
  </h:body>
</html>

Le composant de sélection est la balise :

<h:selectOneRadio id="jour" value="#{testSaisieEnumView.jour}">

  <f:selectItems value="#{testSaisieEnumView.joursSemaine}" />

</h:selectOneRadio>

L’attribut value fait référence à la variable à saisir.

Le rôle de la balise <f:selectItems> est chargé de créer un bouton radio pour chaque élément de l’énumération fournie par la méthode getJourSemaine().

Le reste du code ne sert que pour la mise en page et pour afficher le choix après un clique sur le bouton.

Voici l’écran :

Définir un libellé pour les boutons radio

Par défaut, les libellés correspondent aux noms de chaque énumération. On pourrait souhaiter définir un libellé différent pour chaque élément. Comme en Java, les énumérations sont des classes, il est possible de définir des attributs, des méthodes et un constructeur. Nous allons donc ajouter un attribut libelle, un constructeur pour initialiser chaque objet puis, redéfinir la méthode toString(). Ce qui donne le code suivant :

public enum JourSemaine
{
LUNDI( "lundi"),
MARDI("mardi"),
MERCREDI( "mercredi" ),
JEUDI( "jeudi" ),
VENDREDI( "vendredi" ),
SAMEDI( "samedi" ),
DIMANCHE( "dimanche" );
private JourSemaine( String libelle )
{
this.libelle = libelle;
}
@Override public String toString()
{
return libelle;
}
private final String libelle;
}

Télécharger

Nous n’avons rien d’autre à faire. Les libellé seront pris en compte automatiquement grâce à la méthode toString() qui a été redéfinie.

Remarque : Les constructeurs dans le cas d’énumérations sont implicitement privés puisque l’on ne peut pas créer de nouveaux élément (instance) dans une énumérations. Je n’ai rajouté le mot clé "private" que dans un but de clarté.

Après mise à jour, l’affichage donne le résultat suivant :

Conclusion

Nous venons de voir dans ce petit exemple, qu’il était très simple d’utiliser le type enum dans une application JSF. Cet exemple nous a permis de vérifier que les énumérations Java ne sont pas de simples alias sur des entiers comme dans d’autre langages (comme C# par exemple), mais de véritables objets.

Ressources utilisées : Poste Ubuntu 14.04, Netbeans 8,1, Glassfish 4.1, lombok.

Développement

Article n° 81

Crée par: chris

Créé le: 8 décembre 2016

Modifié le: 8 décembre 2016

Nombre de visites: 970

Popularité: 9 %

Popularité absolue: 1

Java EE et développement Web

Mots clés de cet article

Java39