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

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