Clase AxeRunOptions

La clase AxeRunOptions proporciona opciones de configuración que controlan cómo axe-core realiza pruebas de accesibilidad. Esta clase te permite activar o desactivar reglas específicas, limitar qué reglas se ejecutan y configurar detalles de análisis como la información de ancestros para violaciones de accesibilidad.

Estas opciones se pasan a axe-core en tiempo de ejecución para personalizar el comportamiento del motor de análisis de accesibilidad.

Constructor

AxeRunOptions()

Crea una nueva instancia de AxeRunOptions con configuraciones predeterminadas. Por defecto, la propiedad ancestry se establece en false.

AxeRunOptions options = new AxeRunOptions();

Métodos

setAncestry(boolean ancestry)

Establece la propiedad ancestry. Cuando se establece en true, el motor axe-core incluirá la ruta completa del selector CSS para elementos con violaciones de accesibilidad, incluyendo todos los elementos padre. Esto ayuda a localizar violaciones en estructuras DOM complejas.

Parámetros:

• ancestry - Valor booleano para habilitar o deshabilitar la información de ancestros

Retorna:

• AxeRunOptions - La instancia actual para encadenamiento de métodos

Ejemplo:

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

setRunOnly(AxeRunOnly runOnly)

Establece la propiedad runOnly, lo que te permite limitar qué reglas de accesibilidad se ejecutan. Usa esto para centrar las pruebas en estándares específicos o conjuntos de reglas.

Parámetros:

• runOnly - Una instancia de AxeRunOnly que especifica qué reglas o etiquetas ejecutar

Retorna:

• AxeRunOptions - La instancia actual para encadenamiento de métodos

Ejemplo:

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

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

setRules(Map<String, AxeRuleOptions> rules)

Establece la propiedad rules, lo que te permite habilitar o deshabilitar reglas específicas de accesibilidad por ID.

Parámetros:

• rules - Un mapa de IDs de reglas a instancias de AxeRuleOptions

Retorna:

• AxeRunOptions - La instancia actual para encadenamiento de métodos

Ejemplo:

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

Obtiene el valor actual de la propiedad ancestry.

Retorna:

• boolean - El valor actual de la propiedad de ancestros

Ejemplo:

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

getRunOnly()

Obtiene la configuración actual de AxeRunOnly.

Retorna:

• AxeRunOnly - La configuración actual de runOnly, o null si no está establecida

Ejemplo:

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

Obtiene el mapa actual de configuraciones de reglas.

Retorna:

• Map<String, AxeRuleOptions> - La configuración actual de reglas, o null si no está establecida

Ejemplo:

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

Serializa la instancia de AxeRunOptions a una cadena JSON.

Retorna:

• String - Una representación en cadena JSON de las opciones

Ejemplo:

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

Notas de Validación de Configuración

Al configurar AxeRunOptions, ten en cuenta las siguientes reglas de validación:

1. Al usar setRules():

   • El mapa de reglas debe contener al menos una entrada.
   • Cada valor de regla no puede ser nulo.

2. Al usar setRunOnly():

   • La propiedad type debe ser una de las siguientes: "rule", "rules", "tag" o "tags"
   • La propiedad values debe contener al menos un valor
   • La propiedad values no puede contener entradas nulas

3. Configuraciones mutuamente excluyentes:

   • No puedes usar tanto runOnly en AxeRunOptions como accessibilityStandard en ConfigurationOverrides al mismo tiempo.

Ver también

• AxeRuleOptions
• AxeRunOnly
• AxeRunContext
• AxeWatcherOptions