Package com.intellij.util.ui.accessibility

Class ScreenReader

java.lang.Object

com.intellij.util.ui.accessibility.ScreenReader

public class ScreenReader
extends java.lang.Object

Expose system-wide screen reader status for accessibility features.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCESS_BRIDGE
static java.lang.String	ATK_WRAPPER
static java.lang.String	SCREEN_READER_ACTIVE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ScreenReader()

Method Summary

Modifier and Type	Method and Description
static void	addPropertyChangeListener(java.lang.String propertyName, Disposable parent, java.beans.PropertyChangeListener listener) Adds property change listener.
static boolean	isActive() Components that need to customize their behavior in the presence of an external screen reader application should call this method.
static boolean	isEnabled(java.lang.String a11yClassName) Checks whether a particular a11y technology is enabled, in order of priority: 1) via the sys.
static void	setActive(boolean active) This method should be called by a central configuration mechanism to enable screen reader support for the application.

Methods inherited from class java.lang.Object

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

Field Detail

ATK_WRAPPER

public static final java.lang.String ATK_WRAPPER

See Also:

Constant Field Values

ACCESS_BRIDGE

public static final java.lang.String ACCESS_BRIDGE

See Also:

Constant Field Values

SCREEN_READER_ACTIVE_PROPERTY

public static final java.lang.String SCREEN_READER_ACTIVE_PROPERTY

See Also:

Constant Field Values

Constructor Detail

ScreenReader

public ScreenReader()

Method Detail

isActive

public static boolean isActive()

Components that need to customize their behavior in the presence of an external screen reader application should call this method. For example, this can be used to determine if components should to be focusable via keyboard -- as opposed to accessible only via the mouse pointer.

setActive

public static void setActive(boolean active)

This method should be called by a central configuration mechanism to enable screen reader support for the application.

isEnabled

public static boolean isEnabled(java.lang.String a11yClassName)

Checks whether a particular a11y technology is enabled, in order of priority: 1) via the sys. property: "javax.accessibility.assistive_technologies" 2) in the prop. file: /.accessibility.properties 3) in the prop. file: /lib/accessibility.properties

Parameters:

a11yClassName - the full class name representing the a11y technology

Returns:

true if enabled, otherwise false

See Also:

ACCESS_BRIDGE, ATK_WRAPPER

addPropertyChangeListener

public static void addPropertyChangeListener(java.lang.String propertyName,
                                             Disposable parent,
                                             java.beans.PropertyChangeListener listener)

Adds property change listener. Supported properties: SCREEN_READER_ACTIVE_PROPERTY