FAQ JavaFXConsultez toutes les FAQ

Pour sélectionner un répertoire, par exemple en réaction à un clic sur un bouton, il faut créer une instance de la classe javafx.stage.DirectoryChooser, qui permettra d'afficher une boite de dialogue de sélection de répertoires en invoquant sa méthode showDialog().

Par exemple :

1
2
3
4
5
6
7
8
final Button button = new Button("Cliquer"); 
button.setOnAction(actionEvent -> { 
    final DirectoryChooser dialog = new DirectoryChooser(); 
    final File directory = dialog.showDialog(button.getScene().getWindow()); 
    if (directory != null) { 
        // Effectuer le traitement. 
    } 
});

Pour sélectionner un fichier, par exemple en réaction à un clic sur un bouton, il faut créer une instance de la classe javafx.stage.FileChooser, qui permettra d'afficher une boite de dialogue de sélection de fichiers en invoquant sa méthode showOpenDialog() (pour l'ouverture) ou sa méthode showSaveDialog() (pour la sauvegarde).

Par exemple :

1
2
3
4
5
6
7
8
final Button button = new Button("Cliquer"); 
button.setOnAction(actionEvent -> { 
    final FileChooser dialog = new FileChooser(); 
    final File file = dialog.showSaveDialog(button.getScene().getWindow()); 
    if (file != null) { 
        // Effectuer la sauvegarde. 
    } 
});

Pour spécifier des filtres de fichiers, il faut créer de nouvelles instances de la classe javafx.stage.FileChooser.ExtensionFilter et les ajouter dans la liste observable extensionFilters de la boite de dialogue de sélection de fichiers.

Par exemple :

1
2
3
4
5
6
7
8
9
10
final Button button = new Button("Cliquer"); 
button.setOnAction(actionEvent -> { 
    final FileChooser dialog = new FileChooser(); 
    dialog.getExtensionFilters().setAll(new FileChooser.ExtensionFilter("Fichiers texte", "*.txt", "*.text"), 
            new FileChooser.ExtensionFilter("Tous les fichiers", "*.*")); 
    final File file = dialog.showSaveDialog(button.getScene().getWindow()); 
    if (file != null) { 
        // Effectuer la sauvegarde.  
    } 
});

Pour spécifier le filtre de fichiers par défaut, il faut modifier la valeur de la propriété selectedExtensionFilter de la boite de dialogue de sélection de fichiers.

Par exemple :

1
2
3
4
5
final FileChooser.ExtensionFilter textFilter = new FileChooser.ExtensionFilter("Fichiers texte", "*.txt", "*.text"); 
final FileChooser.ExtensionFilter rtfFilter = new FileChooser.ExtensionFilter("Document texte riche", "*.rtf"); 
final FileChooser.ExtensionFilter docFilter = new FileChooser.ExtensionFilter("Microsoft Word", "*.doc", "*.docx"); 
dialog.getExtensionFilters().setAll(textFilter, rtfFilter, docFilter); 
dialog.setSelectedExtensionFilter(rtfFilter);

Il est possible de spécifier le fichier par défaut en modifiant la valeur de la propriété initialFileName de la boite de dialogue de sélection de fichiers.

Les classes FileChooser et DirectoryChooser permettent toutes les deux de spécifier le répertoire initial dans lequel s'ouvre la boite de dialogue en modifiant la valeur de leur propriété initialDirectory avant d'afficher la boite de dialogue.

À partir du JDK8_40, JavaFX dispose d'une API permettant d'afficher et de manipuler des boites de dialogue. Cette API se compose de deux parties :

