Class JTree.AccessibleJTree

java.lang.Object

javax.accessibility.AccessibleContext

java.awt.Component.AccessibleAWTComponent

java.awt.Container.AccessibleAWTContainer

javax.swing.JComponent.AccessibleJComponent

javax.swing.JTree.AccessibleJTree

All Implemented Interfaces:

Serializable, EventListener, AccessibleComponent, AccessibleExtendedComponent, AccessibleSelection, TreeExpansionListener, TreeModelListener, TreeSelectionListener

Enclosing class:

JTree

protected class JTree.AccessibleJTree
extends JComponent.AccessibleJComponent
implements AccessibleSelection, TreeSelectionListener, TreeModelListener, TreeExpansionListener

This class implements accessibility support for the JTree class. It provides an implementation of the Java Accessibility API appropriate to tree user-interface elements.

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 has been added to the java.beans package. Please see XMLEncoder.

Since:

1.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JTree.AccessibleJTree.AccessibleJTreeNode	This class implements accessibility support for the JTree child.

Nested classes/interfaces declared in class JComponent.AccessibleJComponent

JComponent.AccessibleJComponent.AccessibleContainerHandler, JComponent.AccessibleJComponent.AccessibleFocusHandler

Modifier and Type	Class	Description
protected class	JComponent.AccessibleJComponent.AccessibleContainerHandler	Fire PropertyChange listener, if one is registered, when children added/removed.
protected class	JComponent.AccessibleJComponent.AccessibleFocusHandler	Deprecated. This class is no longer used or needed.

Nested classes/interfaces declared in class Component.AccessibleAWTComponent

Component.AccessibleAWTComponent.AccessibleAWTComponentHandler, Component.AccessibleAWTComponent.AccessibleAWTFocusHandler

Modifier and Type	Class	Description
protected class	Component.AccessibleAWTComponent.AccessibleAWTComponentHandler	Fire PropertyChange listener, if one is registered, when shown/hidden..
protected class	Component.AccessibleAWTComponent.AccessibleAWTFocusHandler	Fire PropertyChange listener, if one is registered, when focus events happen

Field Summary

Fields declared in class JComponent.AccessibleJComponent

accessibleFocusHandler

Modifier and Type	Field	Description
protected FocusListener	accessibleFocusHandler	Deprecated.

Fields declared in class Container.AccessibleAWTContainer

accessibleContainerHandler

Modifier and Type	Field	Description
protected ContainerListener	accessibleContainerHandler	The handler to fire PropertyChange when children are added or removed

Fields declared in class Component.AccessibleAWTComponent

accessibleAWTComponentHandler, accessibleAWTFocusHandler

Modifier and Type	Field	Description
protected ComponentListener	accessibleAWTComponentHandler	A component listener to track show/hide/resize events and convert them to PropertyChange events.
protected FocusListener	accessibleAWTFocusHandler	A listener to track focus events and convert them to PropertyChange events.

Fields declared in class 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

Modifier and Type	Field	Description
static final String	ACCESSIBLE_ACTION_PROPERTY	Constant used to indicate that the supported set of actions has changed.
static final String	ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY	Constant used to determine when the active descendant of a component has changed.
static final String	ACCESSIBLE_CARET_PROPERTY	Constant used to determine when the accessibleText caret has changed.
static final String	ACCESSIBLE_CHILD_PROPERTY	Constant used to determine when Accessible children are added/removed from the object.
static final String	ACCESSIBLE_COMPONENT_BOUNDS_CHANGED	PropertyChangeEvent which indicates that a change has occurred in a component's bounds.
static final String	ACCESSIBLE_DESCRIPTION_PROPERTY	Constant used to determine when the AccessibleContext.accessibleDescription property has changed.
static final String	ACCESSIBLE_HYPERTEXT_OFFSET	Constant used to indicate that a hypertext element has received focus.
static final String	ACCESSIBLE_INVALIDATE_CHILDREN	PropertyChangeEvent which indicates that a significant change has occurred to the children of a component like a tree or text.
static final String	ACCESSIBLE_NAME_PROPERTY	Constant used to determine when the AccessibleContext.accessibleName property has changed.
static final String	ACCESSIBLE_SELECTION_PROPERTY	Constant used to determine when the accessibleSelection has changed.
static final String	ACCESSIBLE_STATE_PROPERTY	Constant used to determine when the accessibleStateSet property has changed.
static final String	ACCESSIBLE_TABLE_CAPTION_CHANGED	Constant used to indicate that the table caption has changed.
static final String	ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED	Constant used to indicate that the column description has changed.
static final String	ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED	Constant used to indicate that the column header has changed.
static final String	ACCESSIBLE_TABLE_MODEL_CHANGED	Constant used to indicate that table data has changed.
static final String	ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED	Constant used to indicate that the row description has changed.
static final String	ACCESSIBLE_TABLE_ROW_HEADER_CHANGED	Constant used to indicate that the row header has changed.
static final String	ACCESSIBLE_TABLE_SUMMARY_CHANGED	Constant used to indicate that the table summary has changed.
static final String	ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED	PropertyChangeEvent which indicates that text attributes have changed.
static final String	ACCESSIBLE_TEXT_PROPERTY	PropertyChangeEvent which indicates that text has changed.
static final String	ACCESSIBLE_VALUE_PROPERTY	Constant used to determine when the accessibleValue property has changed.
static final String	ACCESSIBLE_VISIBLE_DATA_PROPERTY	Constant used to determine when the visual appearance of the object has changed.
protected String	accessibleDescription	A localized String containing the description of the object.
protected String	accessibleName	A localized String containing the name of the object.
protected Accessible	accessibleParent	The accessible parent of this object.

