JList (4) : exemple d'un ListModel minimal

Ce code démontre l'utilisation de la classe AbstractListModel (ou même l'interface ListModel) pour implémenter un modèle personnalisé pour la JList.

Les trois exemples précédents (1, 2 et 3) se basaient sur l'utilisation de DefaultListModel. Cette dernière classe est une extension de la classe AbstractListModel qui utilise un Vector pour stocker le contenu de la liste. Il est possible de construire un modèle de données qui stocke le contenu dans une structure personnalisée.

ListModel

AbstractListModel

DefaultListModel

Le problème avec cette approche est la duplication du référence. Les objets contenants les données seront doublement référencés. Ainsi, il est possible dans des cas particulier de définir un modèle qui ne stocke et qui ne garde aucune référence. Il va déléguer ces opérations à une structure déjà disponible dans l'application.

Ce cas est un cas extrême et est présenté ici juste pour donner exemple sur les possibilités obtenues si on opte pour l'utilisation de AbstractListModel au lieu de DefaultListModel.

La classe de donnée utilisée dans cet exemple est une classe très simple qui définit trois attributs (id, nom, prénom) et qui offre une méthode toString pour permettre l'affichage. Une petite méthode "static" est ajoutée pour simuler une source de données externe.

class Donnee {
  
 int id;
 String nom;
 String prenom;
 
 public Donnee(int id, String nom, String prenom){
  this.id = id;
  this.nom = nom;
  this.prenom = prenom;
 }
 
 public int getId(){ return id; }
 public String getNom(){ return nom; }
 public String getPrenom(){ return prenom; }
 
 public String toString(){
  return "(" + id + ") " + nom + " " + prenom;
 }
 
 public static List<Donnee> creerDonnees(){
  ...
 }
 
}

Les données sont exposées, par la suite, dans une liste "static" accessible pour tout le monde (comme j'ai précisé, c'est un cas extrême pour montrer les fonctionnalités possibles).

 public static List<Donnee> DONNEES = Donnee.creerDonnees();

Le modèle développé va déléguer ses fonctionnalités à cette liste

class MonModele extends AbstractListModel<Donnee> {
 
 public int getSize(){
  return ExempleSimpleListModel.DONNEES.size();
 }
 
 public Donnee getElementAt(int indice){
  return ExempleSimpleListModel.DONNEES.get(indice);
 } 
}

Le code complet sera :

import javax.swing.*;
import java.awt.event.*;
import javax.swing.event.*;
import java.util.*;

public class ExempleSimpleListModel {
 
 public static List<Donnee> DONNEES = Donnee.creerDonnees();
 
 public static void main (String args[]) {
  
  (new MaFrame()).setVisible(true);
  
 }
}

class Donnee {
  
 int id;
 String nom;
 String prenom;
 
 public Donnee(int id, String nom, String prenom){
  this.id = id;
  this.nom = nom;
  this.prenom = prenom;
 }
 
 public int getId(){ return id; }
 public String getNom(){ return nom; }
 public String getPrenom(){ return prenom; }
 
 public String toString(){
  return "(" + id + ") " + nom + " " + prenom;
 }
 
 public static List<Donnee> creerDonnees(){
  List<Donnee> liste = new ArrayList<>();
  liste.add(new Donnee(1, "Wilhelm", "Conrad Röntgen"));
  liste.add(new Donnee(2, "Hendrik", "Lorentz"));
  liste.add(new Donnee(3, "Pieter", "Zeeman"));
  liste.add(new Donnee(4, "Antoine Henri", "Becquerel"));
  liste.add(new Donnee(5, "Piere", "Curie"));
  liste.add(new Donnee(6, "Marie", "Curie"));
  return liste;
 }
 
}

class MaFrame extends JFrame {
 
 JList liste;
 MonModele modele;
 
 public MaFrame(){
  
  setTitle("Exemple JList");
  setSize(250, 400);
  setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
  
  modele = new MonModele();
  liste = new JList(modele);
  
  getContentPane().add(new JScrollPane(liste));
  
 }
  
}

class MonModele extends AbstractListModel<Donnee> {
 
