JComponent.AccessibleJComponent (Java Platform SE 7 b138)

java.lang.Object
- javax.accessibility.AccessibleContext
- - java.awt.Component.AccessibleAWTComponent
  - - java.awt.Container.AccessibleAWTContainer
    - - javax.swing.JComponent.AccessibleJComponent

All Implemented Interfaces:

Serializable, AccessibleComponent, AccessibleExtendedComponent

Direct Known Subclasses:

AbstractButton.AccessibleAbstractButton, JColorChooser.AccessibleJColorChooser, JComboBox.AccessibleJComboBox, JDesktopPane.AccessibleJDesktopPane, JFileChooser.AccessibleJFileChooser, JInternalFrame.AccessibleJInternalFrame, JInternalFrame.JDesktopIcon.AccessibleJDesktopIcon, JLabel.AccessibleJLabel, JLayeredPane.AccessibleJLayeredPane, JList.AccessibleJList, JMenuBar.AccessibleJMenuBar, JOptionPane.AccessibleJOptionPane, JPanel.AccessibleJPanel, JPopupMenu.AccessibleJPopupMenu, JProgressBar.AccessibleJProgressBar, JRootPane.AccessibleJRootPane, JScrollBar.AccessibleJScrollBar, JScrollPane.AccessibleJScrollPane, JSeparator.AccessibleJSeparator, JSlider.AccessibleJSlider, JSpinner.AccessibleJSpinner, JSplitPane.AccessibleJSplitPane, JTabbedPane.AccessibleJTabbedPane, JTable.AccessibleJTable, JTableHeader.AccessibleJTableHeader, JTextComponent.AccessibleJTextComponent, JToolBar.AccessibleJToolBar, JToolTip.AccessibleJToolTip, JTree.AccessibleJTree, JViewport.AccessibleJViewport

Enclosing class:

JComponent
```
public abstract class JComponent.AccessibleJComponent
extends Container.AccessibleAWTContainer
implements AccessibleExtendedComponent
```
Inner class of JComponent used to provide default support for accessibility. This class is not meant to be used directly by application developers, but is instead meant only to be subclassed by component developers.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see XMLEncoder.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`JComponent.AccessibleJComponent.AccessibleContainerHandler` Fire PropertyChange listener, if one is registered, when children added/removed.
`protected class`	`JComponent.AccessibleJComponent.AccessibleFocusHandler` Fire PropertyChange listener, if one is registered, when focus events happen

Nested classes/interfaces inherited from class java.awt.Component.AccessibleAWTComponent
Component.AccessibleAWTComponent.AccessibleAWTComponentHandler, Component.AccessibleAWTComponent.AccessibleAWTFocusHandler

Field Summary

Fields
Modifier and Type Field and Description

protected ContainerListener accessibleContainerHandler

protected FocusListener accessibleFocusHandler
- Fields inherited from class java.awt.Component.AccessibleAWTComponent
  accessibleAWTComponentHandler, accessibleAWTFocusHandler
- Fields inherited from class javax.accessibility.AccessibleContext
  ACCESSIBLE_ACTION_PROPERTY, ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY, ACCESSIBLE_CARET_PROPERTY, ACCESSIBLE_CHILD_PROPERTY, ACCESSIBLE_COMPONENT_BOUNDS_CHANGED, ACCESSIBLE_DESCRIPTION_PROPERTY, ACCESSIBLE_HYPERTEXT_OFFSET, ACCESSIBLE_INVALIDATE_CHILDREN, ACCESSIBLE_NAME_PROPERTY, ACCESSIBLE_SELECTION_PROPERTY, ACCESSIBLE_STATE_PROPERTY, ACCESSIBLE_TABLE_CAPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED, ACCESSIBLE_TABLE_MODEL_CHANGED, ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_ROW_HEADER_CHANGED, ACCESSIBLE_TABLE_SUMMARY_CHANGED, ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED, ACCESSIBLE_TEXT_PROPERTY, ACCESSIBLE_VALUE_PROPERTY, ACCESSIBLE_VISIBLE_DATA_PROPERTY, accessibleDescription, accessibleName, accessibleParent

