Riferimento API per 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

Riferimento API per la classe AxePlaywrightBuilder nell'integrazione Axe DevTools per Web Java Playwright

Not for use with personal data

Questo documento fornisce un riferimento API per la classe AxePlaywrightBuilder Java, che è fornita dall'integrazione Java di Playwright.

note

La maggior parte dei metodi nella classe AxePlaywrightBuilder restituisce un oggetto AxePlaywrightBuilder, il che consente di concatenare facilmente diversi metodi insieme. Vedere gli esempi di codice qui sotto per esempi di concatenazione di metodi.

Costruttori

Costruttore Descrizione
AxePlaywrightBuilder(Page) Costruttore standard che crea un oggetto AxePlaywrightBuilder.
AxePlaywrightBuilder(Page, File) Crea un oggetto AxePlaywrightBuilder e specifica un file JSON contenente regole personalizzate da utilizzare durante l'analisi.
AxePlaywrightBuilder(Page, String) Crea un oggetto AxePlaywrightBuilder specificando un String JSON contenente regole personalizzate.

AxePlaywrightBuilder(Page)

Inizializza una nuova istanza della classe AxePlaywrightBuilder per l'oggetto Page specificato.

public AxePlaywrightBuilder(Page page);

Parametri

Nome Tipo Descrizione
pagina com.microsoft.Playwright.Page L'oggetto Page da utilizzare per l'analisi dell'accessibilità.

Esempio

Il seguente esempio di codice dimostra questo costruttore. Mostra anche come creare un oggetto Pagina e un oggetto AxePlaywrightBuilder con quell'oggetto Pagina.

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

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page);

AxePlaywrightBuilder(Page, File)

Inizializza una nuova istanza della classe AxePlaywrightBuilder con l'oggetto Pagina specificato e l'oggetto File specificato. L'oggetto File contiene regole personalizzate in un file JSON.

public AxePlaywrightBuilder(Page page, File rules);

Parametri

Nome Tipo Descrizione
pagina com.microsoft.Playwright.Page L'oggetto Page richiesto.
regole File Un oggetto File che rappresenta un file JSON di regole di accessibilità personalizzate.

Esempio

Il seguente esempio mostra come utilizzare questo costruttore.

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

File customRuleset = new File("somePath/custom-ruleset.json")
AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page, customRuleset);

AxePlaywrightBuilder(Page, String)

Inizializza una nuova istanza della classe AxePlaywrightBuilder con l'oggetto Page specificato e l'oggetto String specificato, che contiene regole personalizzate in una stringa JSON.

public AxePlaywrightBuilder(Page page, String rules);

Parametri

Nome Tipo Descrizione
page com.microsoft.Playwright.Page L'oggetto Page richiesto
regole String Una stringa JSON che rappresenta un insieme di regole di accessibilità personalizzate.

Esempio

Il seguente esempio di codice dimostra questo costruttore.

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

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

Metodi

Metodo Descrizione
analizza Analizza la pagina Playwright e restituisce un oggetto AxeResults dall'analisi completata.
configura(File) Fornisci una configurazione personalizzata su come axe-core è eseguito tramite un file JSON.
configura(String) Fornisci una configurazione personalizzata su come axe-core è eseguito tramite una stringa JSON.
disabilitaRegole Impedisce l'esecuzione delle regole specificate durante l'analisi.
escludi Specifica i selettori CSS da utilizzare per escludere alcuni contenuti HTML durante l'analisi.
includi Specifica i selettori CSS che includono contenuti HTML durante l'analisi.
setModalitàLegacy Imposta la modalità legacy per escludere problemi di accessibilità che possono verificarsi in frame e iframe cross-domain.
conAxeSource(File) Fornisci una versione personalizzata di axe-core utilizzando un oggetto File.
conAxeSource(String) Fornisci una versione personalizzata di axe-core utilizzando un oggetto String.
conSoloRegoleBestPractice Verifica l'accessibilità usando solo le regole migliori pratiche.
conSoloRegoleSperimentali Verifica l'accessibilità usando solo le regole sperimentali.
conRegole Limita le regole di accessibilità a quelle specificate.
conEtichette Limita le regole di accessibilità controllate alla lista specificata di etichette.

analizzare

