Classe AxeRunOptions

La classe AxeRunOptions fournit des options de configuration qui contrôlent la manière dont axe-core réalise les tests d'accessibilité. Cette classe vous permet d'activer ou de désactiver des règles spécifiques, de limiter les règles exécutées et de configurer les détails de l'analyse tels que les informations d'ascendance pour les violations d'accessibilité.

Ces options sont passées à axe-core lors de l'exécution pour personnaliser le comportement du moteur d'analyse d'accessibilité.

Constructeur

AxeRunOptions()

Crée une nouvelle instance de AxeRunOptions avec les paramètres par défaut. Par défaut, la propriété ancestry est définie sur false.

AxeRunOptions options = new AxeRunOptions();

Méthodes

setAncestry(boolean ancestry)

Définit la propriété ancestry. Lorsqu'elle est définie sur true, le moteur axe-core inclura le chemin complet du sélecteur CSS pour les éléments avec des violations d'accessibilité, incluant tous les éléments parents. Cela aide à localiser les violations dans des structures DOM complexes.

Paramètres :

• ancestry - Valeur booléenne pour activer ou désactiver les informations d'ascendance

Renvoie :

• AxeRunOptions - L'instance actuelle pour le chaînage de méthodes

Exemple :

AxeRunOptions options = new AxeRunOptions();
options.setAncestry(true);

setRunOnly(AxeRunOnly runOnly)

Définit la propriété runOnly, ce qui vous permet de limiter les règles d'accessibilité exécutées. Utilisez ceci pour concentrer les tests sur des standards ou ensembles de règles spécifiques.

Paramètres :

• runOnly - Une instance AxeRunOnly spécifiant quelles règles ou balises exécuter

Renvoie :

• AxeRunOptions - L'instance actuelle pour le chaînage de méthodes

Exemple :

AxeRunOnly runOnly = new AxeRunOnly()
    .setType("tag")
    .setValues(Arrays.asList("wcag21aa", "best-practice"));

AxeRunOptions options = new AxeRunOptions();
options.setRunOnly(runOnly);

setRules(Map<String, AxeRuleOptions> rules)

Définit la propriété rules, ce qui vous permet d'activer ou de désactiver des règles d'accessibilité spécifiques par leur ID.

Paramètres :

• rules - Une carte d'IDs de règles vers des instances AxeRuleOptions

Renvoie :

• AxeRunOptions - L'instance actuelle pour le chaînage de méthodes

Exemple :

Map<String, AxeRuleOptions> rules = new HashMap<>();
rules.put("color-contrast", new AxeRuleOptions().setEnabled(false));
rules.put("aria-roles", new AxeRuleOptions().setEnabled(true));

AxeRunOptions options = new AxeRunOptions();
options.setRules(rules);

getAncestry()

Obtient la valeur actuelle de la propriété ancestry.

Renvoie :

• boolean - La valeur actuelle de la propriété d'ascendance

Exemple :

AxeRunOptions options = new AxeRunOptions();
options.setAncestry(true);
boolean ancestry = options.getAncestry(); // Returns true

getRunOnly()

Obtient la configuration actuelle AxeRunOnly.

Renvoie :

• AxeRunOnly - La configuration actuelle runOnly, ou null si elle n'est pas définie

Exemple :

AxeRunOptions options = new AxeRunOptions();
AxeRunOnly runOnly = new AxeRunOnly()
    .setType("tag")
    .setValues(Arrays.asList("wcag21aa"));
options.setRunOnly(runOnly);

AxeRunOnly currentRunOnly = options.getRunOnly(); // Returns the runOnly configuration

getRules()

Obtient la carte actuelle des configurations de règles.

Renvoie :

• Map<String, AxeRuleOptions> - La configuration actuelle des règles, ou null si non définie

Exemple :

AxeRunOptions options = new AxeRunOptions();
Map<String, AxeRuleOptions> rules = new HashMap<>();
rules.put("color-contrast", new AxeRuleOptions().setEnabled(false));
options.setRules(rules);

Map<String, AxeRuleOptions> currentRules = options.getRules(); // Returns the rules map

toJson()

Sérialize l'instance AxeRunOptions en une chaîne JSON.

Renvoie :

• String - Une représentation en chaîne JSON des options

Exemple :

AxeRunOptions options = new AxeRunOptions()
    .setAncestry(true)
    .setRunOnly(new AxeRunOnly()
        .setType("tag")
        .setValues(Arrays.asList("wcag21aa")));

String json = options.toJson();
// Returns JSON like: {"ancestry":true,"runOnly":{"type":"tag","values":["wcag21aa"]}}

Notes de Validation de Configuration

Lors de la configuration de AxeRunOptions, soyez conscient des règles de validation suivantes :

1. Lors de l'utilisation de setRules() :

   • La carte de règles doit contenir au moins une entrée.
   • Chaque valeur de règle ne peut pas être nulle.

2. Lors de l'utilisation de setRunOnly() :

   • La propriété type doit être l'une des suivantes : « rule », « rules », « tag » ou « tags »
   • La propriété values doit contenir au moins une valeur
   • La propriété values ne peut pas contenir d'entrées nulles

3. Configurations mutuellement exclusives :

   • Vous ne pouvez pas utiliser à la fois runOnly dans AxeRunOptions et accessibilityStandard dans ConfigurationOverrides en même temps.

Voir aussi

• AxeRuleOptions
• AxeRunOnly
• AxeRunContext
• AxeWatcherOptions