 public int getSize(){
  return ExempleSimpleListModel.DONNEES.size();
 }
 
 public Donnee getElementAt(int indice){
  return ExempleSimpleListModel.DONNEES.get(indice);
 } 
}

Résultat :

JList (3) : utilisation d'un écouteur (Listener) sur le modèle

Après la présentation d'un premier exemple simple (ici) qui montre la séparation entre la Vue et le Modèle dans les composants Swing et d'un deuxième exemple (ici) qui montre l'utilisation d'un Listener "logique" qui récupère les actions de l'utilisateur, cet article vise à montrer l'utilisation d'un Listener sur le modèle, c'est-à-dire, détecter qu'un changement a eu lieu dans le modèle de donnée.

Malgré qu'un tel écouteur peut être utilisé pour détecter des changements effectués par l'utilisateur, le plus intéressant est de l'utiliser pour détecter des changements appliqués par d'autres programmes ou bien d'autres threads.

Ainsi, pour cet article, deux classes seront nécessaires :

• La fenêtre qui contiendra la liste et son modèle. Pour simplifier l'exemple, le modèle sera exposé via un simple getter.
• Un "autre programme" qui simule une source externe du changement effectué sur le modèle de la liste.

L'écouteur sur un modèle de données ne cherche pas à détecter des actions de l'utilisateur. Mais, il se concentre sur les changements possibles des données. Ainsi, l'écouteur (Listener) ListDataListener propose trois méthodes :

• intervalAdded
• intervalRemoved
• contentsChanged

Les deux premières permet de récupérer les événements simples, le troisième sert à récupérer des changements du contenu du modèle.

ListDataListener (JDK 7)

Les trois méthodes reçoivent le même objet événement : ListDataEvent

ListDataEvent

Si ce dernier ne cache pas les données changées, il garde les positions (début/fin) des intervalles affectées par le changement. Par la suite, il est possible de récupérer les données à partir du modèle lui-même.

Pour pouvoir utiliser directement ces fonctionnalités, il faut faire appel au moins à la classe AbstractListModel, d'ailleurs, c'est la valeur ajoutée principale de cette classe par rapport à l'interface de base ListModel. Autrement, tous les mécanismes internes doivent être implémentées (chose qui n'est pas vraiment difficile après tout).

ListModel

AbstractListModel

Revenons à notre exemple. Il se compose de trois classes :

• Une classe qui simule un programme externe qui change les données. Elle ajoute une donnée à partir d'une position aléatoire d'un tableau qui contient "quelques données".
• Une fenêtre qui continent la liste et qui expose le modèle de la liste. Cette classe constitue aussi l'écouteur ListDtaListener. en recevant une nouvelle valeur, le texte d'une JLabel est mis à jour.
• La classe qui contient le main crée une instance de chaque classe et les passe à deux thread séparés. Pour une meilleure visibilité, l'ajout des valeurs aléatoires s'effectue à des intervalles de 2 seconds. 

Ainsi, le code essentiel de la première classe :

class MonDeuxiemeProgramme {
 
 MaFrame frameAttachee;
 String[] quelquesDonnees = ...;

 public MonDeuxiemeProgramme(MaFrame frame){
  frameAttachee = frame;
 }
 
 public void ajouterElementAleatoire(){
  Random r = new Random();
  int valeur = r.nextInt(26);
  
  frameAttachee.getModele().addElement(quelquesDonnees[valeur]);
 }
 
}

Le code essentiel de la deuxième classe :

class MaFrame extends JFrame implements ListDataListener {

 JList liste;
 DefaultListModel modele;
 
 ...
 
 public MaFrame(){
  
  setTitle("Exemple JList");
  setSize(800, 400);
  setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
  
  modele = new DefaultListModel();
  modele.addListDataListener(this);
  liste = new JList(modele);
  
  creerInterface();
  
 }
 
 public void creerInterface(){
  ...
 }
 
 public void intervalAdded(ListDataEvent e){
  lblMessage.setText("Ajout à la position " + e.getIndex0() + " (" + modele.get(e.getIndex0()) + ")");
 }
 
 public DefaultListModel getModele(){
  return modele;
 }
 
