Utiliser JavaFX dans IntelliJ et Eclipse
CS-108
Introduction
JavaFX est une bibliothèque Java de création d'interfaces utilisateur graphiques. JavaFX faisait initialement partie de la bibliothèque standard Java, mais est devenu par la suite un projet séparé. Pour cette raison, il est nécessaire d'installer JavaFX avant de pouvoir l'utiliser dans un projet, et ce document décrit la marche à suivre.
Installation de JavaFX
Pour installer JavaFX, il faut commencer par télécharger l'archive Zip contenant la version correspondant à votre système d'exploitation (Windows, macOS ou Linux). Pour cela, rendez-vous sur la page de téléchargement d'OpenJFX et choisissez, dans les menus déroulants :
- la version 18,
- le système d'exploitation que vous utilisez,
- si vous la connaissez, l'architecture de votre ordinateur,
- le type SDK.
Une fois l'archive téléchargée, décompressez-la dans un dossier de votre choix. Si vous avez déjà un dossier contenant tous les projets liés à ce cours (séries d'exercices, projet principal, etc.), il est conseillé d'y placer également JavaFX, afin de garder de l'ordre.
La décompression de l'archive devrait créer un dossier nommé javafx-sdk-18
contenant au moins deux sous-dossiers nommés legal
et lib
. Sur Windows, un sous-dossier bin
existe également.
Configuration d'IntelliJ
Une fois l'archive décompressée, il faut encore configurer IntelliJ pour qu'il ait connaissance de cette bibliothèque, puis ajouter la bibliothèque à tous les projets qui l'utilisent.
Ajout de la bibliothèque
Afin qu'il soit possible d'utiliser JavaFX dans des projets depuis IntelliJ, il faut l'ajouter sous la forme d'une bibliothèque globale (global library), de la manière suivante :
- dans le menu File, choisissez New Project Setup puis Structure…,
- dans la partie de gauche, cliquez sur Global Libraries dans la section nommée Platform Settings,
- dans la partie centrale, cliquez sur le bouton
+
en haut, puis choisissez Java dans le menu New Global Library qui s'ouvre, - naviguez vers le dossier
lib
créé lors de la décompression de l'archive et sélectionnez tous les fichiers qu'il contient (ceci est très important), - cliquez sur Open (ou équivalent),
- changez le nom de la bibliothèque ainsi créée en
OpenJFX 18
, en modifiant le champ situé à droite de l'étiquette Name:, - cliquez sur le bouton
+
situé sous l'étiquette Name:, - sélectionnez le fichier
src.zip
qui se trouve dans le dossier parent du dossierlib
, - cliquez sur Open (ou équivalent),
- cliquez OK dans la boîte de dialogue qui s'ouvre alors.
Une fois ces opérations effectuées, la fenêtre devrait avoir l'apparence suivante (les rectangles violets masquent la partie des chemins qui dépendent de votre système) :
![intellij-openjfx;64.png](i/intellij-openjfx;64.png)
Vous pouvez alors fermer la fenêtre en cliquant sur OK.
Utilisation de JavaFX dans un projet
Une fois la bibliothèque ajoutée à IntelliJ, il est possible de l'utiliser dans un projet quelconque de la manière suivante :
- dans le menu File, choisissez Project Structure…,
- dans la partie de gauche, cliquez sur Modules dans la section nommée Project Settings,
- dans la partie de droite, sélectionnez l'onglet Dependencies,
- dans la partie de droite toujours, cliquez sur le bouton
+
, puis choisissez l'entrée Library… du menu qui s'ouvre, - dans la fenêtre qui s'ouvre, choisissez OpenJFX 18, puis cliquez sur Add Selected.
Une fois ces opérations effectuées, la fenêtre devrait avoir l'apparence suivante :
![intellij-openjfx-proj;64.png](i/intellij-openjfx-proj;64.png)
Vous pouvez alors fermer la fenêtre en cliquant sur OK, et JavaFX devrait être utilisable dans votre projet. Pour le vérifier, vous pouvez y ajouter temporairement le programme suivant :
import javafx.scene.paint.Color; public final class CheckJavaFx { public static void main(String[] args) { Color c = Color.RED; System.out.println(c.getRed()); } }
Si vous arrivez à l'exécuter et qu'il affiche 1.0
, cela signifie que JavaFX est correctement installé.
Problèmes
Il est possible que lors de l'exécution de certains programmes JavaFX, l'erreur suivante s'affiche au démarrage :
Erreur : des composants d'exécution JavaFX obligatoires pour exécuter cette application sont manquants.
Pour le résoudre, il faut encore effectuer la manipulation suivante :
- dans le menu Run, choisissez Edit Configurations…,
- cliquez sur Modify options puis choisissez Add VM options pour faire apparaître le champ VM options,
- dans le champ intitulé VM options, ajoutez la ligne suivante, où
<chemin>
est le chemin complet du dossierlib
contenant JavaFX :
--module-path <chemin> --add-modules javafx.controls
Pour connaître le chemin en question, vous pouvez réouvrir la fenêtre dans laquelle la bibliothèque OpenJFX est définie (File > New Project Setup > Structure… puis Global Libraries) et regarder le chemin donné pour les fichiers dont le nom se termine par .jar
. Le chemin à utiliser ci-dessus est ce chemin-là, mais uniquement jusqu'au dossier lib
. Sur Windows, ce chemin commence probablement par C:\
, tandis que sur Linux et macOS, il commence probablement par /
.
Attention : si ce chemin contient au moins une espace, il faut impérativement le mettre entre guillemets ("
).
Configuration d'Eclipse
Une fois l'archive décompressée, il faut encore configurer Eclipse pour qu'il ait connaissance de cette bibliothèque, puis ajouter la bibliothèque à tous les projets qui l'utilisent.
Ajout de la bibliothèque
Afin de pouvoir utiliser JavaFX dans des projets Eclipse, il faut l'ajouter sous la forme d'une bibliothèque utilisateur (user library), de la manière suivante :
- dans le menu Eclipse (sur Mac) ou Window (autre), sélectionnez l'entrée Preferences,
- dans la fenêtre qui s'ouvre, déroulez l'onglet Java puis Build Path puis sélectionnez User Libraries,
- cliquez sur le bouton New… et entrez
OpenJFX 18
comme nom, avant de cliquer sur OK, - cliquez sur le bouton Add External JARs…,
- naviguez vers le dossier
lib
créé lors de la décompression de l'archive et sélectionnez tous les fichiers .jar qu'il contient, - cliquez sur Open (ou équivalent),
- sélectionnez l'élément Source attachment du premier des fichiers
.jar
(probablementjavafx-swt.jar
) puis cliquez sur le bouton Edit…, - dans la fenêtre qui s'ouvre, sélectionnez External location puis cliquez sur External File…,
- naviguez vers le dossier parent du dossier
lib
créé lors de la décompression de l'archive, sélectionnez le fichiersrc.zip
qu'il contient et cliquez sur Open (ou équivalent), - cliquez sur OK pour fermer la fenêtre Source Attachment Configuration,
- répétez les points 7 à 10 pour tous les autres fichiers
.jar
de JavaFX.
Une fois ces opérations effectuées, la fenêtre devrait avoir l'apparence suivante (les rectangles violets masquent la partie des chemins qui dépendent de votre système) :
![eclipse-openjfx;64.png](i/eclipse-openjfx;64.png)
Utilisation de JavaFX dans un projet
Une fois la bibliothèque ajoutée à Eclipse, il est possible de l'utiliser dans un projet quelconque de la manière suivante :
- dans le menu Project, choisissez Properties,
- sélectionnez Java Build Path dans la liste à gauche,
- cliquez sur l'onglet Libraries,
- sélectionnez Classpath, puis cliquez sur Add Library…,
- choisissez User Library puis cliquez sur Next,
- sélectionnez la bibliothèque
OpenJFX 18
puis cliquez sur Finish.
Pour vérifier que JavaFX est bien utilisable dans votre projet, vous pouvez y ajouter temporairement le programme suivant :
import javafx.scene.paint.Color; public final class CheckJavaFx { public static void main(String[] args) { Color c = Color.RED; System.out.println(c.getRed()); } }
Problèmes
Il est possible que lors de l'exécution de certains programmes JavaFX, l'erreur suivante s'affiche au démarrage :
Erreur : des composants d'exécution JavaFX obligatoires pour exécuter cette application sont manquants.
Pour le résoudre, il faut encore effectuer la manipulation suivante :
- dans l'explorateur de paquetages (Package Explorer), faites un clic droit sur la classe principale de votre application, puis sélectionnez l'entrée Run Configurations… du sous-menu Run As,
- dans la fenêtre qui s'ouvre, sélectionnez l'onglet Arguments,
- décochez la case Use the -XstartOnFirstThread argument when launching with SWT,
- dans le champ intitulé VM arguments, ajoutez la ligne suivante, où
<chemin>
est le chemin complet du dossierlib
contenant JavaFX :
--module-path <chemin> --add-modules javafx.controls
Pour connaître le chemin en question, vous pouvez réouvrir la fenêtre dans laquelle la bibliothèque OpenJFX est définie (Preferences > Java > Build Path > User Libraries) et regarder le chemin donné pour les fichiers dont le nom se termine par .jar
. Le chemin à utiliser ci-dessus est ce chemin-là, mais uniquement jusqu'au dossier lib
. Sur Windows, ce chemin commence probablement par C:\
, tandis que sur Linux et macOS, il commence probablement par /
.
Attention : si ce chemin contient au moins une espace, il faut impérativement le mettre entre guillemets ("
).