Analizza la pagina di Playwright (specificata quando è stato creato l'oggetto AxePlaywrightBuilder) e restituisci un oggetto AxeResults dall'analisi completata.

AxeResults AxePlaywrightBuilder.analyze();

Restituisce

  • AxeResults

Esempio

Il seguente esempio di codice dimostra come usare il metodo di analisi.


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

configura(File)

Fornisci una configurazione personalizzata ad axe-core tramite un file JSON.

public AxePlaywrightBuilder configure(File axeConfigure);

Per ulteriori informazioni sul formato del file di configurazione, vedi configurazione axe-core.

Parametri

Nome Tipo Descrizione
file File Un oggetto File che rappresenta una configurazione axe-core in JSON.

Esempio

Il seguente esempio mostra come accedere a una configurazione e usarla con un oggetto AxePlaywrightBuilder.

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

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

configura(String)

Fornisci una configurazione personalizzata ad axe-core (la tecnologia sottostante per analizzare l'accessibilità) eseguita tramite una stringa JSON.

public AxePlaywrightBuilder configure(String axeConfigure);

Per ulteriori informazioni sul formato del file di configurazione, vedi configurazione axe-core.

Parametri

Nome Tipo Descrizione
axeConfig Stringa Un oggetto Stringa che rappresenta una configurazione axe-core in JSON.

Esempio

Il seguente esempio mostra come accedere a una configurazione e usarla con un oggetto AxePlaywrightBuilder.

String myAxeConfigure = "{..}"

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

disabilitaRegole

Disabilita le regole dall'esecuzione durante l'analisi.

public AxePlaywrightBuilder disableRules(List<String> rules);

Parametri

Nome Tipo Descrizione
regole Elenco<Stringa> Un elenco di stringhe che rappresentano le regole da disabilitare durante l'analisi.

Restituisce

  • AxePlaywrightBuilder

Esempio

Il seguente esempio mostra come disabilitare il controllo dell'accessibilità per una singola regola usando il metodo singletonList della classe Collections e per più regole usando una List.

// 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"));

escludere

Specifica i selettori CSS per escludere elementi HTML durante l'analisi.

public AxePlaywrightBuilder exclude(List<String> excludeCSS);

Parametri

Nome Tipo Descrizione
excludeCSS List<String> Un elenco di selettori CSS che specificano gli elementi che non saranno inclusi in un'analisi di accessibilità.

Ritorna

  • AxePlaywrightBuilder

Esempi

Il seguente esempio mostra come escludere elementi dall'analisi con questi attributi:

  • class="some-class"
  • class="some-other-class"
new AxePlaywrightBuilder(page)
        .exclude(Collections.singletonList(".some-class"))
        .exclude(Collections.singletonList(".some-other-class"));

Il seguente esempio mostra come escludere elementi utilizzando selettori CSS per iframe.

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

includere

Selettori CSS da includere durante l'analisi

public AxePlaywrightBuilder include(List<String> includeCSS);

Parametri

Nome Tipo Descrizione
includeCSS List<String> Un elenco di selettori CSS che specificano gli elementi che saranno inclusi in un'analisi di accessibilità.

Ritorna

  • AxePlaywrightBuilder

Esempi

Il seguente esempio mostra come includere due classi diverse nell'analisi. Nota come l'esempio utilizza il metodo chaining per specificare più di una classe CSS.

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

Il seguente esempio mostra come includere elementi utilizzando selettori CSS per iframe.

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

impostaModalitàLegacy

Esclude i problemi di accessibilità che possono verificarsi nei frame e iframe cross-domain.

public AxePlaywrightBuilder setLegacyMode(boolean legacyMode);
note

Si prevede che questa API venga rimossa nella prossima versione di Axe DevTools.

Ritorna

  • AxePlaywrightBuilder

Esempi

Il seguente esempio attiva la modalità legacy.

new AxePlaywrightBuilder(page)
        .setLegacyMode(true);

conAxeSource(File)

Fornisce una versione personalizzata di axe-core utilizzando l'oggetto File di Java

public AxePlaywrightBuilder withAxeSource(File file);

Parametri

Nome Tipo Descrizione
file File Un file contenente JavaScript che implementa axe-core.

Ritorna

  • AxePlaywrightBuilder

Esempi

Il seguente esempio mostra come utilizzare un file diverso per axe-core invece della versione fornita. Avresti bisogno di farlo solo in casi specializzati.

File axeLegacySource = new File("somepath/axe-core@legacy.js");

new AxePlaywrightBuilder(page)
        .withAxeSource(axeLegacySource);

withAxeSource(String)

Fornire una versione personalizzata di axe-core utilizzando una sorgente già analizzata

public AxePlaywrightBuilder withAxeSource(String src);

Parametri

Nome Tipo Descrizione
src String Il file sorgente JavaScript rappresentato come un String.

Ritorna

  • AxePlaywrightBuilder

Esempi

Il seguente esempio mostra come leggere un file in un String e utilizzarlo come file sorgente con withAxeSource.

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

new AxePlaywrightBuilder(page)
        .withAxeSource(source);

withOnlyBestPracticeRules

Controllare i problemi di accessibilità con solo il set di regole best-practice abilitato.

public AxePlaywrightBuilder withOnlyBestPracticeRules();

Ritorna

  • AxePlaywrightBuilder

Esempi

Il seguente esempio mostra come abilitare l'analisi dell'accessibilità utilizzando solo le regole di best practice.


new AxePlaywrightBuilder(page)
        .withOnlyBestPracticeRules();

withOnlyExperimentalRules

Controllare i problemi di accessibilità con solo il set di regole sperimentali abilitato

public AxePlaywrightBuilder withOnlyExperimentalRules();

Ritorna

  • AxePlaywrightBuilder

Esempi

Il seguente esempio mostra come abilitare l'analisi dell'accessibilità utilizzando solo le regole sperimentali.


new AxePlaywrightBuilder(page)
        .withOnlyExperimentalRules();

withRules

Limitare le regole da eseguire durante l'analisi dell'accessibilità a quelle specificate.

public AxePlaywrightBuilder exclude(List<String> rules);

Parametri

Nome Tipo Descrizione
regole List<String> Una lista di regole da utilizzare per l'analisi dell'accessibilità.

Ritorna

  • AxePlaywrightBuilder

Esempi

Il seguente esempio mostra due diversi modi di utilizzare il metodo withRules. Il primo crea un Lista con una regola, contrasto-colori. Il secondo crea un Lista contenente le regole contrasto dei colori e alt dell'immagine.

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

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

conTag

Limita l'analisi dell'accessibilità al set di regole o ai set di regole appartenenti ai tag specificati.

public AxePlaywrightBuilder withTags(List<String> tags);

Parametri

Nome Tipo Descrizione
tag List<String> Un elenco di tag che includono le regole che si desidera includere nell'analisi dell'accessibilità.

Restituisce

  • AxePlaywrightBuilder

Esempi

Questo esempio mostra come limitare l'analisi dell'accessibilità alle regole appartenenti ai tag specificati. Il primo frammento di codice mostra come limitare l'analisi alle regole che fanno parte della specifica wcag21aa. Il secondo frammento mostra come limitare l'analisi alla specifica wcag21aa e alle regole migliori pratiche.

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