Lab Manuel d'utilisation
Le composant AJUI_BreadCrumb est livré avec l'application AJUI_BreadCrumbLab.
Cette application de productivité, fournie avec son code source sur Github, est destinée à devenir votre laboratoire créatif et de test pour la mise en oeuvre du composant AJUI_BreadCrumb.
AJUI_BreadCrumbLab a pour but de faciliter l’intégration du composant AJUI_BreadCrumb dans votre application. Ces trois principaux avantages sont :
- Il raccourcit le temps de développement nécessaire pour définir vos Breadcrumb.
- Il permet un rendu visuel dynamique de vos Breadcrumb pour chaque état.
- Il offre une gestion simple et rapide de vos différents modèles qui pourront être importés dans vos applications utilisant le composant AJUI_BreadCrumb.
Le Lab vous propose une interface graphique qui expose tous les états et toutes les propriétés avec un affichage dynamique du résultat.
Une fois que vous aurez obtenu la représentation graphique espérée de votre Breadcrumb dans les différents états, il ne vous restera plus qu'à le sauvegarder sous forme de modèle.
Le Lab vous permettra de créer autant de modèles que vous le désirez. Il est fourni avec un nombre de modèles de base assez important et couvrant un large spectre de type de Breadcrumbs. Vous pourrez dupliquer ceux-ci pour les décliner et ainsi servir de base à vos propres modèles.
L’application vous met également à disposition Un formulaire HDI (How Do I) vous présentant un contexte d’utilisation d’un AJUI_BreadCrumb.
Un modèle représente une instance d’AJUI BreadCrumb. Le Lab permet d’accéder aux différentes propriétés de cette instance et de modifier leurs valeurs. Le composant utilise un système d’exception afin de définir la représentation graphique d’un Breadcrumb pour chacun de ses états comme indiqué dans le manuel utilisateur de celui-ci.
Pour pouvoir manipuler ces exceptions, le Lab offre une listbox dynamique contenant les valeurs des propriétés propres à l’état sélectionné. L’utilisateur peut interagir avec la listbox afin de modifier ces valeurs comme il le ferait avec la fenêtre de la liste des propriétés de l’éditeur de formulaire de 4D.
Toutes les exceptions générées peuvent être retirées grâce un menu accessible par un clic droit sur une ligne de propriété de cette listbox.
Certaines propriétés sont associées à des boutons alternatifs permettant notamment d’ouvrir la palette de couleur ou encore pour sélectionner un chemin de fichier pour les images par exemple.
Dans le cadre des propriétés liées aux sections, vous pouvez avec le clic gauche et le bouton option maintenu (alt pour windows) sur une propriété, appliquer sa valeur à toutes les sections pour cette même propriété. Une confirmation vous sera demandée. Il faut avoir sélectionné une section pour cela.
Le lab est séparé en quatre parties distinctes.
La première partie concerne la gestion des modèles, cela concerne notamment le stockage, création, sauvegarde, suppression, etc.
La deuxième partie permet d’éditer les différentes propriétés de vos modèles. AJUI BreadCrumb possède trois types de propriétés, celles globales, celles liées aux sections et celles liées aux états.
Une liste déroulante vous permet de sélectionner l’un de ces trois de types et la listebox se chargera d’afficher les propriétés liées à votre choix.
La troisième partie permet d’afficher la section sélectionnée et de visualiser le rendu de celle-ci pour chaque état. Cette section est représentée trois fois pour montrer sa représentation sur trois positions différentes (début, centre, fin).
Des boutons de couleurs vous permettront d’appliquer une couleur de fond de formulaire, différente. Le bouton de droite affichera un Tip vous indiquant le raccourci à utiliser (en fonction de l’OS) afin de pouvoir choisir une autre couleur de votre choix.
La dernière partie affiche le bouton comme il devrait apparaitre dans un formulaire interactif pour chaque état dans votre application.
Les modèles de base sont stockés dans le dossier /Resources/AJUI_BreadCrumb_Templates dans le dossier de ressources de l'application Lab. Les modèles dans ce dossier sont libellés avec comme suffixe "(G)" dans le menu de sélection des modèles.
Deux autres emplacements de dossier sont à votre disposition vous permettant de stocker vos modèles : le chemin de dossier Personnel (P) et le chemin dossier Partagé (S) que vous pourrez définir à votre convenance.
Le Lab gère un fichier de préférence vous permettant de modifier les chemins à ces deux dossiers (le fichier est sauvé dans le dossier de préférence de votre ordinateur).
À chaque lancement du Lab, l’application consultera le fichier de préférence afin de récupérer les différents modèles présents dans les dossiers indiqués dans votre fichier de préférence.
Un filtre est à votre disposition, si vous désirez réduire la liste des modèles à un dossier spécifique.
Le Lab propose huit boutons vous permettant de gérer vos modèles. La fonction de chacun de ces boutons est décrite grâce un Tip qui s'affiche lors du survol de la souris sur ceux-ci.
Description de leurs fonctionnalités :
Cette fonctionnalité permet de créer un nouveau modèle. Le modèle créé est automatiquement sauvegardé dans le dossier de préférence sélectionné.
Crée une copie du modèle dans le même dossier ou celui-ci se trouve. La copie est suffixée par « _copy ». Si vous dupliquez à nouveau le même modèle d'origine sans avoir renommé la précédente copie, alors cette dernière sera écrasée par le nouveau fichier dupliqué.
Permets de renommer le modèle et de redéfinir le dossier de destination.
Permets de sauvegarder le modèle dans le dossier sélectionné. Si vous aviez choisi un modèle du dossier Global (G) et que vous le sauvegardez dans votre dossier personnel (P), le modèle dans le dossier Global n’est pas déplacé dans le dossier personnel (P) mais est dupliqué dans ce dernier.
Si un modèle contient un ou des chemins sur des fichiers images, alors le Lab créera un dossier portant le nom du modèle qui contiendra le modèle (fichier json) et la ou les copies des fichiers images. Les chemins de ces fichiers images, dans l’instance du modèle sont automatiquement mis à jour pour pointer sur ces copies à l’aide du placeholder « # » indiquant aux composants que les images se trouvent dans le même dossier que le modèle importé.
Cette opération a pour but de faciliter la récupération des images et du modèle pour les utiliser ensuite dans votre application en utilisant la fonction d’import du composant.
Vous pouvez réaliser un quick save en utilisant option + clic (mac) ou alt + clic (window), cela aura pour effet de passer la confirmation et de sauvegarder le template au même emplacement.
Cette fonctionnalité supprime le modèle sélectionné.
Permets d’effacer des modifications en cours en rechargeant l’instance du modèle dans l’état où elle se trouvait lors de la dernière sauvegarde ou lors de son chargement si aucune sauvegarde n’a été faite entre temps.
Cette fonctionnalité permet de supprimer l’ensemble des exceptions d’un modèle. Cela ne sauvegarde pas le modèle.
Cette fonctionnalité rend inaccessibles les propriétés d’un modèle et donc permets d’éviter qu’elles soient modifiées malencontreusement.
Une bannière est affichée lorsqu’un modèle est protégé.
La listbox du lab marque en gras, les propriétés dont la valeur actuelle est différente de la valeur par défaut. En maintenant la touche « control » et en faisant un clic gauche sur la propriété, vous pouvez réinitialiser à sa valeur par défaut.
Dans le cadre des propriétés des états, effectuer cette opération revient à retirer l’exception liée à l'état courant. Cela ne concerne pas, l’état « default » qui ne génère pas d’exceptions (voir le manuel AJUI_BreadCrumb).
