AxeRunOptions-Klasse

Die AxeRunOptions-Klasse bietet Konfigurationsoptionen, die steuern, wie axe-core Barrierefreiheitsprüfungen durchführt. Diese Klasse ermöglicht es Ihnen, spezifische Regeln zu aktivieren oder zu deaktivieren, zu begrenzen, welche Regeln ausgeführt werden, und Analyzedetails wie Abstammungsinformationen für Barrierefreiheitsverstöße zu konfigurieren.

Diese Optionen werden zur Laufzeit an axe-core übergeben, um das Verhalten der Analyse-Engine für Barrierefreiheit anzupassen.

Konstruktor

AxeRunOptions()

Erstellt eine neue Instanz von AxeRunOptions mit Standardeinstellungen. Standardmäßig ist die Eigenschaft ancestry auf false gesetzt.

AxeRunOptions options = new AxeRunOptions();

Methoden

setAncestry(boolean ancestry)

Setzt die Eigenschaft ancestry. Wenn auf true gesetzt, wird der vollständige CSS-Selektorpfad für Elemente mit Barrierefreiheitsverstößen einschließlich aller Elternelemente vom axe-core-Engine einbezogen. Dies hilft, Verstöße in komplexen DOM-Strukturen zu lokalisieren.

Parameter:

• ancestry - Boolean-Wert zum Aktivieren oder Deaktivieren von Abstammungsinformationen

Rückgabewert:

• AxeRunOptions - Die aktuelle Instanz für Methodenchaining

Beispiel:

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

setRunOnly(AxeRunOnly runOnly)

Setzt die Eigenschaft runOnly, die es Ihnen ermöglicht, zu begrenzen, welche Barrierefreiheitsregeln ausgeführt werden. Verwenden Sie dies, um sich auf spezifische Standards oder Regelsets zu konzentrieren.

Parameter:

• runOnly - Eine AxeRunOnly-Instanz, die angibt, welche Regeln oder Tags ausgeführt werden sollen

Rückgabewert:

• AxeRunOptions - Die aktuelle Instanz für Methodenchaining

Beispiel:

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

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

setRules(Map<String, AxeRuleOptions> rules)

Setzt die Eigenschaft rules, die es Ihnen ermöglicht, spezifische Barrierefreiheitsregeln anhand von IDs zu aktivieren oder zu deaktivieren.

Parameter:

• rules - Eine Zuordnung von Regel-IDs zu AxeRuleOptions-Instanzen

Rückgabewert:

• AxeRunOptions - Die aktuelle Instanz für Methodenchaining

Beispiel:

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

Erhält den aktuellen Wert der Eigenschaft ancestry.

Rückgabewert:

• boolean - Der aktuelle Wert der Abstammungseigenschaft

Beispiel:

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

getRunOnly()

Erhält die aktuelle AxeRunOnly-Konfiguration.

Rückgabewert:

• AxeRunOnly - Die aktuelle runOnly-Konfiguration oder null, wenn nicht gesetzt

Beispiel:

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

Erhält die aktuelle Zuordnung der Regelkonfigurationen.

Rückgabewert:

• Map<String, AxeRuleOptions> - Die aktuelle Regelkonfiguration oder null, wenn nicht gesetzt

Beispiel:

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

Serialisiert die AxeRunOptions-Instanz in einen JSON-String.

Rückgabewert:

• String - Eine JSON-String-Darstellung der Optionen

Beispiel:

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

Hinweise zur Konfigurationsvalidierung

Bei der Konfiguration von AxeRunOptions beachten Sie die folgenden Validierungsregeln:

1. Bei Verwendung von setRules():

   • Die Regelzuordnung muss mindestens einen Eintrag enthalten.
   • Jeder Regelwert darf nicht null sein.

2. Bei Verwendung von setRunOnly():

   • Die type-Eigenschaft muss eine der folgenden sein: „rule“, „rules“, „tag“ oder „tags“
   • Die values-Eigenschaft muss mindestens einen Wert enthalten
   • Die Eigenschaft values darf keine Null-Einträge enthalten.

3. Wechselseitig ausschließende Konfigurationen:

   • Sie können nicht gleichzeitig sowohl runOnly in AxeRunOptions als auch accessibilityStandard in ConfigurationOverrides verwenden.

Siehe auch

• AxeRuleOptions
• AxeRunOnly
• AxeRunContext
• AxeWatcherOptions