Passer au contenu principal

Tree

Ouvrir dans ChatGPT
Shadow dwc-tree 25.01
Java API

Le composant Tree organise les données sous la forme d'une hiérarchie de nœuds. Chaque nœud contient une clé unique et une étiquette. Les nœuds se connectent pour former des relations parent-enfant. Vous pouvez développer ou réduire les nœuds pour afficher ou cacher leurs enfants. Les icônes clarifient quel type de nœud vous regardez et si celui-ci est sélectionné. La sélection prend en charge le choix d'un nœud ou de plusieurs à la fois.

Modèle de nœud et structure de l'arbre

Le rôle de TreeNode

Chaque élément de données dans l'arbre est encapsulé dans un TreeNode. Cet objet contient la clé, l'étiquette de texte, et des liens vers ses nœuds parents et enfants. Le nœud racine est spécial : il existe dans chaque arbre mais n'est pas visible. Il sert de conteneur pour tous les nœuds de premier niveau, facilitant la gestion interne de la structure de l'arbre.

Parce que les nœuds gardent des références à leurs parents et enfants, traverser l'arbre est simple. Que vous souhaitiez monter, descendre, ou trouver un nœud spécifique par sa clé, les connexions sont toujours accessibles.

Création et gestion de nœuds

Les nœuds sont créés en utilisant des méthodes de fabrique simples, soit en fournissant une clé et un texte, soit juste un texte (qui sert également de clé). Cela garantit que chaque nœud est valide et identifiable de manière unique.

Ajouter des nœuds à l'arbre implique d'appeler add() ou insert() sur un nœud parent. Ces méthodes gèrent l'attribution de la référence parent et notifient l'arbre de mettre à jour son interface utilisateur.

Exemple :

TreeNode parent = Tree.node("Parent");
TreeNode child = Tree.node("Child");
parent.add(child);
tree.add(parent);
Un seul parent

Essayer d'assigner le même nœud à plus d'un parent entraînera le déclenchement d'une exception. Cette protection garantit que l'arbre maintienne une hiérarchie appropriée en empêchant les nœuds d'avoir plusieurs parents, ce qui briserait l'intégrité de la structure et provoquerait des comportements inattendus.

Afficher le code

Modification des nœuds

Vous mettez à jour l'étiquette d'un nœud en appelant setText(String text). Cette méthode change le texte affiché pour le nœud dans l'arbre.

Pour supprimer un nœud enfant spécifique, utilisez remove(TreeNode child). Cela détache l'enfant de son parent et le retire de la structure de l'arbre. Cela efface également la référence au parent.

Si vous souhaitez effacer tous les enfants d'un nœud, appelez removeAll(). Cela supprime chaque nœud enfant, efface leurs références parent, et vide la liste des enfants.

Chaque nœud prend en charge le stockage d'informations supplémentaires côté serveur à l'aide de setUserData(Object key, Object data). Cela vous permet d'associer des métadonnées ou des références arbitraires au nœud, sans exposer ces données au client ou à l'interface utilisateur.

Utilisation de la démo pour modifier le texte du nœud

Dans la démo, double-cliquez sur un nœud pour ouvrir un éditeur pour son texte. Entrez le nouveau texte et enregistrez-le pour mettre à jour l'étiquette du nœud dans l'arbre.

Afficher le code

Icônes

Les icônes fournissent des indices visuels sur ce que représentent les nœuds et leur état. Elles améliorent la lisibilité en distinguant les types de nœuds et l'état de la sélection d'un coup d'œil. Le composant Tree prend en charge la définition d'icônes par défaut de manière globale, la personnalisation des icônes par nœud et la bascule de la visibilité des icônes.

Icônes globales

L'arbre vous permet de définir des icônes par défaut pour les groupes réduits, les groupes étendus, les nœuds feuilles et les feuilles sélectionnées.

Exemple :

tree.setCollapsedIcon(TablerIcon.create("folder"));
tree.setExpandedIcon(TablerIcon.create("folder-opened"));
tree.setLeafIcon(TablerIcon.create("file"));
tree.setLeafSelectedIcon(TablerIcon.create("file-checked"));
Sources d'icônes

Une icône peut être toute définition d'icône valide de webforJ ou un fichier de ressource chargé via les protocoles de ressources pris en charge de webforJ.

Icônes par nœud

Vous pouvez remplacer les valeurs par défaut globales en attribuant des icônes à des nœuds individuels. Cela est utile lorsque certains nœuds représentent des concepts différents, comme des dossiers de "projet" ou des fichiers spéciaux.

Exemple :

node.setIcon(TablerIcon.create("project"));
node.setSelectedIcon(TablerIcon.create("project-selected"));