Constructor Summary

Constructors

Constructor	Description
AccessibleJTree()	Constructs AccessibleJTree

Method Summary

Modifier and Type	Method	Description
void	addAccessibleSelection(int i)	Adds the specified selected item in the object to the object's selection.
void	clearAccessibleSelection()	Clears the selection in the object, so that nothing in the object is selected.
void	fireVisibleDataPropertyChange()	Fire a visible data property change notification.
Accessible	getAccessibleAt(Point p)	Returns the Accessible child, if one exists, contained at the local coordinate Point.
Accessible	getAccessibleChild(int i)	Return the nth Accessible child of the object.
int	getAccessibleChildrenCount()	Returns the number of top-level children nodes of this JTree.
int	getAccessibleIndexInParent()	Get the index of this object in its accessible parent.
AccessibleRole	getAccessibleRole()	Get the role of this object.
AccessibleSelection	getAccessibleSelection()	Get the AccessibleSelection associated with this object.
Accessible	getAccessibleSelection(int i)	Returns an Accessible representing the specified selected item in the object.
int	getAccessibleSelectionCount()	Returns the number of items currently selected.
boolean	isAccessibleChildSelected(int i)	Returns true if the current child of this object is selected.
void	removeAccessibleSelection(int i)	Removes the specified selected item in the object from the object's selection.
void	selectAllAccessibleSelection()	Causes every selected item in the object to be selected if the object supports multiple selections.
void	treeCollapsed(TreeExpansionEvent e)	Tree Collapsed notification.
void	treeExpanded(TreeExpansionEvent e)	Tree Model Expansion notification.
void	treeNodesChanged(TreeModelEvent e)	Tree Model Node change notification.
void	treeNodesInserted(TreeModelEvent e)	Tree Model Node change notification.
void	treeNodesRemoved(TreeModelEvent e)	Tree Model Node change notification.
void	treeStructureChanged(TreeModelEvent e)	Tree Model structure change change notification.
void	valueChanged(TreeSelectionEvent e)	Tree Selection Listener value change method.

Methods declared in class JComponent.AccessibleJComponent

addPropertyChangeListener, getAccessibleDescription, getAccessibleKeyBinding, getAccessibleName, getAccessibleStateSet, getBorderTitle, getTitledBorderText, getToolTipText, removePropertyChangeListener

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)	Adds a PropertyChangeListener to the listener list.
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.
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 declared in class Component.AccessibleAWTComponent

addFocusListener, contains, getAccessibleComponent, getAccessibleParent, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocale, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible

