AxeRunContext クラス

このAxeRunContextクラスを使用すると、分析中に含めるまたは除外する DOM 要素を指定することで、アクセシビリティテストの範囲を定義できます。これにより、ページの特定の部分に焦点を当てたり、関連性のないセクションを除外したりすることで、テストプロセスをより適切に制御できます。

要素を含めると、その要素のみが分析されます。要素を除外すると、その要素は分析から除外されますが、ページ上のその他のすべてのものは分析されます。

コンストラクタ

AxeRunContext()

空の include および exclude リストを持つ新しいAxeRunContextのインスタンスを作成します。

AxeRunContext context = new AxeRunContext();

メソッド

setInclude(List<String> include)

アクセシビリティ分析に含める要素を指定します。include 要素を設定すると、その要素のみが分析されます。

パラメータ:

• include - 分析に含める CSS セレクターのリスト

返り値:

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

例:

AxeRunContext context = new AxeRunContext();
context.setInclude(Arrays.asList("#main-content", ".important-section"));

setExclude(List<String> exclude)

アクセシビリティ分析から除外する要素を指定します。

パラメータ:

• exclude - 分析から除外する CSS セレクターのリスト

返り値:

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

例:

AxeRunContext context = new AxeRunContext();
context.setExclude(Arrays.asList(".ad-section", "#header-navigation"));

getInclude()

分析に含められている CSS セレクターのリストを取得します。

返り値:

• List<String> - 含まれている CSS セレクターのリスト

例:

AxeRunContext context = new AxeRunContext();
context.setInclude(Arrays.asList("#main-content"));
List<String> includeSelectors = context.getInclude();

getExclude()

分析から除外されている CSS セレクターのリストを取得します。

返り値:

• List<String> - 除外されている CSS セレクターのリスト

例:

AxeRunContext context = new AxeRunContext();
context.setExclude(Arrays.asList(".ad-section"));
List<String> excludeSelectors = context.getExclude();

toJson()

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

返り値:

• String - コンテキストの JSON 文字列表現

例:

AxeRunContext context = new AxeRunContext()
    .setInclude(Arrays.asList("#main-content"))
    .setExclude(Arrays.asList(".ad-section"));
String json = context.toJson();
// Returns: {"include":["#main-content"],"exclude":[".ad-section"]}

関連項目

• AxeRuleOptions
• AxeRunOptions
• AxeWatcherOptions