This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing
class JTree.AccessibleJTree

java.lang.Object extended by javax.accessibility.AccessibleContext extended by java.awt.Component.AccessibleAWTComponent extended by java.awt.Container.AccessibleAWTContainer extended by javax.swing.JComponent.AccessibleJComponent extended by javax.swing.JTree.AccessibleJTree
All Implemented Interfaces:
Serializable, 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 JavaBeansTM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.


Nested Class Summary
protected class

           This class implements accessibility support for the JTree child.
Nested classes/interfaces inherited from class javax.swing.JComponent.AccessibleJComponent
JComponent.AccessibleJComponent.AccessibleContainerHandler, JComponent.AccessibleJComponent.AccessibleFocusHandler
 
Nested classes/interfaces inherited from class java.awt.Container.AccessibleAWTContainer
Container.AccessibleAWTContainer.AccessibleContainerHandler
 
Nested classes/interfaces inherited from class java.awt.Component.AccessibleAWTComponent
Component.AccessibleAWTComponent.AccessibleAWTComponentHandler, Component.AccessibleAWTComponent.AccessibleAWTFocusHandler
   
Field Summary
 
Fields inherited from class javax.swing.JComponent.AccessibleJComponent
accessibleContainerHandler, accessibleFocusHandler
 
Fields inherited from class java.awt.Container.AccessibleAWTContainer
accessibleContainerHandler
 
Fields inherited from class java.awt.Component.AccessibleAWTComponent
accessibleAWTComponentHandler, accessibleAWTFocusHandler
 
Fields inherited from class javax.accessibility.AccessibleContext
accessibleDescription, accessibleName, accessibleParent, 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
 
Constructor Summary

          
 
Method Summary
 void

          Adds the specified selected item in the object to the object's selection.
 void

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

          Fire a visible data property change notification.
 Accessible

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

          Return the nth Accessible child of the object.
 int

          Returns the number of top-level children nodes of this JTree.
 int

          Get the index of this object in its accessible parent.
 AccessibleRole

          Get the role of this object.
 AccessibleSelection

          Get the AccessibleSelection associated with this object.
 Accessible

          Returns an Accessible representing the specified selected item in the object.
 int

          Returns the number of items currently selected.
 boolean

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

          Removes the specified selected item in the object from the object's selection.
 void

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

          Tree Collapsed notification.
 void

          Tree Model Expansion notification.
 void

          Tree Model Node change notification.
 void

          Tree Model Node change notification.
 void

          Tree Model Node change notification.
 void

          Tree Model structure change change notification.
 void

          Tree Selection Listener value change method.
 
Methods inherited from class javax.swing.JComponent.AccessibleJComponent
addPropertyChangeListener, getAccessibleChild, getAccessibleChildrenCount, getAccessibleDescription, getAccessibleKeyBinding, getAccessibleName, getAccessibleRole, getAccessibleStateSet, getBorderTitle, getTitledBorderText, getToolTipText, removePropertyChangeListener
 
Methods inherited from class java.awt.Container.AccessibleAWTContainer
addPropertyChangeListener, getAccessibleAt, getAccessibleChild, getAccessibleChildrenCount
 
Methods inherited from class java.awt.Component.AccessibleAWTComponent
addFocusListener, addPropertyChangeListener, contains, getAccessibleAt, getAccessibleChild, getAccessibleChildrenCount, getAccessibleComponent, getAccessibleDescription, getAccessibleIndexInParent, getAccessibleName, getAccessibleParent, getAccessibleRole, getAccessibleStateSet, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocale, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, removePropertyChangeListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible
 
Methods inherited from class javax.accessibility.AccessibleContext
addPropertyChangeListener, firePropertyChange, getAccessibleAction, getAccessibleChild, getAccessibleChildrenCount, getAccessibleComponent, getAccessibleDescription, getAccessibleEditableText, getAccessibleIcon, getAccessibleIndexInParent, getAccessibleName, getAccessibleParent, getAccessibleRelationSet, getAccessibleRole, getAccessibleSelection, getAccessibleStateSet, getAccessibleTable, getAccessibleText, getAccessibleValue, getLocale, removePropertyChangeListener, setAccessibleDescription, setAccessibleName, setAccessibleParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JTree.AccessibleJTree

public JTree.AccessibleJTree()
Method Detail

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.

Parameters:
i - the zero-based index of selectable items

clearAccessibleSelection

public void clearAccessibleSelection()
Clears the selection in the object, so that nothing in the object is selected.


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.


getAccessibleAt

public Accessible getAccessibleAt(Point p)
Returns the Accessible child, if one exists, contained at the local coordinate Point. Otherwise returns null.

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

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

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.

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.

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

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

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.

Parameters:
i - the zero-based index of selected items
Returns:
an Accessible containing the selected item

getAccessibleSelectionCount

public int getAccessibleSelectionCount()
Returns the number of items currently selected. If no items are selected, the return value will be 0.

Returns:
the number of items currently selected.

isAccessibleChildSelected

public boolean isAccessibleChildSelected(int i)
Returns true if the current child of this object is selected.

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

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.

Parameters:
i - the zero-based index of selectable items

selectAllAccessibleSelection

public void selectAllAccessibleSelection()
Causes every selected item in the object to be selected if the object supports multiple selections.


treeCollapsed

public void treeCollapsed(TreeExpansionEvent e)
Tree Collapsed notification.

Parameters:
e - a TreeExpansionEvent

treeExpanded

public void treeExpanded(TreeExpansionEvent e)
Tree Model Expansion notification.

Parameters:
e - a Tree node insertion event

treeNodesChanged

public void treeNodesChanged(TreeModelEvent e)
Tree Model Node change notification.

Parameters:
e - a Tree Model event

treeNodesInserted

public void treeNodesInserted(TreeModelEvent e)
Tree Model Node change notification.

Parameters:
e - a Tree node insertion event

treeNodesRemoved

public void treeNodesRemoved(TreeModelEvent e)
Tree Model Node change notification.

Parameters:
e - a Tree node(s) removal event

treeStructureChanged

public void treeStructureChanged(TreeModelEvent e)
Tree Model structure change change notification.

Parameters:
e - a Tree Model event

valueChanged

public void valueChanged(TreeSelectionEvent e)
Tree Selection Listener value change method. Used to fire the property change

Parameters:
e - ListSelectionEvent


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.