Modifier and Type	Method	Description
void	addFocusListener(FocusListener l)	Adds the specified focus listener to receive focus events from this component.
boolean	contains(Point p)	Checks whether the specified point is within this object's bounds, where the point's x and y coordinates are defined to be relative to the coordinate system of the object.
AccessibleComponent	getAccessibleComponent()	Gets the AccessibleComponent associated with this object if one exists.
Accessible	getAccessibleParent()	Gets the Accessible parent of this object.
Color	getBackground()	Gets the background color of this object.
Rectangle	getBounds()	Gets the bounds of this object in the form of a Rectangle object.
Cursor	getCursor()	Gets the Cursor of this object.
Font	getFont()	Gets the Font of this object.
FontMetrics	getFontMetrics(Font f)	Gets the FontMetrics of this object.
Color	getForeground()	Gets the foreground color of this object.
Locale	getLocale()	Returns the locale of this object.
Point	getLocation()	Gets the location of the object relative to the parent in the form of a point specifying the object's top-left corner in the screen's coordinate space.
Point	getLocationOnScreen()	Returns the location of the object on the screen.
Dimension	getSize()	Returns the size of this object in the form of a Dimension object.
boolean	isEnabled()	Determines if the object is enabled.
boolean	isFocusTraversable()	Returns whether this object can accept focus or not.
boolean	isShowing()	Determines if the object is showing.
boolean	isVisible()	Determines if the object is visible.
void	removeFocusListener(FocusListener l)	Removes the specified focus listener so it no longer receives focus events from this component.
void	requestFocus()	Requests focus for this object.
void	setBackground(Color c)	Sets the background color of this object.
void	setBounds(Rectangle r)	Sets the bounds of this object in the form of a Rectangle object.
void	setCursor(Cursor cursor)	Sets the Cursor of this object.
void	setEnabled(boolean b)	Sets the enabled state of the object.
void	setFont(Font f)	Sets the Font of this object.
void	setForeground(Color c)	Sets the foreground color of this object.
void	setLocation(Point p)	Sets the location of the object relative to the parent.
void	setSize(Dimension d)	Resizes this object so that it has width and height.
void	setVisible(boolean b)	Sets the visible state of the object.

Methods declared in class AccessibleContext

firePropertyChange, getAccessibleAction, getAccessibleEditableText, getAccessibleIcon, getAccessibleRelationSet, getAccessibleTable, getAccessibleText, getAccessibleValue, setAccessibleDescription, setAccessibleName, setAccessibleParent

Modifier and Type	Method	Description
void	firePropertyChange(String propertyName, Object oldValue, Object newValue)	Support for reporting bound property changes.
AccessibleAction	getAccessibleAction()	Gets the AccessibleAction associated with this object that supports one or more actions.
AccessibleEditableText	getAccessibleEditableText()	Gets the AccessibleEditableText associated with this object presenting editable text on the display.
AccessibleIcon[]	getAccessibleIcon()	Gets the AccessibleIcons associated with an object that has one or more associated icons.
AccessibleRelationSet	getAccessibleRelationSet()	Gets the AccessibleRelationSet associated with an object.
AccessibleTable	getAccessibleTable()	Gets the AccessibleTable associated with an object.
AccessibleText	getAccessibleText()	Gets the AccessibleText associated with this object presenting text on the display.
AccessibleValue	getAccessibleValue()	Gets the AccessibleValue associated with this object that supports a Numerical value.
void	setAccessibleDescription(String s)	Sets the accessible description of this object.
void	setAccessibleName(String s)	Sets the localized accessible name of this object.
void	setAccessibleParent(Accessible a)	Sets the Accessible parent of this object.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
final Class<?>	getClass()	Returns the runtime class of this Object.
int	hashCode()	Returns a hash code value for this object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
String	toString()	Returns a string representation of the object.
final void	wait()	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
final void	wait(long timeoutMillis)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
final void	wait(long timeoutMillis, int nanos)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

AccessibleJTree

public AccessibleJTree()

Constructs AccessibleJTree

Method Details

valueChanged

public void valueChanged(TreeSelectionEvent e)

Tree Selection Listener value change method. Used to fire the property change

Specified by:

valueChanged in interface TreeSelectionListener

Parameters:

e - ListSelectionEvent

fireVisibleDataPropertyChange

public void fireVisibleDataPropertyChange()

Fire a visible data property change notification. A 'visible' data property is one that represents something about the way the component appears on the display, where that appearance isn't bound to any other property. It notifies screen readers that the visual appearance of the component has changed, so they can notify the user.

treeNodesChanged

public void treeNodesChanged(TreeModelEvent e)

Tree Model Node change notification.

Specified by:

treeNodesChanged in interface TreeModelListener

Parameters:

e - a Tree Model event

treeNodesInserted

public void treeNodesInserted(TreeModelEvent e)

Tree Model Node change notification.

Specified by:

treeNodesInserted in interface TreeModelListener

Parameters:

e - a Tree node insertion event

treeNodesRemoved

public void treeNodesRemoved(TreeModelEvent e)

Tree Model Node change notification.

Specified by:

treeNodesRemoved in interface TreeModelListener

Parameters:

e - a Tree node(s) removal event

treeStructureChanged

public void treeStructureChanged(TreeModelEvent e)

Tree Model structure change change notification.

Specified by:

treeStructureChanged in interface TreeModelListener

Parameters:

e - a Tree Model event

treeCollapsed

public void treeCollapsed(TreeExpansionEvent e)

Tree Collapsed notification.

Specified by:

treeCollapsed in interface TreeExpansionListener

