API-Referenz für hamcrest

Referenz für die von dem hamcrest Paket bereitgestellten Typen.

Die Klassen IsAccessible und IsAuditedForAccessibility bieten die Hauptfunktionalität.

com.deque.html.axedevtools.matchers.AxeDevtoolsMatcher erweitert TypeSafeMatcher<AxeDriver>

Basisklasse AxeDevToolsMatcher. Kinderklassen wie IsAccessible oder IsAuditedForAccessibility sollten häufiger verwendet werden.

AxeDevtoolsMatcher within(final String... cssSelectors)

Fügen Sie CSS-Selektoren zum Kontext hinzu, der während eines Barrierefreiheitstests überprüft wird.

cssSelectors: CSS-Selektoren, die den Kontext darstellen.

Gibt AxeDevtoolsMatcher für Method Chaining zurück.

AxeDevtoolsMatcher within(final Selector... selectors)

Fügen Sie Selektoren zum Kontext hinzu, der während eines Barrierefreiheitstests überprüft wird.

selectors: Selektoren, die den Kontext darstellen.

Gibt AxeDevtoolsMatcher für Method Chaining zurück.

AxeDevtoolsMatcher excluding(final String... cssSelectors)

Schließen Sie CSS-Selektoren von dem Kontext aus, der während eines Barrierefreiheitstests überprüft wird.

cssSelectors: CSS-Selektoren, die den Kontext darstellen.

Gibt AxeDevtoolsMatcher für Method Chaining zurück.

AxeDevtoolsMatcher excluding(final Selector... selectors)

Schließen Sie Selektoren von dem Kontext aus, der während eines Barrierefreiheitstests überprüft wird.

selectors: Selektoren, die den Kontext darstellen.

Gibt AxeDevtoolsMatcher für Method Chaining zurück.

AxeDevtoolsMatcher accordingTo(final String... tags)

Gemäß Barrierefreiheitstags. Überprüfen Sie nur die angegebenen Barrierefreiheitstags. Diese Option ist unvereinbar mit checkingOnly. Siehe Regelbeschreibungen.

tags: Liste der Tags zur Überprüfung.

Gibt AxeDevtoolsMatcher für Method Chaining zurück.

AxeDevtoolsMatcher checkingOnly(final String... rules)

Prüfen Sie nur Barrierefreiheitsregeln. Diese Option ist unvereinbar mit accordingTo. Siehe Regelbeschreibungen.

rules: Liste der Regeln zur Überprüfung.

Gibt AxeDevtoolsMatcher für Method Chaining zurück.

AxeDevtoolsMatcher checking(final String... rules)

Überprüfen Sie Barrierefreiheitsregeln. Zusätzlich zu den angegebenen Tags auch bestimmte Regeln überprüfen. Siehe Regelbeschreibungen.

rules: Liste der Regeln zur Überprüfung.

Gibt AxeDevtoolsMatcher für Method Chaining zurück.

AxeDevtoolsMatcher skipping(final String... rules)

Barrierefreiheitsregeln überspringen. Innerhalb der angegebenen Tags das Prüfen bestimmter Regeln überspringen. Siehe Regelbeschreibungen.

rules: Liste der Regeln zur Überprüfung.

Gibt AxeDevtoolsMatcher für Method Chaining zurück.

AxeDevtoolsMatcher ignoring(final String selector, final String ruleId)

Ignorieren Sie Verstöße für einen Selektor und eine gegebene Regel-ID.

selector: Selektor, der durch den Axe-Barrierefreiheitscheck erzeugt wurde.

ruleId: Regel-ID, die für den gegebenen Selektor ignoriert werden soll.

Gibt AxeDevtoolsMatcher für Method Chaining zurück.

AxeDevtoolsMatcher forConfig(final URL auditPath)

Stellen Sie eine Audit-Suite über ihre URL bereit.

auditPath: die URL, die mit dem Prüfsatz verknüpft ist.

Gibt AxeDevtoolsMatcher für Methodenkettung zurück.

AxeDevtoolsMatcher forConfig(final String auditPath) throws MalformedURLException

Stellen Sie einen Prüfsatz bereit, indem Sie dessen Standort im Dateisystem angeben.

auditPath: Der absolute Dateipfad des Prüfsatzes. Gibt AxeDevtoolsMatcher für Methodenkettung zurück. Wirft MalformedURLException, wenn der Prüpfad ein ungültiger Dateisystempfad ist.

AxeDevtoolsMatcher logResults(final AxeReportingOptions reportingOptions)

Protokollieren Sie die Ergebnisse der Barrierefreiheitsprüfung nach Abschluss.

reportingOptions: Optionen, die die Serialisierung und Speicherung der Barrierefreiheitsprüfung definieren.

Gibt AxeDevtoolsMatcher für Methodenkettung zurück.

AxeDevtoolsMatcher forRuleset(final String rulesetId)

Geben Sie einen Regelsatz für die Barrierefreiheitsprüfung an. Die Konfiguration eines Prüfsatzes wird den angegebenen Regelsatz ändern. Siehe Regelsätze.

rulesetId: Die ID des Regelsatzes zur Konfiguration.

Gibt AxeDevtoolsMatcher für Methodenkettung zurück.

