Aller au contenu principal

TabbedPane

Ouvrir dans ChatGPT
Shadow dwc-tabbed-pane 23.06
Java API

La classe TabbedPane fournit un moyen compact et organisé d'afficher du contenu divisé en plusieurs sections, chaque section étant associée à un Tab. Les utilisateurs peuvent passer d'une section à l'autre en cliquant sur les onglets respectifs, souvent étiquetés avec du texte et/ou des icônes. Cette classe simplifie la création d'interfaces multifacettes où différents contenus ou formulaires doivent être accessibles sans être visibles simultanément.

Usages

La classe TabbedPane offre aux développeurs un outil puissant pour organiser et présenter plusieurs onglets ou sections au sein d'une interface utilisateur. Voici quelques scénarios typiques où vous pourriez utiliser un TabbedPane dans votre application :

  1. Visualiseur de documents : Mise en œuvre d'un visualiseur de documents où chaque onglet représente un document ou un fichier différent. Les utilisateurs peuvent facilement passer d'un document ouvert à un autre pour une multitâche efficace.

  2. Gestion des données : Utilisez un TabbedPane pour organiser des tâches de gestion des données, par exemple :

    • Différents ensembles de données à afficher dans une application
    • Divers profils d'utilisateur peuvent être affichés dans des onglets séparés
    • Différents profils dans un système de gestion des utilisateurs
  3. Sélection de module : Un TabbedPane peut représenter différents modules ou sections. Chaque onglet peut encapsuler les fonctionnalités d'un module spécifique, permettant aux utilisateurs de se concentrer sur un aspect de l'application à la fois.

  4. Gestion des tâches : Les applications de gestion des tâches peuvent utiliser un TabbedPane pour représenter divers projets ou tâches. Chaque onglet pourrait correspondre à un projet spécifique, permettant aux utilisateurs de gérer et de suivre les tâches séparément.

  5. Navigation dans le programme : Au sein d'une application qui doit exécuter divers programmes, un TabbedPane pourrait :

    • Servir de barre latérale permettant d'exécuter différentes applications ou programmes au sein d'une seule application, comme montré dans le modèle AppLayout
    • Créer une barre supérieure qui peut servir un objectif similaire, ou représenter des sous-applications au sein d'une application déjà sélectionnée.

Tabs

Les onglets (Tabs) sont des éléments d'interface utilisateur qui peuvent être ajoutés aux panneaux à onglets (tabbed panes) pour organiser et passer d'une vue de contenu à une autre.

important

Les onglets ne sont pas conçus pour être utilisés comme composants autonomes. Ils doivent être utilisés en conjonction avec des panneaux à onglets. Cette classe n'est pas un Component et ne doit pas être utilisée comme telle.

Propriétés

Les onglets se composent des propriétés suivantes, qui sont ensuite utilisées lors de leur ajout dans un TabbedPane. Ces propriétés possèdent des getters et setters pour faciliter la personnalisation au sein d'un TabbedPane.

  1. Clé (Object) : Représente l'identifiant unique pour le Tab.

  2. Texte (String) : Le texte qui sera affiché comme titre pour le Tab au sein du TabbedPane. Cela est également référencé comme le titre via les méthodes getTitle() et setTitle(String title).

  3. Tooltip (String) : Le texte de l'info-bulle qui est associé au Tab, qui sera affiché lorsque le curseur survole le Tab.

  4. Activé (boolean) : Représente si le Tab est actuellement activé ou non. Peut être modifié avec la méthode setEnabled(boolean enabled).

  5. Fermable (boolean) : Représente si le Tab peut être fermé. Peut être modifié avec la méthode setCloseable(boolean enabled) qui ajoutera un bouton de fermeture sur le Tab que l'utilisateur peut cliquer, déclenchant un événement de suppression. Le composant TabbedPane dicte comment gérer la suppression.

  6. Slot (Component) : Les slots offrent des options flexibles pour améliorer la capacité d'un Tab. Vous pouvez avoir des icônes, des étiquettes, des indicateurs de chargement, des capacités de réinitialisation, des images de profil/avatar, et d'autres composants bénéfiques imbriqués au sein d'un Tab pour clarifier l'intention envers les utilisateurs. Vous pouvez ajouter un composant au slot prefix d'un Tab lors de la construction. Alternativement, vous pouvez utiliser les méthodes setPrefixComponent() et setSuffixComponent() pour insérer divers composants avant et après l'option affichée au sein d'un Tab.

    TabbedPane pane = new TabbedPane();
    pane.addTab(new Tab("Documents", TablerIcon.create("files")));