Visibilité des icônes

Parfois, vous voudrez peut-être cacher les icônes pour des groupes ou des feuilles afin de réduire l'encombrement. Le composant vous permet de basculer la visibilité au niveau global pour ces catégories, vous permettant de simplifier l'apparence de l'arbre sans perdre de structure.

Exemple :

tree.setGroupIconsVisible(false);
tree.setLeafIconsVisible(false);
Afficher le code

Expansion et réduction des nœuds

Les nœuds peuvent être développés ou réduits pour contrôler quelles parties de l'arbre sont visibles. Cela permet de se concentrer sur des sections pertinentes et prend en charge des scénarios comme le chargement paresseux ou les mises à jour de données dynamiques.

Opérations d'expansion et de réduction

L'arbre prend en charge l'expansion et la réduction de nœuds individuels par leur clé ou référence directe. Vous pouvez également développer ou réduire tous les descendants d'un nœud en une fois.

Ces opérations vous permettent de contrôler combien de l'arbre est visible et prennent en charge le chargement paresseux des données ou de se concentrer sur des domaines d'intérêt.

Exemple :

tree.expand(node);
tree.collapse(key);

// réduire les sous-arbres
tree.expandFrom(node);
tree.collapseFrom(node);
Réduire la racine

Le nœud racine ancre l'arbre mais reste caché. Réduire la racine cacherait normalement tout, rendant l'arbre apparemment vide. Pour éviter cela, réduire la racine réduit en fait tous ses enfants mais garde la racine développée en interne, assurant que l'arbre montre toujours son contenu correctement.

Chargement paresseux des nœuds

L'arbre prend en charge le chargement paresseux des enfants du nœud en réagissant aux événements d'expansion. Lorsque l'utilisateur développe un nœud, votre application peut charger ou générer les enfants de ce nœud dynamiquement. Cela améliore les performances en chargeant uniquement les parties visibles de l'arbre à la demande.

Utilisez l'événement onExpand pour détecter quand un nœud est développé. Dans le gestionnaire, vérifiez si les enfants du nœud sont des espaces réservés (par exemple, un spinner ou un nœud vide) et remplacez-les par les données réelles une fois chargées.

Afficher le code

Sélection

La sélection contrôle quels nœuds sont choisis par l'utilisateur. Le composant Tree prend en charge des modes et des API flexibles pour sélectionner, désélectionner et interroger des nœuds.

Modes de sélection

Vous pouvez choisir si l'arbre permet de sélectionner un seul nœud à la fois ou plusieurs nœuds simultanément. Passer de la sélection multiple à la sélection unique désélectionne automatiquement tous les nœuds sauf le premier sélectionné.

Exemple :

tree.setSelectionMode(Tree.SelectionMode.SINGLE);
Interaction multi-sélection

Lorsque l'arbre est configuré en mode de sélection multiple, les utilisateurs peuvent sélectionner plus d'un nœud à la fois. La façon dont cela fonctionne dépend de l'appareil :

  • Bureau (souris et clavier) : Les utilisateurs maintiennent la touche Ctrl (ou la touche Cmd sur macOS) et cliquent sur des nœuds pour les ajouter ou les retirer de la sélection actuelle. Cela permet de sélectionner plusieurs nœuds individuels sans désélectionner les autres.
  • Appareils mobiles et tactiles : Puisque les touches de modification ne sont pas disponibles, les utilisateurs tapent simplement sur les nœuds pour les sélectionner ou les désélectionner. Chaque tap crée un basculement de l'état de sélection de ce nœud, permettant une sélection multiple facile par de simples tapotements.

Sélection et désélection

Les nœuds peuvent être sélectionnés ou désélectionnés par référence, clé, individuellement ou par lots. Vous pouvez également sélectionner ou désélectionner tous les enfants d'un nœud en un seul appel.

Exemple :

// sélectionner un nœud par référence ou clé
tree.select(node);
tree.selectKey(key);

// désélectionner un nœud par référence ou clé
tree.deselect(node);
tree.deselectAll();

// sélectionner ou désélectionner les enfants des nœuds
tree.selectChildren(parentNode);
tree.deselectChildren(parentNode);

Récupération de l'état de sélection

Vous pouvez obtenir la sélection actuelle en utilisant le code affiché ci-dessous :

// obtenir la référence du nœud sélectionné
TreeNode selected = tree.getSelected();
List<TreeNode> selectedItems = tree.getSelectedItems();

// obtenir la clé du nœud sélectionné
Object selectedKey = tree.getSelectedKey();
List<Object> selectedKeys = tree.getSelectedKeys();
Afficher le code

Stylisation

Loading...