API-Referenz für Java Playwright

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

API-Referenz für die Klasse AxePlaywrightBuilder in der Integration von Axe DevTools für Web Java Playwright

Not for use with personal data

Dieses Dokument bietet eine API-Referenz für die AxePlaywrightBuilder Java-Klasse, die von der Playwright Java-Integration bereitgestellt wird.

note

Die meisten Methoden in der AxePlaywrightBuilder-Klasse geben ein AxePlaywrightBuilder-Objekt zurück, das es Ihnen ermöglicht, mehrere Methoden einfach zu verketten. Siehe die untenstehenden Codebeispiele für Beispiele zur Methodenverkettung.

Konstruktoren

Konstruktor Beschreibung
AxePlaywrightBuilder(Page) Standardkonstruktor, der ein AxePlaywrightBuilder-Objekt erstellt.
AxePlaywrightBuilder(Page, File) Erstellen Sie ein AxePlaywrightBuilder-Objekt und geben Sie eine JSON-Datei mit benutzerdefinierten Regeln an, die während der Analyse verwendet werden soll.
AxePlaywrightBuilder(Page, String) Erstellen Sie ein AxePlaywrightBuilder-Objekt und geben Sie eine JSON-String mit benutzerdefinierten Regeln an.

AxePlaywrightBuilder(Page)

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

public AxePlaywrightBuilder(Page page);

Parameter

Name Typ Beschreibung
page com.microsoft.Playwright.Page Das Page-Objekt, das für die Barrierefreiheitsanalyse verwendet werden soll.

Beispiel

Das folgende Codebeispiel demonstriert diesen Konstruktor. Es zeigt auch, wie ein Page-Objekt und ein AxePlaywrightBuilder-Objekt mit diesem Page-Objekt erstellt werden.

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

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page);

AxePlaywrightBuilder(Page, File)

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

public AxePlaywrightBuilder(Page page, File rules);

Parameter

Name Typ Beschreibung
page com.microsoft.Playwright.Page Das erforderliche Page-Objekt.
rules File Ein File-Objekt, das eine JSON-Datei mit benutzerdefinierten Barrierefreiheitsregeln darstellt.

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 AxePlaywrightBuilder-Klasse mit dem angegebenen Page-Objekt und dem angegebenen String-Objekt, das benutzerdefinierte Regeln in einem JSON-String enthält.

public AxePlaywrightBuilder(Page page, String rules);

Parameter

Name Typ Beschreibung
page com.microsoft.Playwright.Page Das erforderliche Page-Objekt
rules String Ein JSON-String, der eine Reihe von benutzerdefinierten Zugänglichkeitsregeln darstellt.

Beispiel

Das folgende Codebeispiel veranschaulicht diesen Konstruktor.

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

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

Methoden

Methode Beschreibung
analyze Analysiert die Playwright-Seite und gibt ein AxeResults-Objekt aus der abgeschlossenen Analyse zurück.
configure(File) Bietet eine benutzerdefinierte Konfiguration, wie axe-core über eine JSON-Datei ausgeführt wird.
configure(String) Bietet eine benutzerdefinierte Konfiguration, wie axe-core über einen JSON-String ausgeführt wird.
disableRules Verhindert, dass die angegebenen Regeln während der Analyse ausgeführt werden.
exclude Gibt CSS-Selektoren an, um bestimmten HTML-Inhalt während der Analyse auszuschließen.
include Gibt CSS-Selektoren an, die HTML-Inhalte während der Analyse enthalten.
setLegacyMode Aktiviert den Legacy-Modus, um Zugänglichkeitsprobleme auszuschließen, die in Cross-Domain-Frames und -iframes auftreten können.
withAxeSource(File) Bietet eine benutzerdefinierte Version von axe-core mithilfe eines File-Objekts.
withAxeSource(String) Bietet eine benutzerdefinierte Version von axe-core mithilfe eines String-Objekts.
withOnlyBestPracticeRules Überprüft die Zugänglichkeit nur mit den Best-Practice-Regeln.
withOnlyExperimentalRules Überprüft die Zugänglichkeit nur mit den experimentellen Regeln.
withRules Begrenzt die Zugänglichkeitsregeln auf die angegebenen.
mitTags Begrenzen Sie die überprüften Zugänglichkeitsregeln auf die angegebene Liste von Tags.

analysieren

Analysieren Sie die Playwright-Seite (angegeben, als das AxePlaywrightBuilder-Objekt erstellt wurde) und geben Sie ein AxeResults-Objekt aus der abgeschlossenen Analyse zurück.

AxeResults AxePlaywrightBuilder.analyze();

Rückgabewerte

  • AxeResults

Beispiel

Das folgende Codebeispiel zeigt, wie die Methode 'analysieren' verwendet wird.


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
*/

konfigurieren(Datei)

Stellen Sie 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

Name Typ Beschreibung
Datei Datei Ein Datei-Objekt, das eine axe-core Konfiguration in JSON darstellt.

Beispiel

Das folgende Beispiel zeigt, wie eine Konfiguration aufgerufen und mit einem AxePlaywrightBuilder-Objekt verwendet wird.

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

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

konfigurieren(String)

Stellen Sie eine benutzerdefinierte Konfiguration für axe-core bereit (die zugrunde liegende Technologie zur Analyse der Zugänglichkeit), die über einen JSON-String ausgeführt wird.

public AxePlaywrightBuilder configure(String axeConfigure);

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

Parameter

Name Typ Beschreibung
axeConfig String Ein String-Objekt, das eine axe-core Konfiguration in JSON darstellt.

