Interface de recherche de voyages

3.1.1. Conseils de programmation

1. Fenêtre contenant les résultats
   

   La fenêtre contenant les résultats de la requête est une instance de Popup dont on a désactivé la disapparition lorsque la touche d'échappement est pressée, au moyen de setHideOnEscape.

   Son contenu, défini en modifiant la liste retournée par getContent, est constitué d'une unique instance de ListView<String> qui montre les résultats de la requête. Cette instance de ListView est configurée de manière à ce qu'elle ne soit pas « traversable » (avec setFocusTraversable) et que sa hauteur maximale soit de 240 unités (avec setMaxHeight).

2. Valeur observable contenant le nom de l'arrêt
   

   Comme cela a été dit ci-dessus, la valeur observable contenant le nom de l'arrêt ne doit changer que lorsque le champ textuel devient inactif, et elle doit contenir soit le nom de l'arrêt sélectionné, soit une chaîne vide si aucun arrêt ne correspond à la requête.

   Ces conditions interdisent l'utilisation directe de la propriété textProperty du champ textuel comme valeur observable. Il faut donc créer une propriété séparée et la modifier de manière à respecter les contraintes susmentionnées.

3. Champ textuel
   

   Le champ textuel contenant la requête (lorsqu'il est actif) ou le nom de l'arrêt sélectionné (lorsqu'il est inactif) doit être configuré de deux manières.

   D'une part, un gestionnaire d'événement doit lui être ajouté, au moyen de addEventHandler, afin de détecter les pressions (KEY_PRESSED) sur les touches du curseur permettant le déplacement vers le haut (UP) et vers le bas (DOWN). Lorsqu'un tel événement est détecté, et que la sélection de la liste des arrêts peut être déplacée vers l'élément précédent (pour UP) ou suivant (pour DOWN), alors elle doit l'être, et l'événement doit être consommé (consume) afin de ne pas être traité par le gestionnaire par défaut du champ textuel — ce qui déplacerait le curseur.

   D'autre part, la propriété focusedProperty de ce champ doit être observée afin de déterminer quand le champ est actif (focused) ou non.

   Lorsque le champ devient actif, la fenêtre contenant les résultats doit devenir visible (show), et deux valeurs observables doivent alors être observées :

   1. la propriété textProperty du champ textuel, afin de détecter les changements de la requête et mettre à jour la liste des résultats en fonction,
   2. la propriété boundsInLocalProperty du champ textuel, dont la valeur doit être d'abord transformée dans le système de coordonnées de l'écran au moyen de localToScreen puis utilisée pour ancrer — c.-à-d. positionner —, au moyen de setAnchorX et setAnchorY, la fenêtre contenant les résultats pour qu'elle se trouve alignée à gauche et juste sous le champ textuel.

   Lorsque le champ devient inactif, les deux valeurs observables susmentionnées ne doivent plus être observées, la fenêtre montrant les résultats doit être cachée, et le nom de l'arrêt actuellement sélectionné doit être copié dans le champ textuel et dans la propriété décrite ci-dessus.

3.2.1. Graphe de scène

Le graphe de scène de l'interface de requête est présenté dans la figure ci-dessous.

Les instances de Label visibles dans cette figure correspondent aux étiquettes textuelles qui se trouvent à gauche des différents champs. Le texte qui leur est associé est :

• Départ : pour le champ de l'arrêt de départ,
• Arrivée : pour le champ de l'arrêt d'arrivée,
• Date : pour le champ de la date de voyage,
• Heure : pour le champ de l'heure de voyage.

Notez que, conformément aux règles typographiques suisses, les deux-points dans ces chaînes sont précédés d'une espace fine insécable, dont le code Unicode est 202F₁₆.

En Java, un moyen simple d'intégrer une espace fine insécable à une chaîne est d'utiliser la séquence d'échappement Unicode \u202f. Ainsi, la chaîne pour le champ de l'arrêt de départ peut s'écrire :

"Départ\u202f:"

3.2.2. Conseils de programmation

1. Invites
   

   Comme expliqué dans l'introduction, les champs textuels permettant de choisir les arrêts de départ et d'arrivée contiennent un texte d'invite (prompt text) lorsqu'ils sont vides. Ce texte peut leur être attaché au moyen de la méthode setPromptText.

2. Formatage de l'heure
   

   Contrairement aux autres champs textuels, celui permettant d'entrer l'heure de départ ne contient pas à proprement parler une chaîne, mais une valeur de type LocalTime représentée sous forme de chaîne. Dès lors, la valeur contenue dans ce champ doit être transformée en chaîne au moment de l'affichage, et la chaîne entrée par l'utilisateur transformée en valeur de type LocalTime.

   JavaFX permet de faire ce genre de transformations relativement facilement au moyen d'un formateur de texte de type TextFormatter attaché au champ textuel. Pour celui dont il est question ici, ce formateur peut être une valeur de type LocalTimeStringConverter configurée de manière à ce que les heures soient toujours affichées avec deux chiffres — p. ex. 09:30 pour 9h30 — mais qu'il soit possible de les entrer avec un chiffre seulement — p. ex. 9:30. Pour ce faire, il convient de passer deux instances de DateTimeFormatter différentes au constructeur de LocalTimeStringConverter : la première utilisée pour transformer une heure en chaîne, la seconde utilisée pour transformer une chaîne en une heure.

   Lorsqu'un formateur de texte est ainsi attaché à un champ textuel, la propriété à utiliser pour obtenir ou modifier la valeur non textuelle, ici de type LocalTime, est la propriété valueProperty du formateur.

3.3.1. Graphe de scène

Le graphe de scène du programme principal est présenté dans la figure ci-dessous. L'instance de Scene se trouvant à la racine de ce graphe est celle à utiliser comme « scène » principale du programme, c.-à-d. qu'elle doit être attachée à la fenêtre principale de l'application, passée à la méthode start.

3.3.2. Conseils de programmation

1. Chargement des données horaires
   

   Pour que les données horaires soient chargées depuis le sous-dossier timetable du dossier courant, il faut passer à la méthode in de FileTimeTable le chemin d'accès suivant :

   Path.of("timetable")
   

2. Voyages observables
   

   Un des buts principaux de la méthode start est de créer la valeur observable de type ObservableValue<List<Journey>>, qui contient les voyages à afficher et qui doit être passée à la vue d'ensemble des voyages. Cette valeur observable dépend bien entendu des valeurs observables exportées par l'interface de recherche, à savoir : l'arrêt de départ, l'arrêt d'arrivée et la date du voyage.

   En JavaFX, une valeur observable dont la valeur dépend de plusieurs autres valeurs observables peut être définie relativement aisément au moyen de la méthode createObjectBinding de Bindings. Cette méthode prend en premier argument une lambda qui ne prend pas d'arguments mais calcule la valeur observable, et ensuite toutes les dépendances, c.-à-d. les valeurs observables utilisées dans ce calcul.

   Par exemple, pour créer une valeur observable o3 dont le contenu est la concaténation de deux chaînes observables o1 et o2, on peut procéder ainsi :

   ObservableValue<String> o1 = …;
   ObservableValue<String> o2 = …;
   ObservableValue<String> o3 = Bindings.createObjectBinding(
     () -> o1.getValue() + o2.getValue(),
     o1, o2);
   

   La valeur observable contenant la liste des voyages peut être définie de manière similaire, en prenant toutefois garde à deux points importants.

   Premièrement, pour des raisons de performances, le profil correspondant à la requête doit être gardé dans un cache afin de ne pas être recalculé lorsque ni la date de voyage ni l'arrêt d'arrivée ne changent.

   Deuxièmement, la valeur observable retournée par createObjectBinding doit impérativement être stockée dans un attribut de la classe Main et pas seulement dans une variable locale de la méthode start, faute de quoi elle ne fonctionnera pas correctement¹.

3. Configuration de la fenêtre principale de l'application
   

   La fenêtre principale de l'application, passée à la méthode start sous la forme d'une valeur de type Stage, doit être configurée de manière à ce que sa taille minimale soit de 800×600 unités (setMinWidth et setMinHeight), et que son titre soit ReCHor (setTitle).

   Une fois que la fenêtre principale a été rendue visible au moyen de la méthode show, le champ textuel correspondant à l'arrêt de départ doit être sélectionné. Cela peut se faire au moyen du code suivant :

   Platform.runLater(() ->
     scene.lookup("#depStop").requestFocus());