Classe AxeRunOptions

A classe AxeRunOptions fornece opções de configuração que controlam como o axe-core realiza os testes de acessibilidade. Esta classe permite habilitar ou desabilitar regras específicas, limitar quais regras são executadas e configurar detalhes de análise, como informações de ancestrais para violações de acessibilidade.

Essas opções são passadas para o axe-core em tempo de execução para personalizar o comportamento do mecanismo de análise de acessibilidade.

Construtor

AxeRunOptions()

Cria uma nova instância de AxeRunOptions com configurações padrão. Por padrão, a propriedade ancestry é definida para false.

AxeRunOptions options = new AxeRunOptions();

Métodos

setAncestry(boolean ancestry)

Define a propriedade ancestry. Quando definida para true, o motor axe-core incluirá o caminho completo do seletor CSS para elementos com violações de acessibilidade, incluindo todos os elementos pai. Isso ajuda a localizar violações em estruturas complexas de DOM.

Parâmetros:

• ancestry - Valor booleano para habilitar ou desabilitar informações de ancestrais

Retorna:

• AxeRunOptions - A instância atual para encadeamento de métodos

Exemplo:

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

setRunOnly(AxeRunOnly runOnly)

Define a propriedade runOnly, que permite limitar quais regras de acessibilidade são executadas. Use isso para focar os testes em padrões ou conjuntos de regras específicos.

Parâmetros:

• runOnly - Uma instância AxeRunOnly especificando quais regras ou tags executar

Retorna:

• AxeRunOptions - A instância atual para encadeamento de métodos

Exemplo:

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

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

setRules(Map<String, AxeRuleOptions> rules)

Define a propriedade rules, que permite habilitar ou desabilitar regras de acessibilidade específicas por ID.

Parâmetros:

• rules - Um mapa de IDs de regras para instâncias AxeRuleOptions

Retorna:

• AxeRunOptions - A instância atual para encadeamento de métodos

Exemplo:

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

Obtém o valor atual da propriedade ancestry.

Retorna:

• boolean - O valor atual da propriedade de ancestralidade

Exemplo:

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

getRunOnly()

Obtém a configuração atual de AxeRunOnly.

Retorna:

• AxeRunOnly - A configuração runOnly atual ou null se não definida

Exemplo:

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

Obtém o mapa atual de configurações de regras.

Retorna:

• Map<String, AxeRuleOptions> - A configuração atual de regras ou null se não definida

Exemplo:

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 a instância AxeRunOptions para uma string JSON.

Retorna:

• String - Uma representação em string JSON das opções

Exemplo:

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 sobre Validação de Configuração

Ao configurar AxeRunOptions, esteja ciente das seguintes regras de validação:

1. Ao usar setRules():

   • O mapa de regras deve conter pelo menos uma entrada.
   • Cada valor de regra não pode ser nulo.

2. Ao usar setRunOnly():

   • A propriedade type deve ser uma das seguintes: "rule", "rules", "tag" ou "tags"
   • A propriedade values deve conter pelo menos um valor
   • A propriedade values não pode conter entradas nulas

3. Configurações mutuamente exclusivas:

   • Você não pode usar tanto runOnly em AxeRunOptions quanto accessibilityStandard em ConfigurationOverrides ao mesmo tempo.

Veja também

• AxeRuleOptions
• AxeRunOnly
• AxeRunContext
• AxeWatcherOptions