Fields
Modifier and Type	Field and Description
`protected ContainerListener`	`accessibleContainerHandler`
`protected FocusListener`	`accessibleFocusHandler`

Constructor Summary

Constructors
Modifier Constructor and Description

protected JComponent.AccessibleJComponent()
Though the class is abstract, this should be called by all sub-classes.

Constructors
Modifier	Constructor and Description
`protected`	`JComponent.AccessibleJComponent()` Though the class is abstract, this should be called by all sub-classes.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Adds a PropertyChangeListener to the listener list.
`Accessible`	`getAccessibleChild(int i)` Returns the nth Accessible child of the object.
`int`	`getAccessibleChildrenCount()` Returns the number of accessible children in the object.
`String`	`getAccessibleDescription()` Gets the accessible description of this object.
`AccessibleKeyBinding`	`getAccessibleKeyBinding()` Returns key bindings associated with this object
`String`	`getAccessibleName()` Gets the accessible name of this object.
`AccessibleRole`	`getAccessibleRole()` Gets the role of this object.
`AccessibleStateSet`	`getAccessibleStateSet()` Gets the state of this object.
`protected String`	`getBorderTitle(Border b)` Recursively search through the border hierarchy (if it exists) for a TitledBorder with a non-null title.
`String`	`getTitledBorderText()` Returns the titled border text
`String`	`getToolTipText()` Returns the tool tip text
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a PropertyChangeListener from the listener list.

Methods inherited from class java.awt.Container.AccessibleAWTContainer
getAccessibleAt

Methods inherited from class javax.accessibility.AccessibleContext
firePropertyChange, getAccessibleAction, getAccessibleEditableText, getAccessibleIcon, getAccessibleRelationSet, getAccessibleSelection, getAccessibleTable, getAccessibleText, getAccessibleValue, setAccessibleDescription, setAccessibleName, setAccessibleParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.accessibility.AccessibleComponent
addFocusListener, contains, getAccessibleAt, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible

- Field Detail
  - accessibleContainerHandler
```
protected ContainerListener accessibleContainerHandler
```
  - accessibleFocusHandler
```
protected FocusListener accessibleFocusHandler
```
- Constructor Detail
  - JComponent.AccessibleJComponent
```
protected JComponent.AccessibleJComponent()
```
    Though the class is abstract, this should be called by all sub-classes.
- Method Detail
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Adds a PropertyChangeListener to the listener list.
    
    Overrides:
    
    addPropertyChangeListener in class Container.AccessibleAWTContainer
    
    Parameters:
    listener - the PropertyChangeListener to be added
    See Also:
    AccessibleContext.ACCESSIBLE_NAME_PROPERTY, AccessibleContext.ACCESSIBLE_DESCRIPTION_PROPERTY, AccessibleContext.ACCESSIBLE_STATE_PROPERTY, AccessibleContext.ACCESSIBLE_VALUE_PROPERTY, AccessibleContext.ACCESSIBLE_SELECTION_PROPERTY, AccessibleContext.ACCESSIBLE_TEXT_PROPERTY, AccessibleContext.ACCESSIBLE_VISIBLE_DATA_PROPERTY
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Removes a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.
    
    Overrides:
    
    removePropertyChangeListener in class Component.AccessibleAWTComponent
    
    Parameters:
    listener - the PropertyChangeListener to be removed
  - getBorderTitle
```
protected String getBorderTitle(Border b)
```
    Recursively search through the border hierarchy (if it exists) for a TitledBorder with a non-null title. This does a depth first search on first the inside borders then the outside borders. The assumption is that titles make really pretty inside borders but not very pretty outside borders in compound border situations. It's rather arbitrary, but hopefully decent UI programmers will not create multiple titled borders for the same component.
  - getAccessibleName
```
public String getAccessibleName()
```
    Gets the accessible name of this object. This should almost never return java.awt.Component.getName(), as that generally isn't a localized name, and doesn't have meaning for the user. If the object is fundamentally a text object (such as a menu item), the accessible name should be the text of the object (for example, "save"). If the object has a tooltip, the tooltip text may also be an appropriate String to return.
    
    Overrides:
    
    getAccessibleName in class Component.AccessibleAWTComponent
    
    Returns:
    the localized name of the object -- can be null if this object does not have a name
    See Also:
    AccessibleContext.setAccessibleName(java.lang.String)
  - getAccessibleDescription
