OOUI/Toolbars/fr

Barres d'outils
Les barres d'outils sont des composants complexes d'interface qui permettent aux utilisateurs d'accéder facilement à une variété d'outils (comme les commandes de mise en forme) et d'actions. Ces outils sont des commandes supplémentaires faisant partie de la barre d'outils mais ils ne sont pas configurés comme telles.

Les développeurs créent et personnalisent les outils individuels puis les enregistrent avec une ToolFactory, qui crée les outils à la demande. Chaque outil a un nom symbolique (utilisé lors de son enregistrement), un titre (par exemple, ‘Insérer une image’), et une icône.

Les outils individuels sont organisés en groupes d'outils et affichés dans les menus, les listes ou une unique barre d'outils. Vous pouvez personnaliser l'organisation et l'ordre des groupes quand vous configurez la barre d'outils. Les outils peuvent apparaître dans n'importe quel ordre mais chaque outil ne peut figurer qu'une fois dans la barre d'outils.

Vous trouverez ci-après un exemple basique de barre d'outils. Nous détaillerons plus précisément chaque composant de cet exemple ultérieurement dans cette documentation. Pour avoir un aperçu réel de cette démonstration, voir la documentation du code générée.

Outils
Les outils sont créés par l'extension de la classe abstraite Tools ou l'une de ses sous-classes PopupTool ou ToolGroupTool. Chaque outil doit être configuré avec les propriétés de nom statique, de titre et d'icône :


 * &mdash; Le nom symbolique est utilisé en interne pour enregistrer l'outil via ToolFactory. Les outils doivent être enregistrés via une usine d'outils (tool factory) avant de pouvoir être utilisés dans une barre d'outils.
 * &mdash; Le texte du titre est utilisé de différentes manières en fonction du type de groupe dans lequel l'outil est placé
 * le groupe des barres d'outils ToolBarGroup, le groupe des barres de menus ToolMenuGroup, ou le groupe des listes d'outils ToolListGroup. Pour les groupes d'outils de type 'bar' où il n'y a qu'une icône pour identifier l'outil, le texte du titre est utilisé comme une bulle d'aide affichée quand l'utilisateur survole l’outil avec la souris. Pour les groupes d'outils de type 'list', le texte du titre est utilisé pour identifier les outils dans les menus déroulants de l'interface utilisateur. Si un raccouci a été défini pour l'outil, il sera automatiquement affiché. Pour les groupes d'outils de type 'bar', le raccourci clavier est affiché dans une bulle; pour les outils des groupes de type 'menu' et 'list', le raccouci apparait à droite de chaque élément du menu déroulant.


 * &mdash; L'icône est aussi utilisée de différentes manières en fonction du type de groupe dans lequel se trouve l'outil. Pour les groupes d'outils de type 'bar', l'icône est affichée dans la barre d'outils afin d'identifier ces derniers. Pour les groupes d'outils de type 'list', l'icône est affichée à côté du texte du titre dans le menu déroulant. Pour les groupes d'outils de type 'menu', l'icône est ignorée.

En plus des propriétés statiques, les outils doivent aussi implémenter les méthodes suivantes :


 * onSelect &mdash; utilisé pour spécifier l'action réalisée par l'outil quand il est sélectionné
 * onUpdateState &mdash; utilisé pour synchroniser l'état de l'outil avec l'état de son contexte le plus grand. Par exemple cette méthode peut être utilisée pour sélectionner l'outil 'bold’ de la barre d'outil quand le curseur du texte est placé dans une zone de texte en gras.

Les outils peuvent aussi être configurés avec la propriété statique 'group' qui pourra être utilisée ultérieurement quand l'outil sera ajouté dans une barre, un menu ou à une liste de groupe d'outils (voir ToolGroups pour un exemple de réalisation) :

La liste complète des méthodes prises en charge ainsi que les options de configuration, sont décrites dans la documentation du code pour la classe Tool.

PopupTool
Les outils de fenêtrage ouvrent une fenêtre popup lorsqu'ils sont sélectionnés dans la barre d'outils. A la différence des outils standards les outils de popup ne nécessitent pas que les développeurs spécifient les méthodes   ou , car ces méthodes sont déjà implémentées.

La liste complète des méthodes prises en charge ainsi que les options de configuration, sont décrites dans la documentation du code pour la classe PopupTool.

ToolGroupTool
Un ToolGroupTool est une espèce particulière d'outil pouvant contenir d'autre outils ou d'autres groupes d'outils à l'intérieur. Le ToolGroupTool a été conçu spécialement pour être utilisé avec des outils regroupés sous une même barre afin de donner accès à des outils supplémentaires à partir de l'élément barre.

La liste complète des méthodes prises en charge ainsi que les options de configuration, sont décrites dans la documentation du code pour la classe ToolGroupTool.

