Skip to content

Commit c3df8c4

Browse files
author
Pavel Terechshenkov
committed
add java accessibility
1 parent 3d2b46b commit c3df8c4

File tree

71 files changed

+2042
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+2042
-0
lines changed

‎english/java/aspose.html.accessibility.results/_index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: com.aspose.html.Accessibility.Results
3+
second_title: Aspose.HTML for Java API Reference
4+
description: The com.aspose.html.Accessibility.Results package contains classes that describe the results of rule validation
5+
type: docs
6+
weight: 30
7+
url: /java/com.aspose.html.accessibility.results/
8+
---
9+
The **com.aspose.html.Accessibility.Results** package contains classes that describe the results of rule validation
10+
11+
## Classes
12+
13+
| Class | Description |
14+
| --- | --- |
15+
| [RuleValidationResult](./rulevalidationresult/) | Class - result of rule check, contains a list of [`ITechniqueResult`](../com.aspose.html.accessibility/itechniqueresult/), which are ways to satisfy the success criteria. |
16+
| [ValidationResult](./validationresult/) | The main result class, that contains Results for all Criterion from AccessibilityRules object. |

‎english/java/aspose.html.accessibility.results/rulevalidationresult/_index.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: RuleValidationResult Class
3+
second_title: Aspose.HTML for Java API Reference
4+
description: com.aspose.html.Accessibility.Results.RuleValidationResult class. Class - result of rule check contains a list of ITechniqueResult which are ways to satisfy the success criteria
5+
type: docs
6+
weight: 90
7+
url: /java/com.aspose.html.accessibility.results/rulevalidationresult/
8+
---
9+
## RuleValidationResult class
10+
11+
Class - result of rule check, contains a list of [`ITechniqueResult`](../../com.aspose.html.accessibility/itechniqueresult/), which are ways to satisfy the success criteria.
12+
13+
```java
14+
public class RuleValidationResult
15+
```
16+
17+
## Properties
18+
19+
| Name | Description |
20+
| --- | --- |
21+
| [getErrors](../../com.aspose.html.accessibility.results/rulevalidationresult/errors/) Collection of results with Errors |
22+
| [getResults](../../com.aspose.html.accessibility.results/rulevalidationresult/results/) Collection of [`ITechniqueResult`](../../com.aspose.html.accessibility/itechniqueresult/) on rule validation. |
23+
| [getRule](../../com.aspose.html.accessibility.results/rulevalidationresult/rule/) Rule that has been tested. |
24+
| [getSuccess](../../com.aspose.html.accessibility.results/rulevalidationresult/success/) Returns the result of rule validation. |
25+
| [getWarnings](../../com.aspose.html.accessibility.results/rulevalidationresult/warnings/) Collection of results with Warnings |
26+
27+
### See Also
28+
29+
* package [com.aspose.html.Accessibility.Results](../../com.aspose.html.accessibility.results/)
30+
* package [Aspose.HTML](../../)

‎english/java/aspose.html.accessibility.results/rulevalidationresult/errors/_index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: RuleValidationResult.Errors
3+
second_title: Aspose.HTML for Java API Reference
4+
description: RuleValidationResult property. Collection of results with Errors
5+
type: docs
6+
weight: 10
7+
url: /java/com.aspose.html.accessibility.results/rulevalidationresult/errors/
8+
---
9+
## RuleValidationResult.Errors property
10+
11+
Collection of results with Errors
12+
13+
```java
14+
public IList<ITechniqueResult> Errors { get; }
15+
```
16+
17+
### See Also
18+
19+
* interface [ITechniqueResult](../../../com.aspose.html.accessibility/itechniqueresult/)
20+
* class [RuleValidationResult](../)
21+
* package [com.aspose.html.Accessibility.Results](../../../com.aspose.html.accessibility.results/)
22+
* package [Aspose.HTML](../../../)

‎english/java/aspose.html.accessibility.results/rulevalidationresult/results/_index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: RuleValidationResult.Results
3+
second_title: Aspose.HTML for Java API Reference
4+
description: RuleValidationResult property. Collection of ITechniqueResult on rule validation
5+
type: docs
6+
weight: 20
7+
url: /java/com.aspose.html.accessibility.results/rulevalidationresult/results/
8+
---
9+
## RuleValidationResult.Results property
10+
11+
Collection of [`ITechniqueResult`](../../../com.aspose.html.accessibility/itechniqueresult/) on rule validation.
12+
13+
```java
14+
public IList<ITechniqueResult> Results { get; }
15+
```
16+
17+
### See Also
18+
19+
* interface [ITechniqueResult](../../../com.aspose.html.accessibility/itechniqueresult/)
20+
* class [RuleValidationResult](../)
21+
* package [com.aspose.html.Accessibility.Results](../../../com.aspose.html.accessibility.results/)
22+
* package [Aspose.HTML](../../../)

