AxeRunOnly クラス

この AxeRunOnly クラスは、axe Watcher を使用したアクセシビリティテスト中に実行するアクセシビリティルールを限定することができます。実行するルールまたはタグのセットを指定することで、他のすべてを分析から除外できます。これにより、特定のアクセシビリティ要件や懸念事項にテストの焦点を当てることができます。

このクラスは AxeRunOptions と組み合わせて使用し、axe-core 分析エンジンの動作をカスタマイズします。

コンストラクタ

AxeRunOnly()

で新しいインスタンスを作成します。 AxeRunOnly 設定が何も構成されていない状態で作成されます。

AxeRunOnly runOnly = new AxeRunOnly();

メソッド

setType(String type)

適用するフィルタリングの種類を設定します。有効な値は：「rule」、「rules」、「tag」、または「tags」

パラメータ:

• type - フィルターの種類を示す文字列。以下のいずれかである必要があります：「rule」、「rules」、「tag」、または「tags」。

戻り値:

• AxeRunOnly - メソッドチェーンに使用する現在のインスタンス

スローされる例外:

• IllegalArgumentException - 無効な種類が指定された場合

例:

AxeRunOnly runOnly = new AxeRunOnly();
runOnly.setType("tag");

setValues(List<String> values)

設定されたタイプに基づいて、分析に含める特定のルールIDまたはタグ名を設定します。

パラメータ:

• values - 分析に含めるルールIDまたはタグ名のリスト

戻り値:

• AxeRunOnly - メソッドチェーンに使用する現在のインスタンス

例:

AxeRunOnly runOnly = new AxeRunOnly();
runOnly.setType("tag");
runOnly.setValues(Arrays.asList("wcag2a", "wcag2aa"));

getType()

現在構成されているフィルタータイプを取得します。

戻り値:

• String - 現在のフィルタータイプ（「rule」、「rules」、「tag」、または「tags」）

例:

AxeRunOnly runOnly = new AxeRunOnly();
runOnly.setType("tag");
String type = runOnly.getType(); // Returns "tag"

getValues()

含めるように設定されたルールIDまたはタグ名のリストを取得します。

戻り値:

• List<String> - 含まれているルールIDまたはタグ名のリスト

例:

AxeRunOnly runOnly = new AxeRunOnly();
runOnly.setValues(Arrays.asList("wcag2a", "wcag2aa"));
List<String> values = runOnly.getValues(); // Returns the list of values

toJson()

インスタンスをJSON文字列にシリアライズします。 AxeRunOnly インスタンスをJSON文字列に変換します。

戻り値:

• String - 設定のJSON文字列表現

例:

AxeRunOnly runOnly = new AxeRunOnly()
    .setType("tag")
    .setValues(Arrays.asList("wcag2a", "wcag2aa"));
String json = runOnly.toJson();
// Returns: {"type":"tag","values":["wcag2a","wcag2aa"]}

一般的なタグ値

以下は、 AxeRunOnly クラスで使用できる一般的なタグの値です。

• wcag2a: WCAG 2.0 レベルAの要件
• wcag2aa: WCAG 2.0 レベルAAの要件
• wcag2aaa: WCAG 2.0 レベルAAAの要件
• wcag21a: WCAG 2.1 レベルAの要件
• wcag21aa: WCAG 2.1 レベルAAの要件
• wcag21aaa: WCAG 2.1 レベルAAAの要件
• wcag22a：WCAG 2.2 レベルAの要件
• wcag22aa：WCAG 2.2 レベルAAの要件
• wcag22aaa：WCAG 2.2 レベルAAAの要件
• best-practice：特定の標準に含まれないベストプラクティスのルール
• experimental：まだ開発中の実験的なルール

参照してください Axe-core タグ の他のaxe-coreタグについて。

関連情報

• AxeRuleOptions
• AxeRunOptions
• AxeRunContext
• AxeWatcherOptions