Manipulation de Tab

Il existe plusieurs méthodes permettant aux développeurs d'ajouter, d'insérer, de supprimer et de manipuler diverses propriétés des éléments Tab au sein du TabbedPane.

Ajout d'un Tab

Les méthodes addTab() et add() existent en différentes capacités surchargées pour permettre aux développeurs la flexibilité d'ajouter de nouveaux onglets au TabbedPane. L'ajout d'un Tab le placera après tous les onglets existants.

  1. addTab(String text) - Ajoute un Tab au TabbedPane avec le String spécifié comme texte de l'onglet.
  2. addTab(Tab tab) - Ajoute le Tab fourni en tant que paramètre au TabbedPane.
  3. addTab(String text, Component component) - Ajoute un Tab avec le String donné comme texte de l'onglet, et le Component fourni affiché dans la section de contenu du TabbedPane.
  4. addTab(Tab tab, Component component) - Ajoute le Tab fourni et affiche le Component fourni dans la section de contenu du TabbedPane.
  5. add(Component... component) - Ajoute une ou plusieurs instances de Component au TabbedPane, créant un Tab distinct pour chacune, avec le texte étant défini sur le nom du Component.
info

La méthode add(Component... component) détermine le nom du Component passé en appelant component.getName() sur l'argument passé.

Insertion d'un Tab

En plus d'ajouter un Tab à la fin des onglets existants, il est également possible d'en créer un nouveau à une position désignée. Pour cela, plusieurs versions surchargées de la méthode insertTab() existent.

  1. insertTab(int index, String text) - Insère un Tab dans le TabbedPane à l'index donné avec le String spécifié comme texte de l'onglet.
  2. insertTab(int index, Tab tab) - Insère le Tab fourni en tant que paramètre dans le TabbedPane à l'index spécifié.
  3. insertTab(int index, String text, Component component) - Insère un Tab avec le String donné comme texte de l'onglet, et le Component fourni affiché dans la section de contenu du TabbedPane.
  4. insertTab(int index, Tab tab, Component component) - Insère le Tab fourni et affiche le Component fourni dans la section de contenu du TabbedPane.

Suppression d'un Tab

Pour supprimer un seul Tab du TabbedPane, utilisez l'une des méthodes suivantes :

  1. removeTab(Tab tab) - Supprime un Tab du TabbedPane en passant l'instance du Tab à supprimer.
  2. removeTab(int index) - Supprime un Tab du TabbedPane en spécifiant l'index du Tab à supprimer.

En plus des deux méthodes ci-dessus pour la suppression d'un seul Tab, utilisez la méthode removeAllTabs() pour vider le TabbedPane de tous les onglets.

info

Les méthodes remove() et removeAll() ne suppriment pas les onglets au sein du composant.

Association Tab/Component

Pour changer le Component à afficher pour un Tab donné, appelez la méthode setComponentFor(), et passez soit l'instance du Tab, soit l'index de ce Tab au sein du TabbedPane.

info

Si cette méthode est utilisée sur un Tab qui est déjà associé à un Component, le Component précédemment associé sera détruit.

Configuration et mise en page

La classe TabbedPane a deux parties constitutives : un Tab affiché à un emplacement spécifié, et un composant à afficher. Cela peut être un composant unique, ou un composant Composite, permettant d'afficher des composants plus complexes au sein de la section contenu d'un onglet.

Glissement

Le TabbedPane prend en charge la navigation à travers les différents onglets par glissement. Cela est idéal pour une application mobile, mais peut également être configuré via une méthode intégrée pour prendre en charge le glissement de la souris. Le glissement et le glissement de souris sont désactivés par défaut, mais peuvent être activés avec les méthodes setSwipable(boolean) et setSwipableWithMouse(boolean), respectivement.

Placement des onglets

Les Tabs au sein d'un TabbedPane peuvent être placés à diverses positions à l'intérieur du composant en fonction de la préférence des développeurs d'application. Les options fournies sont définies à l'aide de l'énumération fournie, qui a les valeurs TOP, BOTTOM, LEFT, RIGHT, ou HIDDEN. Le paramétrage par défaut est TOP.

Afficher le code

Alignement

En plus de changer le placement des éléments Tab au sein du TabbedPane, il est également possible de configurer comment les onglets seront alignés au sein du composant. Par défaut, le paramétrage AUTO est en vigueur, ce qui permet au placement des onglets de dicter leur alignement.

