Classe AxeRunOptions

La classe AxeRunOptions fornisce opzioni di configurazione che controllano come axe-core esegue i test di accessibilità. Questa classe consente di abilitare o disabilitare regole specifiche, limitare quali regole vengono eseguite e configurare dettagli dell'analisi come le informazioni di discendenza per le violazioni di accessibilità.

Queste opzioni vengono passate a axe-core a runtime per personalizzare il comportamento del motore di analisi dell'accessibilità.

Costruttore

AxeRunOptions()

Crea una nuova istanza di AxeRunOptions con impostazioni predefinite. Per impostazione predefinita, la proprietà ancestry è impostata su false.

AxeRunOptions options = new AxeRunOptions();

Metodi

setAncestry(boolean ancestry)

Imposta la proprietà ancestry. Quando impostata su true, il motore axe-core includerà il percorso completo del selettore CSS per gli elementi con violazioni di accessibilità, inclusi tutti gli elementi padre. Ciò aiuta a localizzare le violazioni in strutture DOM complesse.

Parametri:

• ancestry - Valore booleano per abilitare o disabilitare le informazioni di discendenza

Ritorna:

• AxeRunOptions - L'istanza corrente per concatenamento di metodi

Esempio:

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

setRunOnly(AxeRunOnly runOnly)

Imposta la proprietà runOnly, che ti consente di limitare quali regole di accessibilità vengono eseguite. Usalo per concentrare i test su specifici standard o set di regole.

Parametri:

• runOnly - Un'istanza di AxeRunOnly che specifica quali regole o tag eseguire

Ritorna:

• AxeRunOptions - L'istanza corrente per concatenamento di metodi

Esempio:

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

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

setRules(Map<String, AxeRuleOptions> rules)

Imposta la proprietà rules, che ti consente di abilitare o disabilitare regole specifiche di accessibilità tramite ID.

Parametri:

• rules - Una mappa di ID di regole a istanze AxeRuleOptions

Ritorna:

• AxeRunOptions - L'istanza corrente per concatenamento di metodi

Esempio:

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()

Recupera il valore corrente della proprietà ancestry.

Ritorna:

• boolean - Il valore corrente della proprietà di discendenza

Esempio:

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

getRunOnly()

Recupera la configurazione corrente di AxeRunOnly.

Ritorna:

• AxeRunOnly - La configurazione corrente di runOnly, o null se non impostata

Esempio:

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()

Recupera la mappa corrente delle configurazioni delle regole.

Ritorna:

• Map<String, AxeRuleOptions> - La configurazione corrente delle regole, o null se non impostata

Esempio:

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()

Serializza l'istanza AxeRunOptions in una stringa JSON.

Ritorna:

• String - Una rappresentazione come stringa JSON delle opzioni

Esempio:

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"]}}

Note sulla Validazione della Configurazione

Quando si configura AxeRunOptions, tenere presenti le seguenti regole di validazione:

1. Quando si utilizza setRules():

   • La mappa delle regole deve contenere almeno un elemento.
   • Ogni valore di regola non può essere null.

2. Quando si utilizza setRunOnly():

   • La proprietà type deve essere uno dei seguenti: "rule", "rules", "tag" o "tags"
   • La proprietà values deve contenere almeno un valore
   • La proprietà values non può contenere voci nulle

3. Configurazioni mutuamente esclusive:

   • Non è possibile utilizzare contemporaneamente sia runOnly in AxeRunOptions che accessibilityStandard in ConfigurationOverrides.

Vedi anche

• AxeRuleOptions
• AxeRunOnly
• AxeRunContext
• AxeWatcherOptions