API-Referenz für Java Playwright

Dieses Dokument enthält eine API-Referenz zur Java-Klasse AxePlaywrightBuilder , die von der Playwright-Java-Integration bereitgestellt wird.

Konstruktoren

AxePlaywrightBuilder(Page)

Initialisiert eine neue Instanz der AxePlaywrightBuilder-Klasse für das angegebene Page-Objekt.

public AxePlaywrightBuilder(Page page);

Parameter

Beispiel

Das folgende Codebeispiel demonstriert diesen Konstruktor. Außerdem wird gezeigt, wie ein Page Objekt und mit diesem Page Objekt ein AxePlaywrightBuilder Objekt erstellt wird.

// Example Page
Page page = browser.newPage();

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page);

AxePlaywrightBuilder(Page, File)

Initialisiert eine neue Instanz der Klasse AxePlaywrightBuilder mit dem angegebenen Page -Objekt und dem angegebenen File -Objekt. Die Datei enthält benutzerdefinierte Regeln in einer JSON-Datei.

public AxePlaywrightBuilder(Page page, File rules);

Parameter

Beispiel

Das folgende Beispiel zeigt, wie dieser Konstruktor verwendet wird.

// Example Page
Page page = browser.newPage();

File customRuleset = new File("somePath/custom-ruleset.json")
AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page, customRuleset);

AxePlaywrightBuilder(Page, String)

Initialisiert eine neue Instanz der Klasse AxePlaywrightBuilder mit dem angegebenen Page -Objekt und dem angegebenen String -Objekt, das benutzerdefinierte Regeln in einer JSON-Zeichenfolge enthält.

public AxePlaywrightBuilder(Page page, String rules);

Parameter

Beispiel

Das folgende Codebeispiel demonstriert diesen Konstruktor.

// Example Page
Page page = browser.newPage();

String customRuleset = "{...}"
AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page, customRuleset);

Methoden

analysieren

Analysieren Sie die Playwright-Seite (angegeben bei der Erstellung des AxePlaywrightBuilder -Objekts) und geben Sie ein AxeResults -Objekt aus der abgeschlossenen Analyse zurück.

AxeResults AxePlaywrightBuilder.analyze();

Rückgaben

• AxeResults

Beispiel

Das folgende Codebeispiel demonstriert die Verwendung der Analysemethode.

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page);

AxeResults axeResults = axePlaywrightBuilder.analyze();

/* Usage may include:
axeResults.getViolations() - returns only violation results
axeResults.getPasses() - returns only pass results
axeResults.getIncomplete() - returns only incomplete results
*/

configure(File)

Stellen Sie axe-core eine benutzerdefinierte Konfiguration über eine JSON-Datei zur Verfügung.

public AxePlaywrightBuilder configure(File axeConfigure);

Weitere Informationen zum Format der Konfigurationsdatei finden Sie unter axe-core-Konfiguration.

Parameter

Beispiel

Das folgende Beispiel zeigt, wie Sie auf eine Konfiguration zugreifen und sie mit einem AxePlaywrightBuilder -Objekt verwenden.

File myAxeConfigure = new File("./axe-configure.json");

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page)
        .configure(myAxeConfigure);

configure(String)

Stellen Sie eine benutzerdefinierte Konfiguration für Axe-Core (die zugrunde liegende Technologie zur Analyse der Zugänglichkeit) bereit, die als JSON-Zeichenfolge ausgeführt wird.

public AxePlaywrightBuilder configure(String axeConfigure);

Weitere Informationen zum Format der Konfigurationsdatei finden Sie unter axe-core-Konfiguration.

Parameter

Beispiel

Das folgende Beispiel zeigt, wie Sie auf eine Konfiguration zugreifen und sie mit einem AxePlaywrightBuilder -Objekt verwenden.

String myAxeConfigure = "{..}"

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page)
        .configure(myAxeConfigure);

disableRules

Regeln von der Ausführung während der Analyse ausschließen.

public AxePlaywrightBuilder disableRules(List<String> rules);

Parameter

Rückgabewerte

• AxePlaywrightBuilder

Beispiel

Das folgende Beispiel zeigt, wie die Barrierefreiheitsprüfung für eine einzelne Regel mithilfe der Methode singletonList der Klasse Collections und für mehrere Regeln mithilfe einer Liste deaktiviert wird.

// Single Rule
AxePlaywrightBuilder axePlaywrightBuilder1 = new AxePlaywrightBuilder(page)
        .disableRules(Collections.singletonList("color-contrast"));

// Multiple Rules
AxePlaywrightBuilder axePlaywrightBuilder2 = new AxePlaywrightBuilder(page)
        .disableRules(Arrays.asList("color-contrast", "image-alt"));

ausschließen

Geben Sie CSS-Selektoren an, um HTML-Elemente während der Analyse auszuschließen.

public AxePlaywrightBuilder exclude(List<String> excludeCSS);

Parameter

Rückgabewerte

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie Elemente mit diesen Attributen von der Analyse ausgeschlossen werden:

• class="some-class"
• class="some-other-class"

new AxePlaywrightBuilder(page)
        .exclude(Collections.singletonList(".some-class"))
        .exclude(Collections.singletonList(".some-other-class"));

