Validador de accesibilidad – Comprobación de la accesibilidad del sitio web
Crear validador
Aspose.HTML for Java proporciona el paquete com.aspose.html.accessibility, que sirve para todas las manipulaciones y comprobaciones relacionadas con la accesibilidad web. La clase AccessibilityValidator inicializa un objeto que se utiliza para validar el documento según los criterios de éxito WCAG. La clase no tiene un constructor interno, por lo que los usuarios no pueden crear directamente un objeto de la clase. Para crear un objeto, es necesario utilizar el contenedor WebAccessibility.
Para crear un validador, inicialice el objeto de la clase WebAccessibility de la siguiente manera:
1 // Initialize webAccessibility container
2 WebAccessibility webAccessibility = new WebAccessibility();
El objeto webAccessibility
tiene varios métodos sobrecargados
createValidator() para crear una instancia AccessibilityValidator
con distintos niveles de personalización. Estos métodos permiten crear validadores utilizando todas las reglas predeterminadas, una regla específica o una lista de reglas, y pueden personalizarse utilizando un objeto ValidationBuilder
. Este enfoque flexible permite realizar comprobaciones de accesibilidad tanto sencillas como muy personalizadas.
Los siguientes ejemplos Java muestran cómo inicializar un AccessibilityValidator
para todas las reglas disponibles o para un subconjunto específico basado en un único principio de accesibilidad:
Ejemplo 1. Crear un validador para comprobar todas las reglas Crear un validador para comprobar todas las reglas
Este ejemplo muestra cómo inicializar un AccessibilityValidator
que incluya todas las reglas de accesibilidad disponibles utilizando la configuración integral predeterminada proporcionada por ValidationBuilder.getAll()
:
1// Initialize the webAccessibility container
2WebAccessibility webAccessibility = new WebAccessibility();
3
4// Create an accessibility validator with all rules using the default settings
5AccessibilityValidator validator = webAccessibility.createValidator(ValidationBuilder.getAll());
Ejemplo 2. Crear un validador para un principio específico Crear un validador para un principio específico
En este ejemplo, se selecciona un principio de accesibilidad específico utilizando su código (por ejemplo, “1”), y se crea un validador sólo para las reglas bajo ese principio:
1// Retrieve a specific principle by its code
2IRule rule = webAccessibility.getRules().getPrinciple("1");
3
4// Create a validator for that principle using the same default settings
5AccessibilityValidator validatorRule = webAccessibility.createValidator(rule, ValidationBuilder.getAll());
Clase ValidationBuilder
La clase
ValidationBuilder define una clase de ayuda que puede utilizarse para personalizar la lista de reglas a comprobar por el validador. El ValidationBuilder
define métodos y proporciona implementaciones concretas de los pasos de configuración.
La clase ValidationBuilder
ofrece tres propiedades predefinidas:
- All – activa todos los niveles y tecnologías,
- Default – activa sólo las tecnologías generales en el nivel más bajo,
- None – no se aplica ninguna configuración.
La clase también proporciona métodos para personalizar la validación, como seleccionar tecnologías específicas (
useHTML(),
useCSS(),
useScript()), establecer niveles de criterios (useLowestLevel()
, useMiddleLevel()
, useHighestLevel()
, allLevels()
), etc.
Por ejemplo, el siguiente código Java inicializa AccessibilityValidator
para realizar comprobaciones de accesibilidad basadas en la configuración del usuario. Comienza creando un contenedor WebAccessibility
, que sirve como punto de acceso principal para las funciones de validación. Después, utilizando ValidationBuilder.getNone()
, crea un validador sin reglas predefinidas. A partir de ahí, habilita explícitamente comprobaciones para las tecnologías HTML y CSS y limita la validación a un nivel de conformidad medio (normalmente WCAG Nivel AA). Esta configuración permite una validación específica, basada en estándares, que se centra sólo en tecnologías seleccionadas y en un nivel de conformidad específico.
1// Initialize the WebAccessibility container
2WebAccessibility webAccessibility = new WebAccessibility();
3
4// Create a validator with no predefined filters, enabling HTML and CSS technologies, and selecting the middle conformance levels
5AccessibilityValidator validatorHTML = webAccessibility.createValidator(
6 ValidationBuilder.getNone()
7 .useHTML()
8 .useCSS()
9 .useMiddleLevel()
10);
Clase ValidationResult
La clase
ValidationResult es el componente central de la validación de accesibilidad web. Encapsula los resultados de las comprobaciones de accesibilidad, proporcionando una forma estructurada de analizar, gestionar y actuar sobre los resultados de las operaciones de validación. Para utilizarla, instancie un objeto validador e invoque el método
validate(document
), introduciendo el documento a validar. El método devuelve un objeto ValidationResult
que contiene los resultados del proceso de validación.
La clase ValidationResult
agrega los resultados de todos los criterios definidos en el objeto AccessibilityRules
, sirviendo como contenedor principal para informar de los resultados de la validación. Incluye dos propiedades clave:
- Details, que proporciona resultados detallados para cada criterio comprobado;
- Success, que indica el estado general de la validación (correcto/incorrecto).
Para facilitar la exportación de resultados y la generación de informes, la clase proporciona varios métodos: saveTo(TextWriter)
y saveTo(TextWriter, ValidationResultSaveFormat)
permiten guardar los resultados en el flujo de salida especificado, mientras que saveToString()
devuelve los resultados de la validación como una String
formateada.
Puede encontrar una descripción más completa en el artículo Resultados de validación – Comprobar la accesibilidad web en Java.
Validar un documento HTML
Para realizar la validación de un documento, siga estos pasos:
- Utilice el constructor WebAccessibility() para crear una instancia de la clase WebAccessibility.
- Llame a uno de los métodos
createValidator() para crear un objeto
validator
. - Cargar un documento HTML utilizando uno de los constructores HTMLDocument().
- Utilice el método
validate(
document
) para validar el documento según las reglas de accesibilidad web. - El resultado de la validación es una instancia de la clase ValidationResult.
- Imprime los resultados de la validación en la consola y utilízalos si es necesario para análisis posteriores.
He aquí un ejemplo de llamada a la validación de un documento. El siguiente código Java escribirá en la consola cuáles de las reglas pasaron la prueba y cuáles no:
1// Initialize a webAccessibility container
2WebAccessibility webAccessibility = new WebAccessibility();
3
4// Create an accessibility validator with static instance for all rules
5// from repository that match the builder settings
6AccessibilityValidator validator = webAccessibility.createValidator(ValidationBuilder.getAll());
7
8// Prepare a path to a source HTML file
9String documentPath = "input.html";
10
11// Initialize an object of the HTMLDocument class
12final HTMLDocument document = new HTMLDocument(documentPath);
13ValidationResult validationResult = validator.validate(document);
14
15// Checking for success
16if (!validationResult.getSuccess()) {
17 // Get a list of RuleValidationResult Details
18 for (RuleValidationResult detail : validationResult.getDetails()) {
19 System.out.println(String.format("%s: %s = %s",
20 detail.getRule().getCode(),
21 detail.getRule().getDescription(),
22 detail.getSuccess()));
23 }
24}
Ver también
- Encontrará consejos útiles para evaluar y mejorar la visibilidad del texto en el artículo Accesibilidad del contraste de color, que aborda la comprobación de contraste basada en WCAG con Aspose.HTML for Java.
- Para obtener instrucciones sobre cómo comprobar la compatibilidad del contenido web con lectores de pantalla, consulte el artículo Accesibilidad de lectores de pantalla. Aprenderá a comprobar el texto alternativo y otros elementos clave.
- Si desea aprender a ver los resultados de la validación e identificar problemas de accesibilidad web, consulte el artículo Resultados de la validación.
- En el artículo
Comprobación de accesibilidad web – Errores y advertencias, aprenderá cómo recopilar programáticamente en Java información de errores y advertencias mientras se verifica la accesibilidad de un sitio web.
Aspose.HTML ofrece un Comprobador de accesibilidad web en línea gratuito. Esta herramienta escanea páginas web, valida su conformidad con las WCAG, identifica problemas y sugiere mejoras. Obtenga información instantánea sobre la conformidad de su sitio web, lo que le permitirá determinar el alcance de las correcciones necesarias y la diferencia entre el estado actual de su sitio web o documento HTML y los requisitos WCAG.