```
public String getAccessibleDescription()
```
    Gets the accessible description of this object. This should be a concise, localized description of what this object is - what is its meaning to the user. If the object has a tooltip, the tooltip text may be an appropriate string to return, assuming it contains a concise description of the object (instead of just the name of the object - for example a "Save" icon on a toolbar that had "save" as the tooltip text shouldn't return the tooltip text as the description, but something like "Saves the current text document" instead).
    
    Overrides:
    
    getAccessibleDescription in class Component.AccessibleAWTComponent
    
    Returns:
    the localized description of the object -- can be null if this object does not have a description
    See Also:
    AccessibleContext.setAccessibleDescription(java.lang.String)
  - getAccessibleRole
```
public AccessibleRole getAccessibleRole()
```
    Gets the role of this object.
    
    Overrides:
    
    getAccessibleRole in class Component.AccessibleAWTComponent
    
    Returns:
    an instance of AccessibleRole describing the role of the object
    See Also:
    AccessibleRole
  - getAccessibleStateSet
```
public AccessibleStateSet getAccessibleStateSet()
```
    Gets the state of this object.
    
    Overrides:
    
    getAccessibleStateSet in class Component.AccessibleAWTComponent
    
    Returns:
    an instance of AccessibleStateSet containing the current state set of the object
    See Also:
    AccessibleState
  - getAccessibleChildrenCount
```
public int getAccessibleChildrenCount()
```
    Returns the number of accessible children in the object. If all of the children of this object implement Accessible, than this method should return the number of children of this object.
    
    Overrides:
    
    getAccessibleChildrenCount in class Container.AccessibleAWTContainer
    
    Returns:
    the number of accessible children in the object.
  - getAccessibleChild
```
public Accessible getAccessibleChild(int i)
```
    Returns the nth Accessible child of the object.
    
    Overrides:
    
    getAccessibleChild in class Container.AccessibleAWTContainer
    
    Parameters:
    i - zero-based index of child
    
    Returns:
    the nth Accessible child of the object
    See Also:
    AccessibleContext.getAccessibleChildrenCount()
  - getToolTipText
```
public String getToolTipText()
```
    Returns the tool tip text
    
    Specified by:
    
    getToolTipText in interface AccessibleExtendedComponent
    
    Returns:
    the tool tip text, if supported, of the object; otherwise, null
    Since:
    
    1.4
  - getTitledBorderText
```
public String getTitledBorderText()
```
    Returns the titled border text
    
    Specified by:
    
    getTitledBorderText in interface AccessibleExtendedComponent
    
    Returns:
    the titled border text, if supported, of the object; otherwise, null
    Since:
    
    1.4
  - getAccessibleKeyBinding
```
public AccessibleKeyBinding getAccessibleKeyBinding()
```
    Returns key bindings associated with this object
    
    Specified by:
    
    getAccessibleKeyBinding in interface AccessibleExtendedComponent
    
    Returns:
    the key bindings, if supported, of the object; otherwise, null
    Since:
    
    1.4
    
    See Also:
    AccessibleKeyBinding

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138

Class JComponent.AccessibleJComponent

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Component.AccessibleAWTComponent

Field Summary

Fields inherited from class java.awt.Component.AccessibleAWTComponent

Fields inherited from class javax.accessibility.AccessibleContext

Constructor Summary

Method Summary

Methods inherited from class java.awt.Container.AccessibleAWTContainer

Methods inherited from class java.awt.Component.AccessibleAWTComponent

Methods inherited from class javax.accessibility.AccessibleContext

Methods inherited from class java.lang.Object

Methods inherited from interface javax.accessibility.AccessibleComponent

Field Detail

accessibleContainerHandler

accessibleFocusHandler

Constructor Detail

JComponent.AccessibleJComponent

Method Detail

addPropertyChangeListener

removePropertyChangeListener

getBorderTitle

getAccessibleName

getAccessibleDescription

getAccessibleRole

getAccessibleStateSet

getAccessibleChildrenCount

getAccessibleChild

getToolTipText

getTitledBorderText

getAccessibleKeyBinding