ConfigurationOverrides クラス

この ConfigurationOverrides クラスを使用すると、 axe 設定 のグローバル設定をオーバーライドして、axe Watcher を使用したアクセシビリティテストを行うことができます。このクラスを使用して、アクセシビリティ基準をカスタマイズしたり、ベストプラクティスや実験的なルールを有効にしたり、テスト時に使用する axe-core のバージョンを指定することができます。

これらのオーバーライドは、 axe アカウントに定義されたグローバル設定よりも優先されます。

コンストラクター

ConfigurationOverrides()

新しいインスタンスを作成します ConfigurationOverrides デフォルト設定付き（すべてのプロパティが nullに設定）

ConfigurationOverrides configOverrides = new ConfigurationOverrides();

メソッド

setEnableBestPractices(boolean enableBestPractices)

ベストプラクティスルールを有効または無効にします ベストプラクティスルール はアクセシビリティ基準で必須ではない問題を特定しますが、ユーザー体験を向上させることができます。

パラメータ:

• enableBestPractices - ベストプラクティスルールを有効にするかどうかを示すブール値

戻り値:

• ConfigurationOverrides - メソッドチェーン用の現在のインスタンス

例:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setEnableBestPractices(true);

setEnableExperimental(boolean enableExperimental)

実験的ルールを有効または無効にします 実験的ルール はまだ開発中の新しいまたは不安定なルールです。

パラメータ:

• enableExperimental - 実験的ルールを有効にするかどうかを示すブール値

戻り値:

• ConfigurationOverrides - メソッドチェーン用の現在のインスタンス

例:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setEnableExperimental(false);

setAccessibilityStandard(AccessibilityStandard standard)

テストで使用するアクセシビリティ基準を設定します。これにより、テスト中に適用されるアクセシビリティルールのセットが決まります。

パラメータ:

• standard - 使用する基準を指定する AccessibilityStandard 列挙型の値

戻り値:

• ConfigurationOverrides - メソッドチェーン用の現在のインスタンス

例:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setAccessibilityStandard(ConfigurationOverrides.AccessibilityStandard.WCAG22AA);

setAxeCoreVersion(String axeCoreVersion)

テストで使用する axe-core のバージョンを設定します。これにより、特定のバージョンを指定したり、最新バージョンを使用することができます。

パラメータ:

• axeCoreVersion - 使用する axe-core のバージョン文字列（例: 「4.6.0」または「latest」）

戻り値:

• ConfigurationOverrides - メソッドチェーン用の現在のインスタンス

例:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setAxeCoreVersion("4.7.0");

getEnableBestPractices()

ベストプラクティスルールを有効にする現在の設定を取得します。

戻り値:

• Boolean - ベストプラクティスルールを有効にする現在の設定

例:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setEnableBestPractices(true);
Boolean enableBestPractices = configOverrides.getEnableBestPractices(); // Returns true

getEnableExperimental()

実験的ルールを有効にする現在の設定を取得します。

戻り値:

• Boolean - 実験的ルールを有効にする現在の設定

例：

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setEnableExperimental(false);
Boolean enableExperimental = configOverrides.getEnableExperimental(); // Returns false

getAccessibilityStandard()

現在のアクセシビリティ標準設定を取得します。

戻り値：

• String - 現在のアクセシビリティ標準設定

例：

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setAccessibilityStandard(ConfigurationOverrides.AccessibilityStandard.WCAG21AA);
String standard = configOverrides.getAccessibilityStandard(); // Returns "WCAG 2.1 AA"

getAxeCoreVersion()

現在のaxe-coreバージョン設定を取得します。

戻り値：

• String - 現在のaxe-coreバージョン設定

例：

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setAxeCoreVersion("4.7.0");
String version = configOverrides.getAxeCoreVersion(); // Returns "4.7.0"

toJson()

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

戻り値：

• String - 設定オーバーライドのJSON文字列表現

例：

ConfigurationOverrides configOverrides = new ConfigurationOverrides()
    .setEnableBestPractices(true)
    .setAccessibilityStandard(ConfigurationOverrides.AccessibilityStandard.WCAG22AA);
String json = configOverrides.toJson();
// Returns: {"best_practices":true,"experimental_rules":null,"accessibility_standard":"WCAG 2.2 AA","axe_core_version":null}

AccessibilityStandard Enum

このクラスには、利用可能なアクセシビリティ標準を定義する ConfigurationOverrides enumが含まれています： AccessibilityStandard

列挙値

• 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
• TTV5 - Trusted Tester v5
• EN301549 - EN 301 549
• ALL - すべての標準

例：

ConfigurationOverrides configOverrides = new ConfigurationOverrides();

// Set to WCAG 2.2 Level AA
configOverrides.setAccessibilityStandard(ConfigurationOverrides.AccessibilityStandard.WCAG22AA);

// Set to Trusted Tester v5
configOverrides.setAccessibilityStandard(ConfigurationOverrides.AccessibilityStandard.TTV5);

// Set to all standards
configOverrides.setAccessibilityStandard(ConfigurationOverrides.AccessibilityStandard.ALL);

重要な注意点

1. 相互排他的な設定： 同時に configurationOverrides.accessibilityStandard と runOptions.runOnly を使用することはできません。

2. ヌルプロパティ： すべてのプロパティが ConfigurationOverrides にデフォルト設定されています。プロパティが nullの場合、代わりにaxe Developer Hubのグローバル設定が使用されます。 null

3. 優先順位： 設定オーバーライドはaxeアカウントのグローバル設定よりも優先され、特定のテストスイートや実行に対してテストをカスタマイズすることができます。

4. シリアライゼーション： メソッドは出力にヌル値を含め、設定されたプロパティに関係なくJSON構造が一貫したものになります。 toJson()

関連項目

• AxeWatcherOptions
• AxeWatcher
• AxeRunOptions
• AxeRunOnly