ToolGroups
Les outils sont regroupés dans des Toolgroups, créés par une ToolGroupFactory puis ajoutés à la barre d'outils quand celle-ci est définie. Des outils peuvent être ajoutés individuellement à n'importe quel type de groupement d'outils (barre, liste ou menu). Le type du toolgroup détermine la disposition des outils ajoutés dans la barre d'outils :
 * &mdash; Les outils sont affichés par leur icône sur une seule ligne.
 * &mdash; Les outils sont affichés avec un libellé et une icône dans un menu déroulant. Le titre de l'outil est utilisé comme texte du libellé. La liste peut être configurée pour être repliée ou développée, avec le paramètre allowCollapse.
 * &mdash; Dans un menu déroulant les outils sont présentés en fonction de leur libellé. Le titre de l'outil est utilisé comme texte du libellé. Les groupes d'outils de type 'menu' sont généralement utilisés pour des ensembles d'outils mutuellement exclusifs, tels que des groupes de commandes pour la mise en forme du texte (paragraphe, titre, etc).

Les outils peuvent être ajoutés à un groupe d'outils de différentes manières : par leur nom symbolique, par le nom du groupe, ou en utilisant l'astérisque '*' pour tout couvrir :

Ajouter les outils par  :

Ajouter les outils par. Le nom d'un groupe d'outils est spécifié en utilisant la propriété statique 'group' (voir Tools pour un exemple).

Ajouter les outils avec le  :

Developers can further curate the arrangement of the tools using the toolgroup’s  and   configuration options, which will arrange the tools at the top of the tool list (or front of the toolbar) or end, respectively. These settings are particularly useful when tools have been added to the toolbar en masse (e.g., with the asterisk catch-all or when a group of tools is added to a toolgroup) to manage their priority.

BarToolGroup
Les outils d'un   sont affichés par icône et sur une seule ligne. Le titre de l'outil est affiché quand l'utilisateur survole l'outil avec la souris.

La liste complète des méthodes prises en charge ainsi que les options de configuration, sont décrites dans la documentation du code pour la classe BarToolGroup.

ListToolGroup
Les outils d'un   sont affichés par leur icône et leur libellé dans un menu déroulant. Le titre de l'outil est utilisé comme texte du libellé. Les groupes de listes peuvent être configurés pour être développés ou fermés. Les listes fermées auront une option 'Plus...' que les utilisateurs pourront sélectionner pour voir la liste complète des outils. Si un toolgroup replié est développé, une option ‘Moins’ permet aux utilisateurs de replier la liste à nouveau.

En plus de,   peut aussi être configuré avec un   et   :

Use the  config to designate tools as collapsible (‘help’ and ‘stuff’, in the following example). By default, the list opens in its collapsed state, and users must click the 'More' option to see the collapsed tools:

To display a collapsible list in its expanded state when the list is opened, set the  config to  :

Alternatively, you may wish to specify the names of tools that should never be collapsed. This is done with the  config. In the following example, only the ‘help’ tool has been designated as expanded; all other tools are collapsed by default.

For a complete list of supported methods and configuration options, please see the code-level documentation for the ListToolGroup class.

MenuToolGroup
Tools in  s are displayed by label in a dropdown menu. The tool's title is used as the label text, and the menu label is updated to reflect which tool or tools are currently selected. Note that all tools must define an  method if a   is used.



Configurer la barre d'outils
In addition to containing toolgroups, the toolbar can be configured with actions, CSS, accelerator keys, and/or an optional shadow.

Note that ‘actions’ in the context of the toolbar are different from ActionWidgets. For toolbars, ‘actions’ refers to an empty container that is right-aligned and can contain whatever you’d like.



Ajouter des groupes d'outils
Toolgroups are added to the toolbar with the toolbar's  method:

Adding actions
Toolbars have an optional 'actions' area, which contains commands that are available to users but are not configured as tools. In the following example, the toolbar has been configured to use actions, in this case two additional buttons, ‘Action’ and ‘Disabled’. For the purpose of brevity, only the action-specific code is included in the example (the rest is just the same as the basic toolbar).



Utiliser CSS pour formater l'étiquette des outils
Tool labels can be styled with built-in CSS classes that are named after each tool: oo-ui-tool-name-&lt;symbolic name of tool> (e.g., oo-ui-tool-name-picture). The following example uses CSS classes to customize the appearance of the 'picture' and the 'help' tool labels.





Utiliser les touches de raccourci
The OOUI library does not contain an accelerator system, but the Toolbar class does contain a hook for one. To use an accelerator system, subclass the toolbar and override the  method, which is meant to return a label that describes the accelerator keys for the tool passed (by symbolic name) to the method.

Accelerator labels (e.g., Ctrl + M ) are displayed in different ways depending on the type of toolgroup used:


 * For bar toolgroups, the accelerator label appears in the tooltip displayed when users move the mouse over the tool.
 * For menu and list toolgroups, the accelerator label is right-aligned and rendered in gray text, which still complies to WCAG level AA.

Building the toolbar
The toolbar must be appended to the document before it can be built. Once it is appended, the toolbar can be initialized:

La liste complète des méthodes prises en charge ainsi que les options de configuration, sont décrites dans la documentation du code pour la classe Toolbars.