 public void intervalRemoved(ListDataEvent e){}
 
 public void contentsChanged(ListDataEvent e){}

} 

Le code complet :

import javax.swing.*;
import java.awt.*;
import java.awt.event.*;
import javax.swing.event.*;
import java.util.*;

public class ExempleEvenementModelJList {
 
 public static void main (String args[]) {
  
  MaFrame frame = new MaFrame();
  MonDeuxiemeProgramme autre = new MonDeuxiemeProgramme(frame);
  
  Thread t1 = new Thread(new Runnable(){
   
   public void run(){
    frame.setVisible(true);
   }
   
  });
  
  Thread t2 = new Thread(new Runnable(){
   
   public void run(){
    while(true){
     try{
      Thread.sleep(2000);
      autre.ajouterElementAleatoire();
     }catch(Exception e){}
    }
   }
   
  });
  
  t1.start();
  t2.start();
  
 }
}

class MaFrame extends JFrame implements ListDataListener {

 JList liste;
 JScrollPane scroll;
 DefaultListModel modele;
 
 JLabel lblMessage;
 
 JPanel pnlDroite;
 JPanel pnlGauche;
 
 public MaFrame(){
  
  setTitle("Exemple JList");
  setSize(800, 400);
  setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
  
  modele = new DefaultListModel();
  modele.addListDataListener(this);
  liste = new JList(modele);
  
  creerInterface();
  
 }
 
 public void creerInterface(){
  
  lblMessage = new JLabel("Pas d'élément pour le moment");
  lblMessage.setBounds(20, 20, 450, 30);
  
  pnlDroite = new JPanel();
  pnlDroite.setLayout(null);
  pnlDroite.add(lblMessage);
  pnlDroite.setPreferredSize(new Dimension(480, 360));
  
  scroll = new JScrollPane(liste);
  scroll.setBounds(0, 0, 250, 360);
  
  pnlGauche = new JPanel();
  pnlGauche.setLayout(null);
  pnlGauche.add(scroll);
  pnlGauche.setPreferredSize(new Dimension(280, 360));
  
  getContentPane().setLayout(new FlowLayout());
  getContentPane().add(pnlGauche);
  getContentPane().add(pnlDroite);
  
 }
 
 public void intervalAdded(ListDataEvent e){
  lblMessage.setText("Ajout à la position " + e.getIndex0() + " (" + modele.get(e.getIndex0()) + ")");
 }
 
 public DefaultListModel getModele(){
  return modele;
 }
 
 public void intervalRemoved(ListDataEvent e){}
 
 public void contentsChanged(ListDataEvent e){}

} 

class MonDeuxiemeProgramme {
 
 MaFrame frameAttachee;
 String[] quelquesDonnees = new String[]{"Alfa",
  "Bravo", "Charlie", "Delta", "Echo", "Foxtrot", "Golf",
  "Hotel", "India", "Juliett", "Kilo", "Lima", "Mike",
  "November", "Oscar", "Papa", "Quebec", "Romeo", "Sierra",
  "Tango", "Uniform", "Victor", "Whiskey", "X-ray", "Yankee",
  "Zulu"};
 
 public MonDeuxiemeProgramme(MaFrame frame){
  frameAttachee = frame;
 }
 
 public void ajouterElementAleatoire(){
  Random r = new Random();
  int valeur = r.nextInt(26);
  
  frameAttachee.getModele().addElement(quelquesDonnees[valeur]);
 }
 
}

Résultat après quelques seconds :

JList (2) : Exemple avec écouteur (Listener) sur la liste elle-même

Ce code montre l'utilisation d'un écouteur (Listener) sur la liste elle-même pour détecter et gérer l'interaction entre cette dernière et l'utilisateur.

Ce code est le deuxième dans une série d'articles qui montrent l'utilité u modèle MVC respecté par les composants Swing et qui devient nécessaire pour les composants qui affichent plusieurs données.