Beispiel

Das folgende Beispiel zeigt, wie eine Konfiguration aufgerufen und mit einem AxePlaywrightBuilder-Objekt verwendet wird.

String myAxeConfigure = "{..}"

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

Regeln deaktivieren

Deaktivieren Sie Regeln, um deren Ausführung während der Analyse zu verhindern.

public AxePlaywrightBuilder disableRules(List<String> rules);

Parameter

Name Typ Beschreibung
Regeln Liste<String> Eine Liste von Strings, die Regeln darstellen, die während der Analyse deaktiviert werden sollen.

Rückgabewerte

  • AxePlaywrightBuilder

Beispiel

Das folgende Beispiel zeigt, wie man die Barrierefreiheitsüberprüfung für eine einzelne Regel mithilfe der singletonList-Methode der Collections-Klasse und für mehrere Regeln mit einer Liste deaktiviert.

// 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

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

public AxePlaywrightBuilder exclude(List<String> excludeCSS);

Parameter

Name Typ Beschreibung
excludeCSS Liste<String> Eine Liste von CSS-Selektoren, die Elemente spezifiziert, die in einer Barrierefreiheitsanalyse nicht enthalten sein werden.

Rückgaben

  • AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man Elemente mit diesen Attributen von der Analyse ausschließt:

  • 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 man Elemente mit CSS-iframe-Selektoren ausschließt.

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

einschließen

CSS-Selektoren, die während der Analyse einbezogen werden sollen

public AxePlaywrightBuilder include(List<String> includeCSS);

Parameter

Name Typ Beschreibung
includeCSS Liste<String> Eine Liste von CSS-Selektoren, die Elemente spezifiziert, die in einer Barrierefreiheitsanalyse enthalten sein werden.

Rückgaben

  • AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man zwei verschiedene Klassen in die Analyse einbezieht. Beachten Sie, wie das Beispiel Methodenverkettung verwendet, um mehr als eine CSS-Klasse zu spezifizieren.

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

Das folgende Beispiel zeigt, wie man Elemente mit CSS-iframe-Selektoren einbezieht.

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

setLegacyMode

Schließt Barrierefreiheitsprobleme aus, die in cross-domain frames und iframes auftreten können.

public AxePlaywrightBuilder setLegacyMode(boolean legacyMode);
note

Diese API wird voraussichtlich in der nächsten Version von Axe DevTools entfernt.

Rückgaben

  • AxePlaywrightBuilder

Beispiele

Das folgende Beispiel schaltet den Legacy-Modus ein.

new AxePlaywrightBuilder(page)
        .setLegacyMode(true);

withAxeSource(File)

Stellen Sie eine benutzerdefinierte Version von axe-core mit dem Java File-Objekt bereit

public AxePlaywrightBuilder withAxeSource(File file);

Parameter

Name Typ Beschreibung
Datei Datei Eine Datei, die JavaScript enthält, das axe-core implementiert.

Rückgabe

  • AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man eine andere Datei für axe-core anstelle der bereitgestellten Version verwendet. Dies wäre nur in speziellen Fä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, indem Sie eine bereits geparste Quelle nutzen.

public AxePlaywrightBuilder withAxeSource(String src);

Parameter

Name Typ Beschreibung
src String Die JavaScript-Quelldatei, dargestellt als eine String.

Rückgabe

  • AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man eine Datei in eine String einliest und diese als Quelldatei mit withAxeSource verwendet.

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

new AxePlaywrightBuilder(page)
        .withAxeSource(source);

withOnlyBestPracticeRules

Überprüfen Sie auf Barrierefreiheitsprobleme mit nur dem Best-Practice-Regelsatz aktiviert.

public AxePlaywrightBuilder withOnlyBestPracticeRules();

Rückgabe

  • AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man die Barrierefreiheitsanalyse mit nur den Best-Practice-Regeln aktiviert.


new AxePlaywrightBuilder(page)
        .withOnlyBestPracticeRules();

withOnlyExperimentalRules

Überprüfen Sie auf Barrierefreiheitsprobleme mit nur dem experimentellen Regelsatz aktiviert.

public AxePlaywrightBuilder withOnlyExperimentalRules();

Rückgabe

  • AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man die Barrierefreiheitsanalyse mit nur den experimentellen Regeln aktiviert.


new AxePlaywrightBuilder(page)
        .withOnlyExperimentalRules();

withRules

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

public AxePlaywrightBuilder exclude(List<String> rules);

Parameter

Name Typ Beschreibung
regeln Liste<String> Eine Liste der Regeln, die für die Barrierefreiheitsanalyse verwendet werden sollen.

Rückgabe

  • AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt zwei verschiedene Möglichkeiten der Verwendung der withRules-Methode. Die erste erstellt eine Liste mit einer Regel, Farbkontrast. Die zweite erstellt eine Liste, die die Regeln Farbkontrast und Bildbeschreibung enthält.

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

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

mitTags

Begrenzt die Barrierefreiheitsanalyse auf den Regel- oder Regelsatz, der zu den angegebenen Tags gehört.

public AxePlaywrightBuilder withTags(List<String> tags);

Parameter

Name Typ Beschreibung
Tags Liste<String> Eine Liste von Tags, die die Regeln enthalten, die Sie in die Barrierefreiheitsanalyse einbeziehen möchten.

Rückgabewert

  • AxePlaywrightBuilder

Beispiele

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

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

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

Is this page helpful?

Help us improve this page

Still need help?