Parameters:

e - a TreeExpansionEvent

treeExpanded

public void treeExpanded(TreeExpansionEvent e)

Tree Model Expansion notification.

Specified by:

treeExpanded in interface TreeExpansionListener

Parameters:

e - a Tree node insertion event

getAccessibleRole

public AccessibleRole getAccessibleRole()

Get the role of this object.

Overrides:

getAccessibleRole in class JComponent.AccessibleJComponent

Returns:

an instance of AccessibleRole describing the role of the object

See Also:

• AccessibleRole

getAccessibleAt

public Accessible getAccessibleAt(Point p)

Returns the Accessible child, if one exists, contained at the local coordinate Point. Otherwise returns null.

Specified by:

getAccessibleAt in interface AccessibleComponent

Overrides:

getAccessibleAt in class Container.AccessibleAWTContainer

Parameters:

p - point in local coordinates of this Accessible

Returns:

the Accessible, if it exists, at the specified location; else null

getAccessibleChildrenCount

public int getAccessibleChildrenCount()

Returns the number of top-level children nodes of this JTree. Each of these nodes may in turn have children nodes.

Overrides:

getAccessibleChildrenCount in class JComponent.AccessibleJComponent

Returns:

the number of accessible children nodes in the tree.

getAccessibleChild

public Accessible getAccessibleChild(int i)

Return the nth Accessible child of the object.

Overrides:

getAccessibleChild in class JComponent.AccessibleJComponent

Parameters:

i - zero-based index of child

Returns:

the nth Accessible child of the object

See Also:

• AccessibleContext.getAccessibleChildrenCount()

getAccessibleIndexInParent

public int getAccessibleIndexInParent()

Get the index of this object in its accessible parent.

Overrides:

getAccessibleIndexInParent in class Component.AccessibleAWTComponent

Returns:

the index of this object in its parent. Since a JTree top-level object does not have an accessible parent.

See Also:

• Component.AccessibleAWTComponent.getAccessibleParent()

getAccessibleSelection

public AccessibleSelection getAccessibleSelection()

Get the AccessibleSelection associated with this object. In the implementation of the Java Accessibility API for this class, return this object, which is responsible for implementing the AccessibleSelection interface on behalf of itself.

Overrides:

getAccessibleSelection in class AccessibleContext

Returns:

this object

See Also:

• AccessibleSelection

getAccessibleSelectionCount

public int getAccessibleSelectionCount()

Returns the number of items currently selected. If no items are selected, the return value will be 0.

Specified by:

getAccessibleSelectionCount in interface AccessibleSelection

Returns:

the number of items currently selected.

getAccessibleSelection

public Accessible getAccessibleSelection(int i)

Returns an Accessible representing the specified selected item in the object. If there isn't a selection, or there are fewer items selected than the integer passed in, the return value will be null.

Specified by:

getAccessibleSelection in interface AccessibleSelection

Parameters:

i - the zero-based index of selected items

Returns:

an Accessible containing the selected item

See Also:

• AccessibleSelection.getAccessibleSelectionCount()

isAccessibleChildSelected

public boolean isAccessibleChildSelected(int i)

Returns true if the current child of this object is selected.

Specified by:

isAccessibleChildSelected in interface AccessibleSelection

Parameters:

i - the zero-based index of the child in this Accessible object.

Returns:

true if the current child of this object is selected; else false

See Also:

• AccessibleContext.getAccessibleChild(int)

addAccessibleSelection

public void addAccessibleSelection(int i)

Adds the specified selected item in the object to the object's selection. If the object supports multiple selections, the specified item is added to any existing selection, otherwise it replaces any existing selection in the object. If the specified item is already selected, this method has no effect.

Specified by:

addAccessibleSelection in interface AccessibleSelection

Parameters:

i - the zero-based index of selectable items

See Also:

• AccessibleContext.getAccessibleChild(int)

removeAccessibleSelection

public void removeAccessibleSelection(int i)

Removes the specified selected item in the object from the object's selection. If the specified item isn't currently selected, this method has no effect.

Specified by:

removeAccessibleSelection in interface AccessibleSelection

Parameters:

i - the zero-based index of selectable items

See Also:

• AccessibleContext.getAccessibleChild(int)

clearAccessibleSelection

public void clearAccessibleSelection()

Clears the selection in the object, so that nothing in the object is selected.

Specified by:

clearAccessibleSelection in interface AccessibleSelection

selectAllAccessibleSelection

public void selectAllAccessibleSelection()

Causes every selected item in the object to be selected if the object supports multiple selections.

Specified by:

selectAllAccessibleSelection in interface AccessibleSelection