Un premier exemple (avec une explication détaillée sur la création d'une JList avec un DefaultListModel) se trouve ici.

Dans ce deuxième code, la liste est associée à un écouteur pour surveiller les actions de sélection et de désélection des éléments de la liste.

Trois mode de sélection peuvent être définis pour une liste. La méthode setSelectionMode() prend un entier qui détermine le mode. Pour simplifier l'utilisation, les trois valeurs sont déclarées comme des constantes dans la classe ListSelectionModel avec des noms assez parlants. Elles sont :

• ListSelectionModel.SINGLE_SELECTION 
• ListSelectionModel.SINGLE_INTERVAL_SELECTION
• ListSelectionModel.MULTIPLE_INTERVAL_SELECTION

ListSelectionMode (JDK 7)

Dans cet exemple, deux modes seront démontrés.

Pour pouvoir récupérer les changements dans la sélection, il suffit d'ajouter un ListSelectionListener. Ce dernier définit une seule méthode : public void valueChanged(ListSelectionEvent e). Malgré que l’événement ListSelectionEvent permet de récupérer toutes les informations utiles sur le changement dans la sélection, il est possible de faire appel à des méthodes dans la classe JList directement.

ListSelectionEvent

Néanmoins, les méthodes à appeler dépendent du modèle de sélection utilisé. En effet, si le mode de sélection est "SINGLE_SELECTION" alors il n'est pas pratique de faire appel aux méthodes qui récupèrent "la liste des éléments sélectionnés".

Pour basculer entre les deux modes de sélection démontrer, deux JRadioButton sont utilisés. Les deux sont associés à un écouteur (ChangeListener) pour surveiller le changement de la sélection et ainsi changer le mode de sélection de la liste.

ChangeListener

JRadioButton

Ainsi la partie la plus importante du code est :

 public void valueChanged(ListSelectionEvent e){
  if(uniqueSelection){
   
   int indice = liste.getSelectedIndex();
   
   if(indice != -1){
    String valeur = (String)liste.getSelectedValue();
    lblSelection.setText(valeur + "(" + indice + ")");
   }
   
  }else{
   
   int[] indices = liste.getSelectedIndices();
   List<String> valeurs = liste.getSelectedValuesList();
   
   String message = "";
   for(int i = 0; i < valeurs.size(); i++){ 
    message += valeurs.get(i) + "(" + indices[i] + ") ";
   }
   lblSelection.setText(message);
   
  }
 }

Le code complet :

import javax.swing.*;
import javax.swing.event.*;
import java.awt.*;
import java.awt.event.*;
import java.util.List;

public class ExempleSelectionJList 
  extends JFrame 
   implements ChangeListener, ListSelectionListener{
 
 JList liste;
 DefaultListModel<String> modele;
 
 String[] quelquesDonnees = new String[]{"Alfa",
  "Bravo", "Charlie", "Delta", "Echo", "Foxtrot", "Golf",
  "Hotel", "India", "Juliett", "Kilo", "Lima", "Mike",
  "November", "Oscar", "Papa", "Quebec", "Romeo", "Sierra",
  "Tango", "Uniform", "Victor", "Whiskey", "X-ray", "Yankee",
  "Zulu"};
 
 JRadioButton rdoUnique, rdoMultiple;
 ButtonGroup groupe;
 boolean uniqueSelection;
 
 JLabel lblSelection;
 JPanel pnlAjouter;
 
 public ExempleSelectionJList(){
  
  setTitle("Exemple Simple JList");
  setSize(800, 400);
  setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
  
  modele = new DefaultListModel();
  liste = new JList(modele);
  liste.addListSelectionListener(this);
  
  creerFormulaire();
  remplirListe();
  
  getContentPane().add(pnlAjouter, BorderLayout.CENTER);
  getContentPane().add(new JScrollPane(liste), BorderLayout.WEST);
  
 }
 
 public void creerFormulaire(){
  
  rdoUnique = new JRadioButton("Choix Unique");
  rdoUnique.setBounds(20, 20, 150, 30);
  rdoMultiple = new JRadioButton("Choix Multiple");
  rdoMultiple.setBounds(190, 20, 150, 30);
  
  rdoUnique.addChangeListener(this);
  rdoMultiple.addChangeListener(this);
  
  groupe = new ButtonGroup();
  groupe.add(rdoUnique);
  groupe.add(rdoMultiple);
  
  rdoUnique.setSelected(true);
  uniqueSelection = true;
  
  lblSelection = new JLabel("La sélection s'affiche ici");
  lblSelection.setBounds(20, 70, 450, 30);
  
  
  pnlAjouter = new JPanel();
  pnlAjouter.setLayout(null);
  pnlAjouter.add(rdoUnique);
  pnlAjouter.add(rdoMultiple);
  pnlAjouter.add(lblSelection);
  
 }
 
 public void remplirListe(){
  for(int i = 0; i < quelquesDonnees.length; i++)
   modele.addElement(quelquesDonnees[i]);
 }
 
 public void valueChanged(ListSelectionEvent e){
  if(uniqueSelection){
   
   int indice = liste.getSelectedIndex();
   
   if(indice != -1){
    String valeur = (String)liste.getSelectedValue();
    lblSelection.setText(valeur + "(" + indice + ")");
   }
   
  }else{
   
   int[] indices = liste.getSelectedIndices();
   List<String> valeurs = liste.getSelectedValuesList();
   
   String message = "";
   for(int i = 0; i < valeurs.size(); i++){ 
    message += valeurs.get(i) + "(" + indices[i] + ") ";
   }
   lblSelection.setText(message);
   
  }
 }
 
 public void stateChanged(ChangeEvent e){
  uniqueSelection = rdoUnique.isSelected();
  if(uniqueSelection)
   liste.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
  else
   liste.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
 }
 
 public static void main (String args[]) {
  
  (new ExempleSelectionJList()).setVisible(true);
 }
}

Quelques résultats :

JList (1) : un premier exemple simple

Ce code présente un exemple très simple pour créer et ajouter des éléments à une JList.

Ce code a été créé comme un premier code dans une (petite) série pour mettre l'accent sur l'utilisation des modèles tels que définis par  l'approche MVC, cette dernière qui est respectée par les composants Swing en comparaison avec les composants AWT.

Si la manipulation du modèle (donnée) associé à un composant simple comme JTextField, ce n'est pas de même pour les composants qui affichent plusieurs données tels que JComboBox, JList et JTable.

Dans cette série, JList sera choisie pour démontrer quelques fonctionnalités.

Dans cet premier code, une JList est créé en se basant sur DefaultListModel. En effet, les différents modèles sont disponibles comme des interfaces.

ListModel (JDK 7)

Pour simplifier leur utilisation (garantir les fonctionnalités de base communes), une classe abstraite qui implémente le minimum des fonctionnalités est livrée. Cela est valide pour tous les modèles des données pour les autres composants. Pour le cas de la JList, la classe abstraite est AbstractListModel :

AbstractListModel (JDK 7)

Néanmoins, l'interface et la classe abstraite ne donnent aucune implémentation réelle qui supportent la sauvegarde des données et qui est prête pour être utilisée. C'est pourquoi, une implémentation par défaut est livrée. Cela aussi est valide pour les autres modèles des données des autres composants Swing. Pour la JList, la classe par défaut est DefaultListModel (c'est très explicit comme noms de classes) :

DefaultListModel (JDK 7)

Cette dernière utilise un Vector pour stocker les données :

private Vector delegate = new Vector();

Code source de DefaultListModel

Le code suivant, montre comment créer une JList avec un DefaultListModel. Le code de création des autres composants graphiques est séparé. Le bouton permet d'ajouter la valeur saisie dans le champs à la liste (à gauche) :

Code source :

import javax.swing.*;
import java.awt.*;
import java.awt.event.*;

public class ExempleSimpleJList extends JFrame implements ActionListener {
 
 JList liste;
 DefaultListModel modele;
 
 JLabel lblNouveau;
 JTextField txtNouveau;
 JButton btnAjouter;
 JPanel pnlAjouter;
 
 public ExempleSimpleJList(){
  
  setTitle("Exemple Simple JList");
  setSize(800, 400);
  setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
  
  modele = new DefaultListModel();
  liste = new JList(modele);
  
  creerFormulaire();
  
  getContentPane().add(pnlAjouter, BorderLayout.CENTER);
  getContentPane().add(new JScrollPane(liste), BorderLayout.WEST);
  
 }
 
 public void actionPerformed(ActionEvent e){
  modele.addElement(txtNouveau.getText());
 }
 
 public void creerFormulaire(){
  
  lblNouveau = new JLabel("Nouveau Element :");
  lblNouveau.setBounds(20, 20, 150, 30);
  txtNouveau = new JTextField();
  txtNouveau.setBounds(190, 20, 150, 30);
  btnAjouter = new JButton("Ajouter");
  btnAjouter.setBounds(20, 70, 150, 30);
  btnAjouter.addActionListener(this);
  
  pnlAjouter = new JPanel();
  pnlAjouter.setLayout(null);
  pnlAjouter.add(lblNouveau);
  pnlAjouter.add(txtNouveau);
  pnlAjouter.add(btnAjouter);
  
 }
 
 public static void main (String args[]) {
  
  (new ExempleSimpleJList()).setVisible(true);
 }
}

Résultat :

Pratique sur les boucles : Afficher les multiples d'un nombre

Énoncé 

Ecrire un algorithme qui affiche le nombre des entiers qui sont des multiples de 3 et inférieur à un nombre n donné par l'utilisateur.

Solution(s)

Plusieurs solutions peuvent être données. Il s'agit d'un autre exercice très classique pour commencer avec les boucles.

Premièrement, nous pouvons voir qu'il y a une borne supérieure à ne pas dépasser. Cela veut dire que le nombre d'itérations est connu et la boucle "Pour" peut être utilisée (toute boucle peut être écrite sous la forme Tant Que).

Ainsi, la solution la plus simple et la plus intuitive sera composée de :

• Une boucle qui parcours les valeurs jusqu'à n,
• Une structure conditionnelle pour vérifier est ce qu'il s'agit d'un multiple de 3 pour l'afficher.

En Pascal :

Program AfficherMultiples3;

Var 
 n, i : Integer;

Begin
 
 WriteLn('Faites entrer la limite n :');
 ReadLn(n);
 
 For i := 0 to n Do
  If (i mod 3 = 0) Then
  WriteLn(i, ' est un multiple de 3');
  
 ReadLn;
 
 
End.

En Java :

import java.util.Scanner;

public class AfficherMultiples3 {
 
 public static void main (String args[]) {
  
  System.out.println("(Java) Faites entrer la limite n :");
  
  Scanner entree = new Scanner(System.in);
  int n = entree.nextInt();
  
  for(int i = 0; i <= n; i++)
   if(i % 3 == 0)
    System.out.println(i + " est un multiple de 3");
  
 }
 
}

Le résultat d'exécution est exactement le même pour les deux codes :

D'habitude, l'étape suivante est de montrer que même avec ce petit code, on arrive à l'optimiser. En effet, pourquoi parcourir toutes les valeurs et faire le test pour chaque valeur. Il est possible de ne parcourir que les valeurs désirées, c'est à dire, il est possible de parcourir les multiples de 3 seulement. L'idée réside dans le pas effectué par la boucle Pour à chaque itération.

En Pascal (j'utilise fpc qui ne supporte pas des pas dans la boucles For, alors je suis obligé de passer à la boucle While):

Program AfficherMultiples3;

Var 
 n, i : Integer;

Begin
 
 WriteLn('Faites entrer la limite n :');
 ReadLn(n);
 
 i := 0;
 While(i <= n)Do
 Begin
  WriteLn(i, ' est un multiple de 3');
  i := i + 3; { Le compteur change par 3 à chaque fois }
 End;
  
 ReadLn;
 
 
End.

En Java :

import java.util.Scanner;

public class AfficherMultiples3 {
 
 public static void main (String args[]) {
  
  System.out.println("(Java) Faites entrer la limite n :");
  
  Scanner entree = new Scanner(System.in);
  int n = entree.nextInt();
  
  for(int i = 0; i <= n; i+=3 /* le pas est 3 */)
   System.out.println(i + " est un multiple de 3");
  
 }
 
}

Ces deux codes donnent exactement les mêmes résultats mais dans un temps d'exécution plus court.