‎english/java/aspose.html.accessibility.results/rulevalidationresult/rule/_index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: RuleValidationResult.Rule
3+
second_title: Aspose.HTML for Java API Reference
4+
description: RuleValidationResult property. Rule that has been tested
5+
type: docs
6+
weight: 30
7+
url: /java/com.aspose.html.accessibility.results/rulevalidationresult/rule/
8+
---
9+
## RuleValidationResult.Rule property
10+
11+
Rule that has been tested.
12+
13+
```java
14+
public IRule Rule { get; }
15+
```
16+
17+
### See Also
18+
19+
* interface [IRule](../../../com.aspose.html.accessibility/irule/)
20+
* class [RuleValidationResult](../)
21+
* package [com.aspose.html.Accessibility.Results](../../../com.aspose.html.accessibility.results/)
22+
* package [Aspose.HTML](../../../)

‎english/java/aspose.html.accessibility.results/rulevalidationresult/success/_index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: RuleValidationResult.Success
3+
second_title: Aspose.HTML for Java API Reference
4+
description: RuleValidationResult property. Returns the result of rule validation
5+
type: docs
6+
weight: 40
7+
url: /java/com.aspose.html.accessibility.results/rulevalidationresult/success/
8+
---
9+
## RuleValidationResult.Success property
10+
11+
Returns the result of rule validation.
12+
13+
```java
14+
public bool Success { get; }
15+
```
16+
17+
### See Also
18+
19+
* class [RuleValidationResult](../)
20+
* package [com.aspose.html.Accessibility.Results](../../../com.aspose.html.accessibility.results/)
21+
* package [Aspose.HTML](../../../)

‎english/java/aspose.html.accessibility.results/rulevalidationresult/warnings/_index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: RuleValidationResult.Warnings
3+
second_title: Aspose.HTML for Java API Reference
4+
description: RuleValidationResult property. Collection of results with Warnings
5+
type: docs
6+
weight: 50
7+
url: /java/com.aspose.html.accessibility.results/rulevalidationresult/warnings/
8+
---
9+
## RuleValidationResult.Warnings property
10+
11+
Collection of results with Warnings
12+
13+
```java
14+
public IList<ITechniqueResult> Warnings { get; }
15+
```
16+
17+
### See Also
18+
19+
* interface [ITechniqueResult](../../../com.aspose.html.accessibility/itechniqueresult/)
20+
* class [RuleValidationResult](../)
21+
* package [com.aspose.html.Accessibility.Results](../../../com.aspose.html.accessibility.results/)
22+
* package [Aspose.HTML](../../../)

