Skip navigation links

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 Summary

static java.lang.String	VALUE_DEFAULT Optimize the Faces rendering for the default accessibility level.
static java.lang.String	VALUE_INACCESSIBLE Optimize the Faces rendering for inaccessible applications.
static java.lang.String	VALUE_SCREENREADER Optimize the Faces rendering for screen reader applications.

Fields inherited from class oracle.webcenter.generalsettings.internal.model.GSPreferences

NULL_VALUE

Constructor Summary

AccessibilityModeSetting()

Method Summary

static java.lang.String	getDefaultAccessibilityMode() Returns the default accessibility mode preference for the application.
static java.lang.String	getPreferredAccessibilityMode() Returns the preferred accessibility mode for the current user.
static java.lang.String	getPreferredAccessibilityMode(java.lang.String username) Returns the preferred accessibility mode for the given user.
static java.lang.String	getUserAccessibilityModePref() Returns the accessibility mode preference for the current user.
static java.lang.String	getUserAccessibilityModePref(java.lang.String username) Returns the accessibility mode preference for the given user.
static void	setDefaultAccessibilityMode(java.lang.String defaultAccessibilityMode) Sets the default accessibility mode preference for the application.
static void	setPreferredAccessibilityMode(java.lang.String preferredAccessibilityMode) Deprecated. replaced by setUserAccessibilityModePref()
static void	setPreferredAccessibilityMode(java.lang.String username, java.lang.String preferredAccessibilityMode) Deprecated. replaced by setUserAccessibilityModePref()
static void	setUserAccessibilityModePref(java.lang.String preferredAccessibilityMode) Sets the accessibility mode preference for the current user.
static void	setUserAccessibilityModePref(java.lang.String username, java.lang.String preferredAccessibilityMode) Set the accessibility mode preference for the user.

Methods inherited from class oracle.webcenter.generalsettings.internal.model.GSPreferences

getPreferred, getPreferred, getProvider, getSystemPref, getUserPref, getUserPref, setSystemPref, setUserPref

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VALUE_DEFAULT

public static final java.lang.String VALUE_DEFAULT

Optimize the Faces rendering for the default accessibility level.

See Also:

Constant Field Values

VALUE_INACCESSIBLE

public static final java.lang.String VALUE_INACCESSIBLE

Optimize the Faces rendering for inaccessible applications.

See Also:

Constant Field Values

VALUE_SCREENREADER

public static final java.lang.String VALUE_SCREENREADER

Optimize the Faces rendering for screen reader applications.

See Also:

Constant Field Values

Constructor Detail

AccessibilityModeSetting

public AccessibilityModeSetting()

Method Detail

getPreferredAccessibilityMode

public static java.lang.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

public static java.lang.String getPreferredAccessibilityMode(java.lang.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

public static java.lang.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

public static java.lang.String getUserAccessibilityModePref(java.lang.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

public static void setPreferredAccessibilityMode(java.lang.String username,
                                                 java.lang.String preferredAccessibilityMode)

Deprecated. replaced by setUserAccessibilityModePref()

setPreferredAccessibilityMode

public static void setPreferredAccessibilityMode(java.lang.String preferredAccessibilityMode)

Deprecated. replaced by setUserAccessibilityModePref()

setUserAccessibilityModePref

public static void setUserAccessibilityModePref(java.lang.String preferredAccessibilityMode)

Sets the accessibility mode preference for the current user.

Parameters:

preferredAccessibilityMode - user's accessibility mode preference value

setUserAccessibilityModePref

public static void setUserAccessibilityModePref(java.lang.String username,
                                                java.lang.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

public static java.lang.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

public static void setDefaultAccessibilityMode(java.lang.String defaultAccessibilityMode)

Sets the default accessibility mode preference for the application.

Parameters:

defaultAccessibilityMode - the application's default accessibility mode preference value

Skip navigation links