com.deque.html.axedevtools.matchers.IsAccessible extends AxeDevtoolsMatcher

Führen Sie eine axe-Barrierefreiheitsprüfung durch.

• Führen Sie die Barrierefreiheitsprüfung durch:
  • assertThat(page, isAxeClean())
• Definieren Sie den Kontext mit: (Überprüfen Sie das gesamte Dokument, indem Sie keines dieser verwenden)
  • within(String...)
  • within(Selector...)
  • excluding(String...)
  • excluding(Selector...)
• Definieren Sie die Optionen mit: (Überprüfen Sie alle von axe-Standards definierten Regeln, indem Sie diesen Schritt überspringen)
  • accordingTo(String...)
  • checkingOnly(String...)
  • checking(String...)
  • skipping(String...)
• Definieren Sie die Konfiguration Ihres Prüfsatzes: (Verwenden Sie den Standardstandort der Prüfkonfiguration, indem Sie diesen Schritt überspringen)
  • forConfig(URL)
  • forConfig(String)
• Definieren Sie die Protokollierungsoptionen für Ihren Konfigurationssatz: (Wenn nichts angegeben wird, wird kein Ergebnisprotokoll erstellt)
  • logResults(AxeReportingOptions)

Barrierefreiheitskontext und Optionen können verkettet werden:

assertThat(axeDevtoolsSelenium, isAxeClean()
  .within("#header")
  .within("#footer")
  .excluding(".graphics")
  .accordingTo("wcag2a", "wcag2aa"));

static IsAccessible isAxeClean()

Bestätigen Sie die Barrierefreiheit für die Webseite. Einzige Möglichkeit, eine IsAxeClean-Instanz zu erhalten.

Gibt einen neuen isAxeClean-Basismatcher zurück.

com.deque.html.axedevtools.matchers.IsAuditedForAccessibility extends AxeDevtoolsMatcher

Führen Sie ein Audit zur Barrierefreiheit Ihrer Seite durch. Das Audit wird Barrierefreiheitsprobleme in target/axe-report/accessibility-check.log protokollieren und ein JSON-Ausgabe der Ergebnisse in target/axe-report/accessibility-check.json erstellen.

Dieser Matcher wird niemals eine Assertion-Exception auslösen. Das Überwachen der Auditergebnisse auf Regressionen muss außerhalb von Fehlern/Erfolgen der Testreihe behandelt werden, wenn dieser Matcher verwendet wird.

• Führen Sie die Barrierefreiheitsaudit durch:
  • assertThat(page, isAuditedForAccessibility())
• Definieren Sie den Kontext mit: (Überprüfen Sie das gesamte Dokument, indem Sie keines dieser verwenden)
  • within(String...)
  • within(Selector...)
  • excluding(String...)
  • excluding(Selector...)
• Definieren Sie die Optionen mit: (Überprüfen Sie alle von axe-Standards definierten Regeln, indem Sie diesen Schritt überspringen)
  • accordingTo(String...)
  • checkingOnly(String...)
  • checking(String...)
  • skipping(String...)
• Definieren Sie die Konfiguration Ihres Prüfsatzes: (Verwenden Sie den Standardstandort der Prüfkonfiguration, indem Sie diesen Schritt überspringen)
  • forConfig(URL)
  • forConfig(String)
• Definieren Sie die Protokollierungsoptionen für Ihren Konfigurationssatz: (Wenn nichts angegeben wird, wird kein Ergebnisprotokoll erstellt)
  • logResults(AxeReportingOptions)

Barrierefreiheitskontext und Optionen können verkettet werden:

assertThat(axeDevtoolsSelenium, isAuditedForAccessibility()
  .within("#header")
  .within("#footer")
  .excluding(".graphics")
  .accordingTo("wcag2a", "wcag2aa"));

static IsAuditedForAccessibility isAuditedForAccessibility()

Bestätigen Sie, dass die Webseite auf Barrierefreiheit geprüft wurde. Einzige Möglichkeit, eine IsAuditedForAccessibility-Instanz zu erhalten.

Gibt einen neuen isAuditedForAccessibility-Basismatcher zurück.

interface com.deque.html.axedevtools.matchers.selectors.Selector

Schnittstelle, die Selektoren implementieren.

com.deque.html.axedevtools.matchers.selectors.ElementSelector implements Selector

ElementSelector(final String cssSelector)

Erstellen Sie einen Selektor für einen CSS-Selektor.

cssSelector: Ein CSS-Selektor.

com.deque.html.axedevtools.matchers.selectors.IFrameSelector implements Selector

IFrameSelector(final String frameSelector, final String cssSelector)

Erstellen Sie einen iFrame-Selektor.

frameSelector: CSS-Selektor, der den Standort des Frames auf der Seite repräsentiert.

cssSelector: CSS-Selektor, der das Webelement repräsentiert, das innerhalb des Frames auf Barrierefreiheit getestet wird.

IFrameSelector(final String frameSelector, final Selector selector)

iFrame-Selektor erstellen.

frameSelector: CSS-Selektor, der den Ort des Frames auf der Seite darstellt.

selector: Ein Selektor, der einen weiteren {@link IFrameSelector} oder einen {@link ElementSelector} repräsentiert