‎english/java/aspose.html.accessibility.results/validationresult/_index.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: ValidationResult Class
3+
second_title: Aspose.HTML for Java API Reference
4+
description: com.aspose.html.Accessibility.Results.ValidationResult class. The main result class that contains Results for all Criterion from AccessibilityRules object
5+
type: docs
6+
weight: 100
7+
url: /java/com.aspose.html.accessibility.results/validationresult/
8+
---
9+
## ValidationResult class
10+
11+
The main result class, that contains Results for all Criterion from AccessibilityRules object.
12+
13+
```java
14+
public class ValidationResult
15+
```
16+
17+
## Properties
18+
19+
| Name | Description |
20+
| --- | --- |
21+
| [getDetails](../../com.aspose.html.accessibility.results/validationresult/details/) Validation result details |
22+
| [getSuccess](../../com.aspose.html.accessibility.results/validationresult/success/) The result of validation. |
23+
24+
## Methods
25+
26+
| Name | Description |
27+
| --- | --- |
28+
| [saveTo](../../com.aspose.html.accessibility.results/validationresult/saveto/#saveto)(TextWriter) | Save validation results to the TextWriter object |
29+
| [saveTo](../../com.aspose.html.accessibility.results/validationresult/saveto/#saveto_1)(TextWriter, ValidationResultSaveFormat) | Save validation results to the TextWriter object |
30+
| [saveToString](../../com.aspose.html.accessibility.results/validationresult/savetoString/)() | Save validation results to String |
31+
32+
### See Also
33+
34+
* package [com.aspose.html.Accessibility.Results](../../com.aspose.html.accessibility.results/)
35+
* package [Aspose.HTML](../../)

‎english/java/aspose.html.accessibility.results/validationresult/details/_index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: ValidationResult.Details
3+
second_title: Aspose.HTML for Java API Reference
4+
description: ValidationResult property. Validation result details
5+
type: docs
6+
weight: 10
7+
url: /java/com.aspose.html.accessibility.results/validationresult/details/
8+
---
9+
## ValidationResult.Details property
10+
11+
Validation result details
12+
13+
```java
14+
public IList<RuleValidationResult> Details { get; }
15+
```
16+
17+
### See Also
18+
19+
* class [RuleValidationResult](../../rulevalidationresult/)
20+
* class [ValidationResult](../)
21+
* package [com.aspose.html.Accessibility.Results](../../../com.aspose.html.accessibility.results/)
22+
* package [Aspose.HTML](../../../)

‎english/java/aspose.html.accessibility.results/validationresult/saveto/_index.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: ValidationResult.SaveTo
3+
second_title: Aspose.HTML for Java API Reference
4+
description: ValidationResult method. Save validation results to the TextWriter object
5+
type: docs
6+
weight: 30
7+
url: /java/com.aspose.html.accessibility.results/validationresult/saveto/
8+
---
9+
## SaveTo(TextWriter, ValidationResultSaveFormat) {#saveto_1}
10+
11+
Save validation results to the TextWriter object
12+
13+
```java
14+
public void SaveTo(TextWriter writer, ValidationResultSaveFormat format)
15+
```
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| writer | TextWriter | Object of TextWriter |
20+
| format | ValidationResultSaveFormat | The format in which the validation result will be saved |
21+
22+
### See Also
23+
24+
* enum [ValidationResultSaveFormat](../../../com.aspose.html.accessibility.saving/validationresultsaveformat/)
25+
* class [ValidationResult](../)
26+
* package [com.aspose.html.Accessibility.Results](../../../com.aspose.html.accessibility.results/)
27+
* package [Aspose.HTML](../../../)
28+
29+
---
30+
31+
## SaveTo(TextWriter) {#saveto}
32+
33+
Save validation results to the TextWriter object
34+
35+
```java
36+
public void SaveTo(TextWriter writer)
37+
```
38+
39+
| Parameter | Type | Description |
40+
| --- | --- | --- |
41+
| writer | TextWriter | Object of TextWriter |
42+
43+
### See Also
44+
45+
* class [ValidationResult](../)
46+
* package [com.aspose.html.Accessibility.Results](../../../com.aspose.html.accessibility.results/)
47+
* package [Aspose.HTML](../../../)

‎english/java/aspose.html.accessibility.results/validationresult/savetostring/_index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: ValidationResult.SaveToString
3+
second_title: Aspose.HTML for Java API Reference
4+
description: ValidationResult method. Save validation results to String
5+
type: docs
6+
weight: 40
7+
url: /java/com.aspose.html.accessibility.results/validationresult/savetoString/
8+
---
9+
## ValidationResult.SaveToString method
10+
11+
Save validation results to String
12+
13+
```java
14+
public String SaveToString()
15+
```
16+
17+
### Return Value
18+
19+
String with results
20+
21+
### See Also
22+
23+
* class [ValidationResult](../)
24+
* package [com.aspose.html.Accessibility.Results](../../../com.aspose.html.accessibility.results/)
25+
* package [Aspose.HTML](../../../)

‎english/java/aspose.html.accessibility.results/validationresult/success/_index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: ValidationResult.Success
3+
second_title: Aspose.HTML for Java API Reference
4+
description: ValidationResult property. The result of validation
5+
type: docs
6+
weight: 20
7+
url: /java/com.aspose.html.accessibility.results/validationresult/success/
8+
---
9+
## ValidationResult.Success property
10+
11+
The result of validation.
12+
13+
```java
14+
public bool Success { get; }
15+
```
16+
17+
### See Also
18+
19+
* class [ValidationResult](../)
20+
* package [com.aspose.html.Accessibility.Results](../../../com.aspose.html.accessibility.results/)
21+
* package [Aspose.HTML](../../../)

‎english/java/aspose.html.accessibility.saving/_index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: com.aspose.html.Accessibility.Saving
3+
second_title: Aspose.HTML for Java API Reference
4+
description: The com.aspose.html.Accessibility.Saving package is designed to save validation results various formats
5+
type: docs
6+
weight: 40
7+
url: /java/com.aspose.html.accessibility.saving/
8+
---
9+
The **com.aspose.html.Accessibility.Saving** package is designed to save validation results various formats.
10+
11+
## Enumeration
12+
13+
| Enumeration | Description |
14+
| --- | --- |
15+
| [ValidationResultSaveFormat](./validationresultsaveformat/) | Specifies format in which result is saved. |

‎english/java/aspose.html.accessibility.saving/validationresultsaveformat/_index.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: ValidationResultSaveFormat Enum
3+
second_title: Aspose.HTML for Java API Reference
4+
description: com.aspose.html.Accessibility.Saving.ValidationResultSaveFormat enum. Specifies format in which result is saved
5+
type: docs
6+
weight: 120
7+
url: /java/com.aspose.html.accessibility.saving/validationresultsaveformat/
8+
---
9+
## ValidationResultSaveFormat enumeration
10+
11+
Specifies format in which result is saved.
12+
13+
```java
14+
public enum ValidationResultSaveFormat
15+
```
16+
17+
### Values
18+
19+
| Name | Value | Description |
20+
| --- | --- | --- |
21+
| Text | `0` | Result will be saved as text. |
22+
| JSON | `1` | Result will be saved as JSON. |
23+
| XML | `2` | Result will be saved as XML. |
24+
25+
### See Also
26+
27+
* package [com.aspose.html.Accessibility.Saving](../../com.aspose.html.accessibility.saving/)
28+
* package [Aspose.HTML](../../)

‎english/java/aspose.html.accessibility/_index.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: com.aspose.html.Accessibility
3+
second_title: Aspose.HTML for Java API Reference
4+
description: The com.aspose.html.Dom.Accessibility package is for all Web Accessibility related manipulations. complies with international standards W3C Web Accessibility Initiative
5+
type: docs
6+
weight: 20
7+
url: /java/com.aspose.html.accessibility/
8+
---
9+
The **com.aspose.html.Dom.Accessibility** package is for all Web Accessibility related manipulations. complies with international standards W3C Web Accessibility Initiative
10+
11+
## Classes
12+
13+
| Class | Description |
14+
| --- | --- |
15+
| [AccessibilityRules](./accessibilityrules/) | Quick reference to Web Content Accessibility Guidelines (WCAG) 2 requirements (success criteria) and techniques. Contain a list of Principle. https://www.w3.org/WAI/WCAG21/quickref/ |
16+
| [AccessibilityValidator](./accessibilityvalidator/) | The validator class handles quick reference rules. Contains a Validate method to check accessibility. |
17+
| [Criterion](./criterion/) | Verifiable success criteria are provided for each recommendation, so WCAG 2.0 can be applied in areas where compliance testing is required. https://www.w3.org/WAI/WCAG21/Understanding/understanding-techniques |
18+
| [Guideline](./guideline/) | Guidelines - the next level after principles. There are not testable, but outline frameworks and general goals that help authors understand success criteria and better apply the techniques. Guidelines are a list of acceptance criteria with type RuleDirectory{Criterion}. |
19+
| [Principle](./principle/) | Accessibility Principle - The highest levels that provide the foundation of web accessibility, contain a list of Guidelines with type RuleCollection{Guideline}. The object is not allowed to be created outside the assembly. https://www.w3.org/WAI/fundamentals/accessibility-principles/ |
20+
| [Rule](./rule/) | An abstract class that defines the characteristics of a Rule and implements interface IRule |
21+
| [Target](./target/) | Class contains item of html or css element where the error was found. |
22+
| [ValidationBuilder](./validationbuilder/) | The ValidationBuilder class provides concrete implementations of the configuration steps. Defines methods and settings for a class ValidationSettings. |
23+
| [WebAccessibility](./webaccessibility/) | Object to Web Content Accessibility Guidelines (WCAG) 2 requirements (success criteria) and techniques. https://www.w3.org/WAI/WCAG21/quickref/ |
24+
## Interfaces
25+
26+
| Interface | Description |
27+
| --- | --- |
28+
| [IError](./ierror/) | The interface describes the error of the validation |
29+
| [IRule](./irule/) | Interface describing the main properties of the rules. |
30+
| [ITechniqueResult](./itechniqueresult/) | Describes the result of the technique validation. |
31+
## Enumeration
32+
33+
| Enumeration | Description |
34+
| --- | --- |
35+
| [TargetTypes](./targettypes/) | Enum of types of the resulting object from the html document containing the error.. |

0 commit comments

Comments
 (0)