Les autres options sont START, END, CENTER, et STRETCH. Les trois premières décrivent la position par rapport au composant, tandis que STRETCH fait en sorte que les onglets remplissent l'espace disponible.

Afficher le code

Bordure et indicateur d'activité

Le TabbedPane aura une bordure affichée pour les onglets qui s'y trouvent par défaut, placée en fonction de quel Placement a été défini. Cette bordure aide à visualiser l'espace que prennent les différents onglets au sein du panneau.

Lorsqu'un Tab est cliqué, par défaut, un indicateur d'activité est affiché près de ce Tab pour aider à mettre en évidence lequel est le Tab actuellement sélectionné.

Ces deux options peuvent être personnalisées par un développeur en changeant les valeurs booléennes à l'aide des méthodes setter appropriées. Pour changer la visibilité de la bordure, la méthode setBorderless(boolean) peut être utilisée, avec true cachant la bordure, et false, la valeur par défaut, affichant la bordure.

info

Cette bordure ne s'applique pas à la totalité du composant TabbedPane, et sert simplement de séparateur entre les onglets et le contenu du composant.

Pour définir la visibilité de l'indicateur actif, la méthode setHideActiveIndicator(boolean) peut être utilisée. Passer true à cette méthode cachera l'indicateur actif sous un Tab actif, tandis que false, la valeur par défaut, maintient l'indicateur affiché.

Afficher le code

Modes d'activation

Pour un contrôle plus fin sur la manière dont le TabbedPane se comporte lors de la navigation au clavier, le mode Activation peut être défini pour spécifier comment le composant doit se comporter.

  • Auto : Lorsqu'il est réglé sur automatique, la navigation entre les onglets avec les touches fléchées affichera instantanément le composant d'onglet correspondant.

  • Manual : Lorsqu'il est réglé sur manuel, l'onglet recevra le focus mais ne s'affichera pas tant que l'utilisateur n'a pas appuyé sur la barre d'espace ou entrée.

Afficher le code

Options de suppression

Des éléments Tab individuels peuvent être configurés pour être fermables. Les onglets fermables auront un bouton de fermeture ajouté à l'onglet, qui déclenche un événement de fermeture lorsqu'il est cliqué. Le TabbedPane dicte comment ce comportement est géré.

  • Manual : Par défaut, la suppression est réglée sur MANUAL, ce qui signifie que l'événement est déclenché, mais il appartient au développeur de gérer cet événement de la manière qu'il choisit.

  • Auto : Alternativement, AUTO peut être utilisé qui déclenchera l'événement, et également supprimera le Tab du composant pour le développeur, supprimant le besoin pour le développeur de mettre en œuvre ce comportement manuellement.

Style

Expanse et thème

Le TabbedPane est livré avec des options d'Expanse et de Thème intégrées similaires à d'autres composants webforJ. Celles-ci peuvent être utilisées pour ajouter rapidement un style qui transmet divers sens à l'utilisateur final sans avoir besoin de styliser le composant avec du CSS.

Afficher le code

Loading...

Meilleures pratiques

Les pratiques suivantes sont recommandées pour utiliser le TabbedPane dans les applications :

  • Groupe logique : Utilisez des onglets pour regrouper logiquement le contenu connexe

    • Chaque onglet doit représenter une catégorie ou une fonctionnalité distincte au sein de votre application
    • Regroupez les onglets similaires ou logiques les uns à côté des autres
  • Onglets limités : Évitez de submerger les utilisateurs avec trop d'onglets. Envisagez d'utiliser une structure hiérarchique ou d'autres modèles de navigation lorsque cela est applicable pour une interface propre

  • Étiquettes claires : Étiquetez clairement vos onglets pour une utilisation intuitive

    • Fournissez des étiquettes claires et concises pour chaque onglet
    • Les étiquettes doivent refléter le contenu ou l'objectif, facilitant la compréhension pour les utilisateurs
    • Utilisez des icônes et des couleurs distinctes là où cela est applicable
  • Navigation au clavier : Utilisez la prise en charge de la navigation au clavier du TabbedPane de webforJ pour rendre l'interaction avec le TabbedPane plus fluide et intuitive pour l'utilisateur final

  • Onglet par défaut : Si l'onglet par défaut n'est pas placé au début du TabbedPane, envisagez de définir cet onglet comme par défaut pour des informations essentielles ou couramment utilisées.