com.deque.axe

Class AXE

java.lang.Object

com.deque.axe.AXE

public class AXE
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AXE.AxeRuntimeException AxeRuntimeException represents an error returned from `axe.run()`.
static class	AXE.Builder Chainable builder for invoking aXe.

Constructor Summary

Constructors

Constructor and Description
AXE()

Method Summary

Modifier and Type	Method and Description
static void	inject(org.openqa.selenium.WebDriver driver, URL scriptUrl) Recursively injects a script into all iframes and the top level document.
static void	inject(org.openqa.selenium.WebDriver driver, URL scriptUrl, Boolean skipFrames) Recursively injects a script to the top level document with the option to skip iframes.
static String	report(org.json.JSONArray violations)
static void	writeResults(String name, Object output) Writes a raw object out to a JSON file with the specified name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AXE

public AXE()

Method Detail

inject

public static void inject(org.openqa.selenium.WebDriver driver,
                          URL scriptUrl,
                          Boolean skipFrames)

Recursively injects a script to the top level document with the option to skip iframes.

Parameters:

driver - WebDriver instance to inject into

scriptUrl - URL to the script to inject

skipFrames - True if the script should not be injected into iframes

inject

public static void inject(org.openqa.selenium.WebDriver driver,
                          URL scriptUrl)

Recursively injects a script into all iframes and the top level document.

Parameters:

driver - WebDriver instance to inject into

scriptUrl - URL to the script to inject

report

public static String report(org.json.JSONArray violations)

Parameters:

violations - JSONArray of violations

Returns:

readable report of accessibility violations found

writeResults

public static void writeResults(String name,
                                Object output)

Writes a raw object out to a JSON file with the specified name.

Parameters:

name - Desired filename, sans extension

output - Object to write. Most useful if you pass in either the Builder.analyze() response or the violations array it contains.