ConfigurationOverrides クラス

ConfigurationOverrides クラスを使用すると、axe Watcher でのアクセシビリティテスト用のaxe 構成グローバル設定を上書きできます。このクラスを使用して、アクセシビリティ標準をカスタマイズし、ベストプラクティスや実験的なルールを有効にし、テスト中に使用する axe-core のバージョンを指定できます。

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

コンストラクター

ConfigurationOverrides()

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

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

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

戻り値：

• 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列挙型

ConfigurationOverridesクラスには、利用可能なアクセシビリティ標準を定義する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
• RGAAV4 - RGAAバージョン4（フランスのアクセシビリティ標準；axe-core 4.11.0以上が必要）
• 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になります。プロパティがnullの場合は、axeデベロッパーハブのグローバル設定が代わりに使用されます。

3. 優先順位: 設定オーバーライドはあなたのaxeアカウントのグローバル設定よりも優先され、特定のテストスイートや実行のためにテストをカスタマイズできます。

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

関連情報

• AxeWatcherOptions
• AxeWatcher
• AxeRunOptions
• AxeRunOnly