Package com.intellij.util.ui.accessibility

Class AccessibleContextUtil

java.lang.Object

com.intellij.util.ui.accessibility.AccessibleContextUtil

public class AccessibleContextUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AccessibleContextUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	combineAccessibleStrings(java.lang.String s1, java.lang.String s2)
static java.lang.String	combineAccessibleStrings(java.lang.String s1, java.lang.String separator, java.lang.String s2)
static java.lang.String	combineAccessibleStrings(java.lang.String s1, java.lang.String separator1, java.lang.String s2, java.lang.String separator2, java.lang.String s3)
static java.lang.String	getCombinedDescription(java.awt.Component j1, java.lang.String separator, java.awt.Component j2)
static java.lang.String	getCombinedDescription(java.awt.Component j1, java.lang.String separator1, java.awt.Component j2, java.lang.String separator2, java.awt.Component j3)
static java.lang.String	getCombinedName(java.awt.Component j1, java.lang.String separator, java.awt.Component j2)
static java.lang.String	getCombinedName(java.awt.Component j1, java.lang.String separator1, java.awt.Component j2, java.lang.String separator2, java.awt.Component j3)
static java.lang.String	getCombinedName(java.lang.String separator, java.awt.Component... components)
static java.lang.String	getUniqueDescription(javax.accessibility.AccessibleContext context, java.lang.String description) Returns description if it is different than the accessible name, null otherwise.
static java.lang.String	replaceLineSeparatorsWithPunctuation(java.lang.String text) Given a multi-line string, return an single line string where new line separators are replaced with a punctuation character.
static void	setCombinedDescription(java.awt.Component component, java.awt.Component j1, java.lang.String separator, java.awt.Component j2)
static void	setCombinedDescription(java.awt.Component component, java.awt.Component j1, java.lang.String separator1, java.awt.Component j2, java.lang.String separator2, java.awt.Component j3)
static void	setCombinedName(java.awt.Component component, java.awt.Component j1, java.lang.String separator, java.awt.Component j2)
static void	setCombinedName(java.awt.Component component, java.awt.Component j1, java.lang.String separator1, java.awt.Component j2, java.lang.String separator2, java.awt.Component j3)
static void	setDescription(java.awt.Component component, java.awt.Component source)
static void	setDescription(java.awt.Component component, java.lang.String description)
static void	setName(java.awt.Component component, java.awt.Component source)
static void	setName(java.awt.Component component, java.lang.String name)
static void	setParent(java.awt.Component component, java.awt.Component newParent)
static void	setParent(javax.swing.JComponent component, java.awt.Component newParent) Deprecated. use setParent(Component, Component) instead

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessibleContextUtil

public AccessibleContextUtil()

Method Detail

setName

public static void setName(java.awt.Component component,
                           java.lang.String name)

setName

public static void setName(java.awt.Component component,
                           java.awt.Component source)

setCombinedName

public static void setCombinedName(java.awt.Component component,
                                   java.awt.Component j1,
                                   java.lang.String separator,
                                   java.awt.Component j2)

setCombinedName

public static void setCombinedName(java.awt.Component component,
                                   java.awt.Component j1,
                                   java.lang.String separator1,
                                   java.awt.Component j2,
                                   java.lang.String separator2,
                                   java.awt.Component j3)

getCombinedName

public static java.lang.String getCombinedName(java.awt.Component j1,
                                               java.lang.String separator,
                                               java.awt.Component j2)

getCombinedName

public static java.lang.String getCombinedName(java.awt.Component j1,
                                               java.lang.String separator1,
                                               java.awt.Component j2,
                                               java.lang.String separator2,
                                               java.awt.Component j3)

getCombinedName

public static java.lang.String getCombinedName(java.lang.String separator,
                                               java.awt.Component... components)

setDescription

public static void setDescription(java.awt.Component component,
                                  java.awt.Component source)

setDescription

public static void setDescription(java.awt.Component component,
                                  java.lang.String description)

setCombinedDescription

public static void setCombinedDescription(java.awt.Component component,
                                          java.awt.Component j1,
                                          java.lang.String separator,
                                          java.awt.Component j2)

setCombinedDescription

public static void setCombinedDescription(java.awt.Component component,
                                          java.awt.Component j1,
                                          java.lang.String separator1,
                                          java.awt.Component j2,
                                          java.lang.String separator2,
                                          java.awt.Component j3)

getCombinedDescription

public static java.lang.String getCombinedDescription(java.awt.Component j1,
                                                      java.lang.String separator,
                                                      java.awt.Component j2)

getCombinedDescription

public static java.lang.String getCombinedDescription(java.awt.Component j1,
                                                      java.lang.String separator1,
                                                      java.awt.Component j2,
                                                      java.lang.String separator2,
                                                      java.awt.Component j3)

getUniqueDescription

public static java.lang.String getUniqueDescription(javax.accessibility.AccessibleContext context,
                                                    java.lang.String description)

Returns description if it is different than the accessible name, null otherwise. Calling this method is useful from custom implementations of AccessibleContext@getAccessibleDescription to ensure screen readers don't announce the same text twice (name and description) when a component receives the focus.

setParent

public static void setParent(java.awt.Component component,
                             java.awt.Component newParent)

setParent

@Deprecated
public static void setParent(javax.swing.JComponent component,
                             java.awt.Component newParent)

Deprecated. use setParent(Component, Component) instead

combineAccessibleStrings

public static java.lang.String combineAccessibleStrings(java.lang.String s1,
                                                        java.lang.String s2)

combineAccessibleStrings

public static java.lang.String combineAccessibleStrings(java.lang.String s1,
                                                        java.lang.String separator,
                                                        java.lang.String s2)

combineAccessibleStrings

public static java.lang.String combineAccessibleStrings(java.lang.String s1,
                                                        java.lang.String separator1,
                                                        java.lang.String s2,
                                                        java.lang.String separator2,
                                                        java.lang.String s3)

replaceLineSeparatorsWithPunctuation

public static java.lang.String replaceLineSeparatorsWithPunctuation(java.lang.String text)

Given a multi-line string, return an single line string where new line separators are replaced with a punctuation character. This is useful for returning text to screen readers, as they tend to ignore new line separators during speech, but they do pause at punctuation characters.