JTree.AccessibleJTree (Java SE 15 & JDK 15) (original) (raw)
All Implemented Interfaces:
[Serializable](../../../java.base/java/io/Serializable.html "interface in java.io")
, [EventListener](../../../java.base/java/util/EventListener.html "interface in java.util")
, [AccessibleComponent](../accessibility/AccessibleComponent.html "interface in javax.accessibility")
, [AccessibleExtendedComponent](../accessibility/AccessibleExtendedComponent.html "interface in javax.accessibility")
, [AccessibleSelection](../accessibility/AccessibleSelection.html "interface in javax.accessibility")
, [TreeExpansionListener](event/TreeExpansionListener.html "interface in javax.swing.event")
, [TreeModelListener](event/TreeModelListener.html "interface in javax.swing.event")
, [TreeSelectionListener](event/TreeSelectionListener.html "interface in javax.swing.event")
Enclosing class:
protected class JTree.AccessibleJTree extends JComponent.AccessibleJComponent implements AccessibleSelection, TreeSelectionListener, TreeModelListener, TreeExpansionListener
This class implements accessibility support for theJTree
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.
Nested Class Summary
Field Summary
Fields declared in class javax.accessibility.AccessibleContext
[ACCESSIBLE_ACTION_PROPERTY](../accessibility/AccessibleContext.html#ACCESSIBLE%5FACTION%5FPROPERTY), [ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY](../accessibility/AccessibleContext.html#ACCESSIBLE%5FACTIVE%5FDESCENDANT%5FPROPERTY), [ACCESSIBLE_CARET_PROPERTY](../accessibility/AccessibleContext.html#ACCESSIBLE%5FCARET%5FPROPERTY), [ACCESSIBLE_CHILD_PROPERTY](../accessibility/AccessibleContext.html#ACCESSIBLE%5FCHILD%5FPROPERTY), [ACCESSIBLE_COMPONENT_BOUNDS_CHANGED](../accessibility/AccessibleContext.html#ACCESSIBLE%5FCOMPONENT%5FBOUNDS%5FCHANGED), [ACCESSIBLE_DESCRIPTION_PROPERTY](../accessibility/AccessibleContext.html#ACCESSIBLE%5FDESCRIPTION%5FPROPERTY), [ACCESSIBLE_HYPERTEXT_OFFSET](../accessibility/AccessibleContext.html#ACCESSIBLE%5FHYPERTEXT%5FOFFSET), [ACCESSIBLE_INVALIDATE_CHILDREN](../accessibility/AccessibleContext.html#ACCESSIBLE%5FINVALIDATE%5FCHILDREN), [ACCESSIBLE_NAME_PROPERTY](../accessibility/AccessibleContext.html#ACCESSIBLE%5FNAME%5FPROPERTY), [ACCESSIBLE_SELECTION_PROPERTY](../accessibility/AccessibleContext.html#ACCESSIBLE%5FSELECTION%5FPROPERTY), [ACCESSIBLE_STATE_PROPERTY](../accessibility/AccessibleContext.html#ACCESSIBLE%5FSTATE%5FPROPERTY), [ACCESSIBLE_TABLE_CAPTION_CHANGED](../accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FCAPTION%5FCHANGED), [ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED](../accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FCOLUMN%5FDESCRIPTION%5FCHANGED), [ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED](../accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FCOLUMN%5FHEADER%5FCHANGED), [ACCESSIBLE_TABLE_MODEL_CHANGED](../accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FMODEL%5FCHANGED), [ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED](../accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FROW%5FDESCRIPTION%5FCHANGED), [ACCESSIBLE_TABLE_ROW_HEADER_CHANGED](../accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FROW%5FHEADER%5FCHANGED), [ACCESSIBLE_TABLE_SUMMARY_CHANGED](../accessibility/AccessibleContext.html#ACCESSIBLE%5FTABLE%5FSUMMARY%5FCHANGED), [ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED](../accessibility/AccessibleContext.html#ACCESSIBLE%5FTEXT%5FATTRIBUTES%5FCHANGED), [ACCESSIBLE_TEXT_PROPERTY](../accessibility/AccessibleContext.html#ACCESSIBLE%5FTEXT%5FPROPERTY), [ACCESSIBLE_VALUE_PROPERTY](../accessibility/AccessibleContext.html#ACCESSIBLE%5FVALUE%5FPROPERTY), [ACCESSIBLE_VISIBLE_DATA_PROPERTY](../accessibility/AccessibleContext.html#ACCESSIBLE%5FVISIBLE%5FDATA%5FPROPERTY), [accessibleDescription](../accessibility/AccessibleContext.html#accessibleDescription), [accessibleName](../accessibility/AccessibleContext.html#accessibleName), [accessibleParent](../accessibility/AccessibleContext.html#accessibleParent)
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 java.awt.Component.AccessibleAWTComponent
[addFocusListener](../../java/awt/Component.AccessibleAWTComponent.html#addFocusListener%28java.awt.event.FocusListener%29), [contains](../../java/awt/Component.AccessibleAWTComponent.html#contains%28java.awt.Point%29), [getAccessibleComponent](../../java/awt/Component.AccessibleAWTComponent.html#getAccessibleComponent%28%29), [getAccessibleParent](../../java/awt/Component.AccessibleAWTComponent.html#getAccessibleParent%28%29), [getBackground](../../java/awt/Component.AccessibleAWTComponent.html#getBackground%28%29), [getBounds](../../java/awt/Component.AccessibleAWTComponent.html#getBounds%28%29), [getCursor](../../java/awt/Component.AccessibleAWTComponent.html#getCursor%28%29), [getFont](../../java/awt/Component.AccessibleAWTComponent.html#getFont%28%29), [getFontMetrics](../../java/awt/Component.AccessibleAWTComponent.html#getFontMetrics%28java.awt.Font%29), [getForeground](../../java/awt/Component.AccessibleAWTComponent.html#getForeground%28%29), [getLocale](../../java/awt/Component.AccessibleAWTComponent.html#getLocale%28%29), [getLocation](../../java/awt/Component.AccessibleAWTComponent.html#getLocation%28%29), [getLocationOnScreen](../../java/awt/Component.AccessibleAWTComponent.html#getLocationOnScreen%28%29), [getSize](../../java/awt/Component.AccessibleAWTComponent.html#getSize%28%29), [isEnabled](../../java/awt/Component.AccessibleAWTComponent.html#isEnabled%28%29), [isFocusTraversable](../../java/awt/Component.AccessibleAWTComponent.html#isFocusTraversable%28%29), [isShowing](../../java/awt/Component.AccessibleAWTComponent.html#isShowing%28%29), [isVisible](../../java/awt/Component.AccessibleAWTComponent.html#isVisible%28%29), [removeFocusListener](../../java/awt/Component.AccessibleAWTComponent.html#removeFocusListener%28java.awt.event.FocusListener%29), [requestFocus](../../java/awt/Component.AccessibleAWTComponent.html#requestFocus%28%29), [setBackground](../../java/awt/Component.AccessibleAWTComponent.html#setBackground%28java.awt.Color%29), [setBounds](../../java/awt/Component.AccessibleAWTComponent.html#setBounds%28java.awt.Rectangle%29), [setCursor](../../java/awt/Component.AccessibleAWTComponent.html#setCursor%28java.awt.Cursor%29), [setEnabled](../../java/awt/Component.AccessibleAWTComponent.html#setEnabled%28boolean%29), [setFont](../../java/awt/Component.AccessibleAWTComponent.html#setFont%28java.awt.Font%29), [setForeground](../../java/awt/Component.AccessibleAWTComponent.html#setForeground%28java.awt.Color%29), [setLocation](../../java/awt/Component.AccessibleAWTComponent.html#setLocation%28java.awt.Point%29), [setSize](../../java/awt/Component.AccessibleAWTComponent.html#setSize%28java.awt.Dimension%29), [setVisible](../../java/awt/Component.AccessibleAWTComponent.html#setVisible%28boolean%29)
Methods declared in class javax.accessibility.AccessibleContext
[firePropertyChange](../accessibility/AccessibleContext.html#firePropertyChange%28java.lang.String,java.lang.Object,java.lang.Object%29), [getAccessibleAction](../accessibility/AccessibleContext.html#getAccessibleAction%28%29), [getAccessibleEditableText](../accessibility/AccessibleContext.html#getAccessibleEditableText%28%29), [getAccessibleIcon](../accessibility/AccessibleContext.html#getAccessibleIcon%28%29), [getAccessibleRelationSet](../accessibility/AccessibleContext.html#getAccessibleRelationSet%28%29), [getAccessibleTable](../accessibility/AccessibleContext.html#getAccessibleTable%28%29), [getAccessibleText](../accessibility/AccessibleContext.html#getAccessibleText%28%29), [getAccessibleValue](../accessibility/AccessibleContext.html#getAccessibleValue%28%29), [setAccessibleDescription](../accessibility/AccessibleContext.html#setAccessibleDescription%28java.lang.String%29), [setAccessibleName](../accessibility/AccessibleContext.html#setAccessibleName%28java.lang.String%29), [setAccessibleParent](../accessibility/AccessibleContext.html#setAccessibleParent%28javax.accessibility.Accessible%29)
Methods declared in class java.lang.Object
[clone](../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../java.base/java/lang/Object.html#notifyAll%28%29), [toString](../../../java.base/java/lang/Object.html#toString%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../java.base/java/lang/Object.html#wait%28long,int%29)
Methods declared in interface javax.accessibility.AccessibleComponent
[addFocusListener](../accessibility/AccessibleComponent.html#addFocusListener%28java.awt.event.FocusListener%29), [contains](../accessibility/AccessibleComponent.html#contains%28java.awt.Point%29), [getBackground](../accessibility/AccessibleComponent.html#getBackground%28%29), [getBounds](../accessibility/AccessibleComponent.html#getBounds%28%29), [getCursor](../accessibility/AccessibleComponent.html#getCursor%28%29), [getFont](../accessibility/AccessibleComponent.html#getFont%28%29), [getFontMetrics](../accessibility/AccessibleComponent.html#getFontMetrics%28java.awt.Font%29), [getForeground](../accessibility/AccessibleComponent.html#getForeground%28%29), [getLocation](../accessibility/AccessibleComponent.html#getLocation%28%29), [getLocationOnScreen](../accessibility/AccessibleComponent.html#getLocationOnScreen%28%29), [getSize](../accessibility/AccessibleComponent.html#getSize%28%29), [isEnabled](../accessibility/AccessibleComponent.html#isEnabled%28%29), [isFocusTraversable](../accessibility/AccessibleComponent.html#isFocusTraversable%28%29), [isShowing](../accessibility/AccessibleComponent.html#isShowing%28%29), [isVisible](../accessibility/AccessibleComponent.html#isVisible%28%29), [removeFocusListener](../accessibility/AccessibleComponent.html#removeFocusListener%28java.awt.event.FocusListener%29), [requestFocus](../accessibility/AccessibleComponent.html#requestFocus%28%29), [setBackground](../accessibility/AccessibleComponent.html#setBackground%28java.awt.Color%29), [setBounds](../accessibility/AccessibleComponent.html#setBounds%28java.awt.Rectangle%29), [setCursor](../accessibility/AccessibleComponent.html#setCursor%28java.awt.Cursor%29), [setEnabled](../accessibility/AccessibleComponent.html#setEnabled%28boolean%29), [setFont](../accessibility/AccessibleComponent.html#setFont%28java.awt.Font%29), [setForeground](../accessibility/AccessibleComponent.html#setForeground%28java.awt.Color%29), [setLocation](../accessibility/AccessibleComponent.html#setLocation%28java.awt.Point%29), [setSize](../accessibility/AccessibleComponent.html#setSize%28java.awt.Dimension%29), [setVisible](../accessibility/AccessibleComponent.html#setVisible%28boolean%29)
Constructor Details
AccessibleJTree
public AccessibleJTree()
ConstructsAccessibleJTree
Method Details
valueChanged
Tree Selection Listener value change method. Used to fire the property change
Specified by:
[valueChanged](event/TreeSelectionListener.html#valueChanged%28javax.swing.event.TreeSelectionEvent%29)
in interface[TreeSelectionListener](event/TreeSelectionListener.html "interface in javax.swing.event")
Parameters:
e
- ListSelectionEventfireVisibleDataPropertyChange
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
Tree Model Node change notification.
Specified by:
[treeNodesChanged](event/TreeModelListener.html#treeNodesChanged%28javax.swing.event.TreeModelEvent%29)
in interface[TreeModelListener](event/TreeModelListener.html "interface in javax.swing.event")
Parameters:
e
- a Tree Model eventtreeNodesInserted
Tree Model Node change notification.
Specified by:
[treeNodesInserted](event/TreeModelListener.html#treeNodesInserted%28javax.swing.event.TreeModelEvent%29)
in interface[TreeModelListener](event/TreeModelListener.html "interface in javax.swing.event")
Parameters:
e
- a Tree node insertion eventtreeNodesRemoved
Tree Model Node change notification.
Specified by:
[treeNodesRemoved](event/TreeModelListener.html#treeNodesRemoved%28javax.swing.event.TreeModelEvent%29)
in interface[TreeModelListener](event/TreeModelListener.html "interface in javax.swing.event")
Parameters:
e
- a Tree node(s) removal eventtreeStructureChanged
Tree Model structure change change notification.
Specified by:
[treeStructureChanged](event/TreeModelListener.html#treeStructureChanged%28javax.swing.event.TreeModelEvent%29)
in interface[TreeModelListener](event/TreeModelListener.html "interface in javax.swing.event")
Parameters:
e
- a Tree Model eventtreeCollapsed
Tree Collapsed notification.
Specified by:
[treeCollapsed](event/TreeExpansionListener.html#treeCollapsed%28javax.swing.event.TreeExpansionEvent%29)
in interface[TreeExpansionListener](event/TreeExpansionListener.html "interface in javax.swing.event")
Parameters:
e
- a TreeExpansionEventtreeExpanded
Tree Model Expansion notification.
Specified by:
[treeExpanded](event/TreeExpansionListener.html#treeExpanded%28javax.swing.event.TreeExpansionEvent%29)
in interface[TreeExpansionListener](event/TreeExpansionListener.html "interface in javax.swing.event")
Parameters:
e
- a Tree node insertion eventgetAccessibleRole
Get the role of this object.
Overrides:
[getAccessibleRole](JComponent.AccessibleJComponent.html#getAccessibleRole%28%29)
in class[JComponent.AccessibleJComponent](JComponent.AccessibleJComponent.html "class in javax.swing")
Returns:
an instance of AccessibleRole describing the role of the object
See Also:
AccessibleRolegetAccessibleAt
Returns the
Accessible
child, if one exists, contained at the local coordinatePoint
. Otherwise returnsnull
.
Specified by:
[getAccessibleAt](../accessibility/AccessibleComponent.html#getAccessibleAt%28java.awt.Point%29)
in interface[AccessibleComponent](../accessibility/AccessibleComponent.html "interface in javax.accessibility")
Overrides:
[getAccessibleAt](../../java/awt/Container.AccessibleAWTContainer.html#getAccessibleAt%28java.awt.Point%29)
in class[Container.AccessibleAWTContainer](../../java/awt/Container.AccessibleAWTContainer.html "class in java.awt")
Parameters:
p
- point in local coordinates of thisAccessible
Returns:
theAccessible
, if it exists, at the specified location; elsenull
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](JComponent.AccessibleJComponent.html#getAccessibleChildrenCount%28%29)
in class[JComponent.AccessibleJComponent](JComponent.AccessibleJComponent.html "class in javax.swing")
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](JComponent.AccessibleJComponent.html#getAccessibleChild%28int%29)
in class[JComponent.AccessibleJComponent](JComponent.AccessibleJComponent.html "class in javax.swing")
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](../../java/awt/Component.AccessibleAWTComponent.html#getAccessibleIndexInParent%28%29)
in class[Component.AccessibleAWTComponent](../../java/awt/Component.AccessibleAWTComponent.html "class in java.awt")
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
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](../accessibility/AccessibleContext.html#getAccessibleSelection%28%29)
in class[AccessibleContext](../accessibility/AccessibleContext.html "class in javax.accessibility")
Returns:
this object
See Also:
AccessibleSelectiongetAccessibleSelectionCount
public int getAccessibleSelectionCount()
Returns the number of items currently selected. If no items are selected, the return value will be 0.
Specified by:
[getAccessibleSelectionCount](../accessibility/AccessibleSelection.html#getAccessibleSelectionCount%28%29)
in interface[AccessibleSelection](../accessibility/AccessibleSelection.html "interface in javax.accessibility")
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](../accessibility/AccessibleSelection.html#getAccessibleSelection%28int%29)
in interface[AccessibleSelection](../accessibility/AccessibleSelection.html "interface in javax.accessibility")
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](../accessibility/AccessibleSelection.html#isAccessibleChildSelected%28int%29)
in interface[AccessibleSelection](../accessibility/AccessibleSelection.html "interface in javax.accessibility")
Parameters:
i
- the zero-based index of the child in this Accessible object.
Returns:
true
if the current child of this object is selected; elsefalse
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](../accessibility/AccessibleSelection.html#addAccessibleSelection%28int%29)
in interface[AccessibleSelection](../accessibility/AccessibleSelection.html "interface in javax.accessibility")
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](../accessibility/AccessibleSelection.html#removeAccessibleSelection%28int%29)
in interface[AccessibleSelection](../accessibility/AccessibleSelection.html "interface in javax.accessibility")
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](../accessibility/AccessibleSelection.html#clearAccessibleSelection%28%29)
in interface[AccessibleSelection](../accessibility/AccessibleSelection.html "interface in javax.accessibility")
selectAllAccessibleSelection
public void selectAllAccessibleSelection()
Causes every selected item in the object to be selected if the object supports multiple selections.
Specified by:
[selectAllAccessibleSelection](../accessibility/AccessibleSelection.html#selectAllAccessibleSelection%28%29)
in interface[AccessibleSelection](../accessibility/AccessibleSelection.html "interface in javax.accessibility")