Package oracle.webcenter.generalsettings.model

Class AccessibilityModeSetting

java.lang.Object
oracle.webcenter.generalsettings.internal.model.GSPreferences
oracle.webcenter.generalsettings.model.AccessibilityModeSetting
public class AccessibilityModeSetting extends oracle.webcenter.generalsettings.internal.model.GSPreferences
Provides an API for managing the preference value for accessibility mode. An EL expression may be used in the accessibility-mode element of trinidad-config.xml to obtain this preference value and thereby set the accessibility mode for the application.

  • Field Details

    • VALUE_DEFAULT

      public static final String VALUE_DEFAULT
      Optimize the Faces rendering for the default accessibility level.
      See Also:

    • VALUE_INACCESSIBLE

      public static final String VALUE_INACCESSIBLE
      Optimize the Faces rendering for inaccessible applications.
      See Also:

    • VALUE_SCREENREADER

      public static final String VALUE_SCREENREADER
      Optimize the Faces rendering for screen reader applications.
      See Also:

    • VALUE_HIGH_CONTRAST

      public static final String VALUE_HIGH_CONTRAST
      Optimize the Faces rendering for contrast-friendly content.
      See Also:

    • VALUE_LARGE_FONT

      public static final String VALUE_LARGE_FONT
      Optimize the Faces rendering for large fonts.
      See Also:

  • Constructor Details

    • AccessibilityModeSetting

      public AccessibilityModeSetting()

  • Method Details

    • getPreferredAccessibilityMode

      @Exported public static String getPreferredAccessibilityMode()
      Returns the preferred accessibility mode for the current user. If the preference is not set for the current user, returns the default preference value. If both the user and default preferences do not exist, returns null.
      Returns:
      user's preferred accessibility mode

    • getPreferredAccessibilityMode

      @Exported public static String getPreferredAccessibilityMode(String username)
      Returns the preferred accessibility mode for the given user. If the preference value is not set for the current user, it returns the default preference value. If both the user and default preferences do not exist, returns null.
      Parameters:
      username - the username to obtain the preference for, or null to use the current authenticated user
      Returns:
      user's preferred accessibility mode

    • getUserAccessibilityModePref

      @Exported public static String getUserAccessibilityModePref()
      Returns the accessibility mode preference for the current user. If the user preference is not set, returns null.
      Returns:
      user's accessibility mode preference. If the user preference is not set, returns null.

    • getUserAccessibilityModePref

      @Exported public static String getUserAccessibilityModePref(String username)
      Returns the accessibility mode preference for the given user. If the user preference is not set, returns null.
      Parameters:
      username - the username to obtain the preference value for, or null to use the current authenticated user
      Returns:
      user's accessibility mode preference. If the user preference is not set, returns null.

    • setPreferredAccessibilityMode

      @Exported public static void setPreferredAccessibilityMode(String username, String preferredAccessibilityMode)
      Deprecated.
      replaced by setUserAccessibilityModePref()

    • setPreferredAccessibilityMode

      @Exported public static void setPreferredAccessibilityMode(String preferredAccessibilityMode)
      Deprecated.
      replaced by setUserAccessibilityModePref()

    • setUserAccessibilityModePref

      @Exported public static void setUserAccessibilityModePref(String preferredAccessibilityMode)
      Sets the accessibility mode preference for the current user.
      Parameters:
      preferredAccessibilityMode - user's accessibility mode preference value

    • setUserAccessibilityModePref

      @Exported public static void setUserAccessibilityModePref(String username, String preferredAccessibilityMode)
      Set the accessibility mode preference for the user.
      Parameters:
      username - the user to set the preference value for, or null to use the current authenticated user
      preferredAccessibilityMode - user's accessibility mode preference value

    • getDefaultAccessibilityMode

      @Exported public static String getDefaultAccessibilityMode()
      Returns the default accessibility mode preference for the application. If the default preference is not set, this method returns null.
      Returns:
      the application's default accessibility mode preference setting. If the default preference is not set, returns null.

    • setDefaultAccessibilityMode

      @Exported public static void setDefaultAccessibilityMode(String defaultAccessibilityMode)
      Sets the default accessibility mode preference for the application.
      Parameters:
      defaultAccessibilityMode - the application's default accessibility mode preference value

    • getPreferredAccessibilityHighContrastProfile

      @Exported public static String getPreferredAccessibilityHighContrastProfile()
      Returns the accessibility high contrast profile preference for the current user. If the user preference is not set, return system default.
      Returns:
      user's accessibility high contrast profile preference. If the user preference is not set, returns system default.

    • getPreferredAccessibilityHighContrastProfile

      @Exported public static String getPreferredAccessibilityHighContrastProfile(String username)
      Returns the accessibility high contrast profile preference for the current user. If the user preference is not set, the system level default is returned.
      Parameters:
      username - the username to obtain the preference value for, or null to use the current authenticated user
      Returns:
      user's accessibility high contrast profile preference. If the user preference is not set, returns system level default.

    • getUserAccessibilityHighContrastProfile

      @Exported public static String getUserAccessibilityHighContrastProfile()
      Returns the accessibility high contrast profile preference for the current user. If the user preference is not set, returns null.
      Returns:
      user's accessibility high contrast profile preference. If the user preference is not set, returns null.

    • getUserAccessibilityHighContrastProfile

      @Exported public static String getUserAccessibilityHighContrastProfile(String username)
      Returns the accessibility high contrast profile preference for the current user. If the user preference is not set, returns null.
      Parameters:
      username - the username to obtain the preference value for, or null to use the current authenticated user
      Returns:
      user's accessibility high contrast profile preference. If the user preference is not set, returns null.

    • setUserAccessibilityHighContrastProfile

      @Exported public static void setUserAccessibilityHighContrastProfile(String preference)
      Sets the accessibility high contrast profile preference for the current user.
      Parameters:
      preference - user's accessibility high contrast profile preference value

    • setUserAccessibilityHighContrastProfile

      @Exported public static void setUserAccessibilityHighContrastProfile(String username, String preference)
      Sets the accessibility high contrast profile preference for the current user.
      Parameters:
      username - the user to set the preference value for, or null to use the current authenticated user
      preference - user's accessibility high contrast profile preference value

    • getPreferredAccessibilityLargeFontProfile

      @Exported public static String getPreferredAccessibilityLargeFontProfile()
      Returns the accessibility large font profile preference for the current user. If the user preference is not set, returns system level default.
      Returns:
      user's accessibility large font profile preference. If the user preference is not set, returns system level default.

    • getPreferredAccessibilityLargeFontProfile

      @Exported public static String getPreferredAccessibilityLargeFontProfile(String username)
      Returns the accessibility large font profile preference for the current user. If the user preference is not set, returns system level default.
      Parameters:
      username - the username to obtain the preference value for, or null to use the current authenticated user
      Returns:
      user's accessibility large font profile preference. If the user preference is not set, returns system level default.

    • getUserAccessibilityLargeFontProfile

      @Exported public static String getUserAccessibilityLargeFontProfile()
      Returns the accessibility large font profile preference for the current user. If the user preference is not set, returns null.
      Returns:
      user's accessibility large font profile preference. If the user preference is not set, returns null.

    • getUserAccessibilityLargeFontProfile

      @Exported public static String getUserAccessibilityLargeFontProfile(String username)
      Returns the accessibility large font profile preference for the current user. If the user preference is not set, returns null.
      Parameters:
      username - the username to obtain the preference value for, or null to use the current authenticated user
      Returns:
      user's accessibility large font profile preference. If the user preference is not set, returns null.

    • setUserAccessibilityLargeFontProfile

      @Exported public static void setUserAccessibilityLargeFontProfile(String preference)
      Sets the accessibility large font profile preference for the current user.
      Parameters:
      preference - user's accessibility large font profile preference value

    • setUserAccessibilityLargeFontProfile

      @Exported public static void setUserAccessibilityLargeFontProfile(String username, String preference)
      Sets the accessibility large font profile preference for the current user.
      Parameters:
      username - the user to set the preference value for, or null to use the current authenticated user
      preference - user's accessibility large font profile preference value