• une API de haut niveau qui permet de créer et d'afficher des boites de dialogue prêtes à l'emploi rapidement (message d'information, erreur, etc.) en utilisant les classes javafx.scene.control.Alert, javafx.scene.control.ChoiceDialog<R> et javafx.scene.control.TextInputDialog :
  
  • Alert - affiche des messages à l'utilisateur,
  • ChoiceDialog<R> - permet à l'utilisateur de choisir dans une plage de valeurs de type R,
  • TextInputDialog - permet à l'utilisateur de saisir du texte ;
    
• une API de bas niveau qui permet de construire ses propres boites de dialogue, spécifier les boutons à montrer, etc. en utilisant la classe javafx.scene.control.Dialog<R>.
  

La façon de récupérer le résultat d'une boite de dialogue de type Dialog<R> dépend de la manière dont vous l'avez affichée :

• showAndWait() - cette méthode est bloquante tant que la boite de dialogue ou l'alerte n'est pas fermée. Elle retourne alors une instance de type Optional<R> qui n'est jamais à la valeur null et qui contient la valeur de retour de la boite de dialogue ;
  
  Par exemple, dans le cas d'une alerte :
  
  

  Code Java :

  Sélectionner tout

  1
  2
  3
  4
  5
  6
  final Optional<ButtonType> result = alert.showAndWait();  
  result.ifPresent(button -> {  
      if (button == ButtonType.OK) {  
          [...]  
      }  
  });

  
  Ici, dans le cas d'une alerte, la valeur retournée est donc de type ButtonType. Lorsque la fenêtre de l'alerte est fermée sans utiliser de bouton de validation, c'est la valeur ButtonType.CLOSE qui est contenue dans le résultat optionnel.
  
  Dans certains cas, notamment lorsque votre boite de dialogue est amenée à construire ses propres réponses, la valeur contenue dans le résultat optionnel peut être null ;
• show() - cette méthode n'est pas bloquante et retourne immédiatement sans fournir de résultat. Le programmeur doit alors attacher un écouteur de type InvalidationListener ou ChangeListener sur la propriété result de la boite de dialogue.
  
  Par exemple, dans le cas d'une alerte :
  
  

  Code Java :

  Sélectionner tout

  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  alert.resultProperty().addListener(new ChangeListener<ButtonType>() { 
    
      @Override 
      public void changed(ObservableValue<? extends ButtonType> observableValue, ButtonType oldValue, ButtonType newValue) { 
          if (newValue == ButtonType.OK) {  
              [...] 
          } 
      } 
  }); 
  alert.show();

  
  Ou :
  
  

  Code Java :

  Sélectionner tout

  1
  2
  3
  4
  5
  6
  alert.resultProperty().addListener((ObservableValue<? extends ButtonType> observableValue, ButtonType oldValue, ButtonType newValue) -> { 
      if (newValue == ButtonType.OK) {  
          [...] 
      } 
  }); 
  alert.show();

Vous pouvez facilement afficher des boites de dialogue en manipulant la classe javafx.scene.control.Alert qui permet d'utiliser l'API de boites de dialogue de haut niveau.

Par exemple :

1
2
final Alert alert = new Alert(Alert.AlertType.NONE); 
alert.show();

• AlertType.CONFIRMATION - pour demander une confirmation à l'utilisateur ;
• AlertType.ERROR - pour rapporter une erreur ;
• AlertType.INFORMATION - pour afficher une information ;
• AlertType.NONE - boite de dialogue sans spécialisation particulière ;
• AlertType.WARNING - pour rapporter un avertissement.
  

1
2
3
4
5
6
7
8
9
10
11
final Alert alert = new Alert(Alert.AlertType.CONFIRMATION);  
alert.initOwner(stage); 
alert.setTitle("Demande de confirmation"); 
alert.setHeaderText("Un fichier du même nom existe déjà."); 
alert.setContentText("Souhaitez-vous écraser le fichier destination ?"); 
final Optional<ButtonType> result = alert.showAndWait(); 
result.ifPresent(button -> { 
    if (button == ButtonType.OK) { 
        [...] 
    } 
});

Vous pouvez facilement afficher des boites de dialogue contenant une liste de choix en manipulant la classe javafx.scene.control.ChoiceDialog<R>. Ce type de boites de dialogue affiche une liste déroulante contenant des objets de type R qui permet à l'utilisateur de sélectionner une valeur avant de valider la boite de dialogue avec le bouton « OK ».

Par exemple :

1
2
3
4
5
6
7
8
9
final List<Integer> seats = Arrays.asList(1, 2, 3, 4); 
final ChoiceDialog<Integer> dialog = new ChoiceDialog(seats.get(0), seats); 
dialog.setTitle("Réservation"); 
dialog.setHeaderText("Nombre de convives"); 
dialog.setContentText("Table pour"); 
final Optional<Integer> result = dialog.showAndWait(); 
result.ifPresent(guestNumber -> { 
    [...] 
});

Vous pouvez facilement afficher une zone de saisie en manipulant la classe javafx.scene.control.TextInputDialog. Ce type de boite de dialogue affiche champ d’édition qui permet à l'utilisateur de saisir une valeur avant de valider la boite de dialogue avec le bouton « OK ».

Par exemple :

1
2
3
4
5
6
7
8
final TextInputDialog dialog = new TextInputDialog();  
dialog.setTitle("Réservation");  
dialog.setHeaderText("Nombre de convives");  
dialog.setContentText("Table pour");  
final Optional<String> result = dialog.showAndWait();  
result.ifPresent(guestString -> {  
    [...]  
});

dialog.getEditor().setTextFormatter(integerOnlyFormatter);

Nous allons créer une boite de dialogue permettant à un utilisateur de saisir un identifiant et un mot de passe.

Commençons par initialiser la boite de dialogue. Dans cet exemple, le type de retour de notre boite de dialogue sera javafx.util.Pair<String, String>, une classe utilitaire qui permet de stocker deux valeurs, ici deux instances de la classe String (l'identifiant et le mot de passe).

1
2
3
final Dialog<Pair<String, String>> dialog = new Dialog(); 
dialog.setTitle("Connexion"); 
dialog.setHeaderText("Veuillez saisir vos identifiants");

1
2
3
// Définition des nouveaux types de bouton. 
final ButtonType loginButtonType = new ButtonType("Connexion", ButtonData.OK_DONE); 
dialog.getDialogPane().getButtonTypes().addAll(loginButtonType, ButtonType.CANCEL);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Création de l'IU. 
final GridPane gridPane = new GridPane(); 
gridPane.setHgap(6); 
gridPane.setVgap(6); 
gridPane.setPadding(new Insets(6)); 
final TextField username = new TextField(); 
username.setPromptText("Utilisateur"); 
final PasswordField password = new PasswordField(); 
password.setPromptText("Mot de passe"); 
gridPane.add(new Label("Utilisateur :"), 0, 0); 
gridPane.add(username, 1, 0); 
gridPane.add(new Label("Mot de passe :"), 0, 1); 
gridPane.add(password, 1, 1);     
dialog.getDialogPane().setContent(grid);

1
2
3
4
5
6
// Le bouton connexion reste désactivé tant que l'identifiant n'est pas correct. 
final Node loginButton = dialog.getDialogPane().lookupButton(loginButtonType); 
loginButton.setDisable(true); 
username.textProperty().addListener((observable, oldValue, newValue) -> { 
    loginButton.setDisable(newValue.trim().isEmpty()); 
});

1
2
// On place le focus sur le 1er champ de saisie. 
Platform.runLater(() -> username.requestFocus());

1
2
3
4
5
6
7
8
9
10
11
// Conversion du résultat lors de la validation du dialogue. 
dialog.setResultConverter(new Callback<ButtonType, Pair<String, String>>() { 
  
    @Override 
    public Pair<String, String> call(ButtonType dialogButton) { 
        if (dialogButton == loginButtonType) { 
            return new Pair<>(username.getText(), password.getText()); 
        } 
        return null; 
    } 
});

1
2
3
4
5
6
7
// Conversion du résultat lors de la validation du dialogue. 
dialog.setResultConverter(dialogButton -> { 
    if (dialogButton == loginButtonType) { 
        return new Pair<>(username.getText(), password.getText()); 
    } 
    return null; 
});

1
2
3
4
final Optional<Pair<String, String>> result = dialog.showAndWait(); 
result.ifPresent(usernamePassword -> { 
    [...]          
});