Das folgende Beispiel zeigt, wie Elemente mithilfe von CSS-Iframe-Selektoren ausgeschlossen werden.

// To exclude everything within html of parent-iframe
new AxePlaywrightBuilder(page)
        .exclude(Arrays.asList("#parent-iframe", "#html"))

beinhaltet

Während der Analyse einzubeziehende CSS-Selektoren

public AxePlaywrightBuilder include(List<String> includeCSS);

Parameter

Rückgabewerte

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie zwei unterschiedliche Klassen in die Analyse einbezogen werden. Beachten Sie, wie im Beispiel Methodenverkettung verwendet wird, um mehr als eine CSS-Klasse anzugeben.

new AxePlaywrightBuilder(page)
        .include(Collections.singletonList(".some-class"))
        .include(Collections.singletonList(".some-other-class"));

Das folgende Beispiel zeigt, wie Elemente mithilfe von CSS-Iframe-Selektoren eingebunden werden.

// To include everything within html of parent-iframe
new AxePlaywrightBuilder(page)
        .include(Arrays.asList("#parent-iframe", "#html"))

setLegacyMode

Schließt Zugänglichkeitsprobleme aus, die in domänenübergreifenden Frames und Iframes auftreten können.

public AxePlaywrightBuilder setLegacyMode(boolean legacyMode);

Rückgaben

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel aktiviert den Legacy-Modus.

new AxePlaywrightBuilder(page)
        .setLegacyMode(true);

withAxeSource(File)

Stellen Sie eine benutzerdefinierte Version von axe-core mithilfe des Java-Dateiobjekts bereit

public AxePlaywrightBuilder withAxeSource(File file);

Parameter

Rückgaben

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie Sie eine axe-core anstelle der bereitgestellten Version eine andere Datei verwenden. Dies wäre nur in Spezialfällen notwendig.

File axeLegacySource = new File("somepath/axe-core@legacy.js");

new AxePlaywrightBuilder(page)
        .withAxeSource(axeLegacySource);

withAxeSource(String)

Stellen Sie eine benutzerdefinierte Version von axe-core bereit, die eine bereits geparste Quelle verwendet.

public AxePlaywrightBuilder withAxeSource(String src);

Parameter

Rückgaben

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie eine Datei in einen String eingelesen und dieser mit withAxeSource als Quelldatei verwendet wird.

String source = IOUtils.toString(somepPath.toURI(), StandardCharsets.UTF_8);

new AxePlaywrightBuilder(page)
        .withAxeSource(source);

mit nur Best-Practice-Regeln

Suchen Sie nach Zugänglichkeitsproblemen, indem Sie nur den Best-Practice-Regelsatz aktivieren.

public AxePlaywrightBuilder withOnlyBestPracticeRules();

Rückgaben

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie die Barrierefreiheitsanalyse nur durch Verwendung der Best-Practice-Regeln aktivieren.

new AxePlaywrightBuilder(page)
        .withOnlyBestPracticeRules();

mitNurExperimentellenRegeln

Suchen Sie nach Zugänglichkeitsproblemen, wenn nur der experimentelle Regelsatz aktiviert ist

public AxePlaywrightBuilder withOnlyExperimentalRules();

Rückgabe

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie die Barrierefreiheitsanalyse nur mithilfe der experimentellen Regeln aktiviert wird.

new AxePlaywrightBuilder(page)
        .withOnlyExperimentalRules();

mitRegeln

Beschränken Sie die während der Barrierefreiheitsanalyse auszuführenden Regeln auf die angegebenen.

public AxePlaywrightBuilder exclude(List<String> rules);

Parameter

Rückgabe

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt zwei verschiedene Möglichkeiten zur Verwendung der Methode withRules . Die erste erstellt eine Liste mit einer Regel: color-contrast. Die zweite erstellt eine Liste mit den Regeln color-contrast und image-alt.

// Single Rule
new AxePlaywrightBuilder(page)
        .withRules(Collections.singletonList("color-contrast"));

// Multiple Rules
new AxePlaywrightBuilder(page)
        .withRules(Arrays.asList("color-contrast", "image-alt"));

mitTags

Beschränkt die Zugänglichkeitsanalyse auf den oder die Regelsätze, die zu den angegebenen Tags gehören.

public AxePlaywrightBuilder withTags(List<String> tags);

Parameter

Rückgaben

• AxePlaywrightBuilder

Beispiele

Dieses Beispiel zeigt, wie die Barrierefreiheitsanalyse auf Regeln beschränkt wird, die zu den angegebenen Tags gehören. Der erste Codeausschnitt zeigt, wie die Analyse auf Regeln beschränkt wird, die Teil der wcag21aa Spezifikation sind. Der zweite Codeausschnitt zeigt, wie die Analyse auf die wcag21aa Spezifikation und die Best-Practice-Regeln beschränkt werden kann.

// Single tag
new AxePlaywrightBuilder(page)
        .withTags(Collections.singletonList("wcag21aa"));

// Multiple tags
 new AxePlaywrightBuilder(page)
        .withTags(Arrays.asList("wcag21aa", "best-practice"));