AxeRunOptions クラス

このAxeRunOptionsクラスは、axe-coreがアクセシビリティテストを実行する方法を制御するための設定オプションを提供します。このクラスを使用することで、特定のルールを有効または無効にしたり、実行するルールを限定したり、アクセシビリティ違反の系統情報などの分析詳細を設定したりできます。

これらのオプションは、アクセシビリティ分析エンジンの動作をカスタマイズするために、ランタイムでaxe-coreに渡されます。

コンストラクタ

AxeRunOptions()

既定の設定でAxeRunOptionsの新しいインスタンスを作成します。デフォルトでは、ancestryプロパティはfalseに設定されています。

AxeRunOptions options = new AxeRunOptions();

メソッド

setAncestry(boolean ancestry)

ancestryプロパティを設定します。trueに設定すると、axe-coreエンジンはアクセシビリティ違反のある要素の完全なCSSセレクタパスを、その親要素も含めて表示します。これにより、複雑なDOM構造内で違反箇所を特定しやすくなります。

パラメータ：

• ancestry - 系統情報を有効または無効にするためのブール値

返り値：

• AxeRunOptions - メソッドチェーンのための現在のインスタンス

例：

AxeRunOptions options = new AxeRunOptions();
options.setAncestry(true);

setRunOnly(AxeRunOnly runOnly)

runOnlyプロパティを設定し、実行するアクセシビリティルールを限定できるようにします。これを使用して、特定の標準またはルールセットに焦点を当てたテストを行います。

パラメータ：

• runOnly - 実行するルールやタグを指定するAxeRunOnlyインスタンス

返り値：

• AxeRunOptions - メソッドチェーンのための現在のインスタンス

例：

AxeRunOnly runOnly = new AxeRunOnly()
    .setType("tag")
    .setValues(Arrays.asList("wcag21aa", "best-practice"));

AxeRunOptions options = new AxeRunOptions();
options.setRunOnly(runOnly);

setRules(Map<String, AxeRuleOptions> rules)

特定のアクセシビリティルールをIDで有効または無効にできるように、rulesプロパティを設定します。

パラメータ：

• rules - ルールIDからAxeRuleOptionsインスタンスへのマップ

返り値：

• AxeRunOptions - メソッドチェーンのための現在のインスタンス

例：

Map<String, AxeRuleOptions> rules = new HashMap<>();
rules.put("color-contrast", new AxeRuleOptions().setEnabled(false));
rules.put("aria-roles", new AxeRuleOptions().setEnabled(true));

AxeRunOptions options = new AxeRunOptions();
options.setRules(rules);

getAncestry()

ancestryプロパティの現在の値を取得します。

返り値：

• boolean - 系統プロパティの現在の値

例：

AxeRunOptions options = new AxeRunOptions();
options.setAncestry(true);
boolean ancestry = options.getAncestry(); // Returns true

getRunOnly()

現在のAxeRunOnly設定を取得します。

返り値：

• AxeRunOnly - 現在のrunOnly設定、設定されていない場合はnull

例：

AxeRunOptions options = new AxeRunOptions();
AxeRunOnly runOnly = new AxeRunOnly()
    .setType("tag")
    .setValues(Arrays.asList("wcag21aa"));
options.setRunOnly(runOnly);

AxeRunOnly currentRunOnly = options.getRunOnly(); // Returns the runOnly configuration

getRules()

現在のルール設定マップを取得します。

返り値：

• Map<String, AxeRuleOptions> - 現在のルール設定、設定されていない場合はnull

例：

AxeRunOptions options = new AxeRunOptions();
Map<String, AxeRuleOptions> rules = new HashMap<>();
rules.put("color-contrast", new AxeRuleOptions().setEnabled(false));
options.setRules(rules);

Map<String, AxeRuleOptions> currentRules = options.getRules(); // Returns the rules map

toJson()

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

返り値：

• String - オプションのJSON文字列表現

例：

AxeRunOptions options = new AxeRunOptions()
    .setAncestry(true)
    .setRunOnly(new AxeRunOnly()
        .setType("tag")
        .setValues(Arrays.asList("wcag21aa")));

String json = options.toJson();
// Returns JSON like: {"ancestry":true,"runOnly":{"type":"tag","values":["wcag21aa"]}}

設定の検証に関する注意点

AxeRunOptionsを設定する際、次の検証ルールに注意してください：

1. setRules()を使用する際：

   • ルールのマップには少なくとも1つのエントリが含まれている必要があります。
   • 各ルールの値はnullにできません。

2. setRunOnly()を使用する際：

   • typeプロパティは「rule」、「rules」、「tag」、または「tags」のいずれかでなければなりません
   • valuesプロパティには少なくとも1つの値が含まれている必要があります
   • values プロパティにはnullエントリを含めることはできません

3. 相互排他的な設定：

   • runOnly を AxeRunOptions で使用し、accessibilityStandard を ConfigurationOverrides で同時に使用することはできません。

参照

• AxeRuleOptions
• AxeRunOnly
• AxeRunContext
• AxeWatcherOptions