Class JTree.AccessibleJTree.AccessibleJTreeNode
java.lang.Object
javax.accessibility.AccessibleContext
javax.swing.JTree.AccessibleJTree.AccessibleJTreeNode
- All Implemented Interfaces:
Accessible
,AccessibleAction
,AccessibleComponent
,AccessibleSelection
- Enclosing class:
JTree.AccessibleJTree
protected class JTree.AccessibleJTree.AccessibleJTreeNode
extends AccessibleContext
implements Accessible, AccessibleComponent, AccessibleSelection, AccessibleAction
This class implements accessibility support for the
JTree
child. It provides an implementation of the
Java Accessibility API appropriate to tree nodes.- Since:
- 1.2
-
Field Summary
Fields declared in 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
Fields declared in interface javax.accessibility.AccessibleAction
CLICK, DECREMENT, INCREMENT, TOGGLE_EXPAND, TOGGLE_POPUP
-
Constructor Summary
ConstructorDescriptionAccessibleJTreeNode
(JTree t, TreePath p, Accessible ap) Constructs an AccessibleJTreeNode -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAccessibleSelection
(int i) Adds the specified selected item in the object to the object's selection.void
Adds the specified focus listener to receive focus events from this component.void
Add a PropertyChangeListener to the listener list.void
Clears the selection in the object, so that nothing in the object is selected.boolean
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.boolean
doAccessibleAction
(int i) Perform the specified Action on the tree node.Get the AccessibleAction associated with this object.int
Returns the number of accessible actions available in this tree node.Return a description of the specified action of the tree node.Returns theAccessible
child, if one exists, contained at the local coordinatePoint
.getAccessibleChild
(int i) Return the specified Accessible child of the object.int
Returns the number of accessible children in the object.Get the AccessibleComponent associated with this object.Get the AccessibleContext associated with this tree node.Get the accessible description of this object.int
Get the index of this object in its accessible parent.Get the accessible name of this object.Get the Accessible parent of this object.Get the role of this object.Get the AccessibleSelection associated with this object if one exists.getAccessibleSelection
(int i) Returns an Accessible representing the specified selected item in the object.int
Returns the number of items currently selected.Get the state set of this object.Get the AccessibleText associated with this object if one exists.Get the AccessibleValue associated with this object if one exists.Get the background color of this object.Gets the bounds of this object in the form of aRectangle
object.Gets the cursor of this object.getFont()
Gets the font of this object.Gets theFontMetrics
of this object.Get the foreground color of this object.Gets the locale of the component.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.protected Point
Returns the relative location of the nodeReturns the location of the object on the screen.getSize()
Returns the size of this object in the form of aDimension
object.boolean
isAccessibleChildSelected
(int i) Returns true if the current child of this object is selected.boolean
Determines if the object is enabled.boolean
Returns whether this object can accept focus or not.boolean
Determines if the object is showing.boolean
Determines if the object is visible.void
removeAccessibleSelection
(int i) Removes the specified selected item in the object from the object's selection.void
Removes the specified focus listener so it no longer receives focus events from this component.void
Remove a PropertyChangeListener from the listener list.void
Requests focus for this object.void
Causes every selected item in the object to be selected if the object supports multiple selections.void
Set the accessible description of this object.void
Set the localized accessible name of this object.void
Set the background color of this object.void
Sets the bounds of this object in the form of aRectangle
object.void
Sets the cursor of this object.void
setEnabled
(boolean b) Sets the enabled state of the object.void
Sets the font of this object.void
Sets the foreground color of this object.void
setLocation
(Point p) Sets the location of the object relative to the parent.void
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 javax.accessibility.AccessibleContext
firePropertyChange, getAccessibleEditableText, getAccessibleIcon, getAccessibleRelationSet, getAccessibleTable, setAccessibleParent
-
Constructor Details
-
AccessibleJTreeNode
Constructs an AccessibleJTreeNode- Parameters:
t
- an instance ofJTree
p
- an instance ofTreePath
ap
- an instance ofAccessible
- Since:
- 1.4
-
-
Method Details
-
getAccessibleContext
Get the AccessibleContext associated with this tree node. In the implementation of the Java Accessibility API for this class, return this object, which is its own AccessibleContext.- Specified by:
getAccessibleContext
in interfaceAccessible
- Returns:
- this object
-
getAccessibleName
Get the accessible name of this object.- Overrides:
getAccessibleName
in classAccessibleContext
- Returns:
- the localized name of the object; null if this object does not have a name
- See Also:
-
setAccessibleName
Set the localized accessible name of this object.- Overrides:
setAccessibleName
in classAccessibleContext
- Parameters:
s
- the new localized name of the object.- See Also:
-
getAccessibleDescription
Get the accessible description of this object.- Overrides:
getAccessibleDescription
in classAccessibleContext
- Returns:
- the localized description of the object; null if this object does not have a description
- See Also:
-
setAccessibleDescription
Set the accessible description of this object.- Overrides:
setAccessibleDescription
in classAccessibleContext
- Parameters:
s
- the new localized description of the object- See Also:
-
getAccessibleRole
Get the role of this object.- Specified by:
getAccessibleRole
in classAccessibleContext
- Returns:
- an instance of AccessibleRole describing the role of the object
- See Also:
-
getAccessibleStateSet
Get the state set of this object.- Specified by:
getAccessibleStateSet
in classAccessibleContext
- Returns:
- an instance of AccessibleStateSet containing the current state set of the object
- See Also:
-
getAccessibleParent
Get the Accessible parent of this object.- Overrides:
getAccessibleParent
in classAccessibleContext
- Returns:
- the Accessible parent of this object; null if this object does not have an Accessible parent
-
getAccessibleIndexInParent
public int getAccessibleIndexInParent()Get the index of this object in its accessible parent.- Specified by:
getAccessibleIndexInParent
in classAccessibleContext
- Returns:
- the index of this object in its parent; -1 if this object does not have an accessible parent.
- See Also:
-
getAccessibleChildrenCount
public int getAccessibleChildrenCount()Returns the number of accessible children in the object.- Specified by:
getAccessibleChildrenCount
in classAccessibleContext
- Returns:
- the number of accessible children in the object.
-
getAccessibleChild
Return the specified Accessible child of the object.- Specified by:
getAccessibleChild
in classAccessibleContext
- Parameters:
i
- zero-based index of child- Returns:
- the Accessible child of the object
- See Also:
-
getLocale
Gets the locale of the component. If the component does not have a locale, then the locale of its parent is returned.- Specified by:
getLocale
in classAccessibleContext
- Returns:
- This component's locale. If this component does not have a locale, the locale of its parent is returned.
- Throws:
IllegalComponentStateException
- If the Component does not have its own locale and has not yet been added to a containment hierarchy such that the locale can be determined from the containing parent.- See Also:
-
addPropertyChangeListener
Add a PropertyChangeListener to the listener list. The listener is registered for all properties.- Overrides:
addPropertyChangeListener
in classAccessibleContext
- Parameters:
l
- The PropertyChangeListener to be added- See Also:
-
removePropertyChangeListener
Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.- Overrides:
removePropertyChangeListener
in classAccessibleContext
- Parameters:
l
- The PropertyChangeListener to be removed
-
getAccessibleAction
Get the AccessibleAction associated with this object. In the implementation of the Java Accessibility API for this class, return this object, which is responsible for implementing the AccessibleAction interface on behalf of itself.- Overrides:
getAccessibleAction
in classAccessibleContext
- Returns:
- this object
- See Also:
-
getAccessibleComponent
Get the AccessibleComponent associated with this object. In the implementation of the Java Accessibility API for this class, return this object, which is responsible for implementing the AccessibleComponent interface on behalf of itself.- Overrides:
getAccessibleComponent
in classAccessibleContext
- Returns:
- this object
- See Also:
-
getAccessibleSelection
Get the AccessibleSelection associated with this object if one exists. Otherwise return null.- Overrides:
getAccessibleSelection
in classAccessibleContext
- Returns:
- the AccessibleSelection, or null
- See Also:
-
getAccessibleText
Get the AccessibleText associated with this object if one exists. Otherwise return null.- Overrides:
getAccessibleText
in classAccessibleContext
- Returns:
- the AccessibleText, or null
- See Also:
-
getAccessibleValue
Get the AccessibleValue associated with this object if one exists. Otherwise return null.- Overrides:
getAccessibleValue
in classAccessibleContext
- Returns:
- the AccessibleValue, or null
- See Also:
-
getBackground
Get the background color of this object.- Specified by:
getBackground
in interfaceAccessibleComponent
- Returns:
- the background color, if supported, of the object; otherwise, null
- See Also:
-
setBackground
Set the background color of this object.- Specified by:
setBackground
in interfaceAccessibleComponent
- Parameters:
c
- the new Color for the background- See Also:
-
getForeground
Get the foreground color of this object.- Specified by:
getForeground
in interfaceAccessibleComponent
- Returns:
- the foreground color, if supported, of the object; otherwise, null
- See Also:
-
setForeground
Description copied from interface:AccessibleComponent
Sets the foreground color of this object.- Specified by:
setForeground
in interfaceAccessibleComponent
- Parameters:
c
- the new color for the foreground- See Also:
-
getCursor
Description copied from interface:AccessibleComponent
Gets the cursor of this object.- Specified by:
getCursor
in interfaceAccessibleComponent
- Returns:
- the cursor, if supported, of the object; otherwise,
null
- See Also:
-
setCursor
Description copied from interface:AccessibleComponent
Sets the cursor of this object.- Specified by:
setCursor
in interfaceAccessibleComponent
- Parameters:
c
- the new cursor for the object- See Also:
-
getFont
Description copied from interface:AccessibleComponent
Gets the font of this object.- Specified by:
getFont
in interfaceAccessibleComponent
- Returns:
- the font, if supported, for the object; otherwise,
null
- See Also:
-
setFont
Description copied from interface:AccessibleComponent
Sets the font of this object.- Specified by:
setFont
in interfaceAccessibleComponent
- Parameters:
f
- the new font for the object- See Also:
-
getFontMetrics
Description copied from interface:AccessibleComponent
Gets theFontMetrics
of this object.- Specified by:
getFontMetrics
in interfaceAccessibleComponent
- Parameters:
f
- the font for which font metrics is to be obtained- Returns:
- the
FontMetrics
, if supported, the object; otherwise,null
- See Also:
-
isEnabled
public boolean isEnabled()Description copied from interface:AccessibleComponent
Determines if the object is enabled. Objects that are enabled will also have theAccessibleState.ENABLED
state set in theirAccessibleStateSets
.- Specified by:
isEnabled
in interfaceAccessibleComponent
- Returns:
true
if object is enabled; otherwise,false
- See Also:
-
setEnabled
public void setEnabled(boolean b) Description copied from interface:AccessibleComponent
Sets the enabled state of the object.- Specified by:
setEnabled
in interfaceAccessibleComponent
- Parameters:
b
- iftrue
, enables this object; otherwise, disables it- See Also:
-
isVisible
public boolean isVisible()Description copied from interface:AccessibleComponent
Determines if the object is visible. Note: this means that the object intends to be visible; however, it may not be showing on the screen because one of the objects that this object is contained by is currently not visible. To determine if an object is showing on the screen, useAccessibleComponent.isShowing()
Objects that are visible will also have the
AccessibleState.VISIBLE
state set in theirAccessibleStateSets
.- Specified by:
isVisible
in interfaceAccessibleComponent
- Returns:
true
if object is visible; otherwise,false
- See Also:
-
setVisible
public void setVisible(boolean b) Description copied from interface:AccessibleComponent
Sets the visible state of the object.- Specified by:
setVisible
in interfaceAccessibleComponent
- Parameters:
b
- iftrue
, shows this object; otherwise, hides it- See Also:
-
isShowing
public boolean isShowing()Description copied from interface:AccessibleComponent
Determines if the object is showing. This is determined by checking the visibility of the object and its ancestors. Note: this will returntrue
even if the object is obscured by another (for example, it is underneath a menu that was pulled down).- Specified by:
isShowing
in interfaceAccessibleComponent
- Returns:
true
if object is showing; otherwise,false
-
contains
Description copied from interface:AccessibleComponent
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.- Specified by:
contains
in interfaceAccessibleComponent
- Parameters:
p
- the point relative to the coordinate system of the object- Returns:
true
if object contains point; otherwisefalse
- See Also:
-
getLocationOnScreen
Description copied from interface:AccessibleComponent
Returns the location of the object on the screen.- Specified by:
getLocationOnScreen
in interfaceAccessibleComponent
- Returns:
- the location of the object on screen;
null
if this object is not on the screen - See Also:
-
getLocationInJTree
Returns the relative location of the node- Returns:
- the relative location of the node
-
getLocation
Description copied from interface:AccessibleComponent
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.- Specified by:
getLocation
in interfaceAccessibleComponent
- Returns:
- An instance of
Point
representing the top-left corner of the object's bounds in the coordinate space of the screen;null
if this object or its parent are not on the screen - See Also:
-
setLocation
Description copied from interface:AccessibleComponent
Sets the location of the object relative to the parent.- Specified by:
setLocation
in interfaceAccessibleComponent
- Parameters:
p
- the new position for the top-left corner- See Also:
-
getBounds
Description copied from interface:AccessibleComponent
Gets the bounds of this object in the form of aRectangle
object. The bounds specify this object's width, height, and location relative to its parent.- Specified by:
getBounds
in interfaceAccessibleComponent
- Returns:
- A rectangle indicating this component's bounds;
null
if this object is not on the screen. - See Also:
-
setBounds
Description copied from interface:AccessibleComponent
Sets the bounds of this object in the form of aRectangle
object. The bounds specify this object's width, height, and location relative to its parent.- Specified by:
setBounds
in interfaceAccessibleComponent
- Parameters:
r
- rectangle indicating this component's bounds- See Also:
-
getSize
Description copied from interface:AccessibleComponent
Returns the size of this object in the form of aDimension
object. Theheight
field of theDimension
object contains this object's height, and thewidth
field of theDimension
object contains this object's width.- Specified by:
getSize
in interfaceAccessibleComponent
- Returns:
- A
Dimension
object that indicates the size of this component;null
if this object is not on the screen - See Also:
-
setSize
Description copied from interface:AccessibleComponent
Resizes this object so that it has width and height.- Specified by:
setSize
in interfaceAccessibleComponent
- Parameters:
d
- The dimension specifying the new size of the object- See Also:
-
getAccessibleAt
Returns theAccessible
child, if one exists, contained at the local coordinatePoint
. Otherwise returnsnull
.- Specified by:
getAccessibleAt
in interfaceAccessibleComponent
- Parameters:
p
- point in local coordinates of thisAccessible
- Returns:
- the
Accessible
, if it exists, at the specified location; elsenull
-
isFocusTraversable
public boolean isFocusTraversable()Description copied from interface:AccessibleComponent
Returns whether this object can accept focus or not. Objects that can accept focus will also have theAccessibleState.FOCUSABLE
state set in theirAccessibleStateSets
.- Specified by:
isFocusTraversable
in interfaceAccessibleComponent
- Returns:
true
if object can accept focus; otherwisefalse
- See Also:
-
requestFocus
public void requestFocus()Description copied from interface:AccessibleComponent
Requests focus for this object. If this object cannot accept focus, nothing will happen. Otherwise, the object will attempt to take focus.- Specified by:
requestFocus
in interfaceAccessibleComponent
- See Also:
-
addFocusListener
Description copied from interface:AccessibleComponent
Adds the specified focus listener to receive focus events from this component.- Specified by:
addFocusListener
in interfaceAccessibleComponent
- Parameters:
l
- the focus listener- See Also:
-
removeFocusListener
Description copied from interface:AccessibleComponent
Removes the specified focus listener so it no longer receives focus events from this component.- Specified by:
removeFocusListener
in interfaceAccessibleComponent
- Parameters:
l
- the focus listener- See Also:
-
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 interfaceAccessibleSelection
- Returns:
- the number of items currently selected.
-
getAccessibleSelection
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 interfaceAccessibleSelection
- Parameters:
i
- the zero-based index of selected items- Returns:
- an Accessible containing the selected item
- See Also:
-
isAccessibleChildSelected
public boolean isAccessibleChildSelected(int i) Returns true if the current child of this object is selected.- Specified by:
isAccessibleChildSelected
in interfaceAccessibleSelection
- 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:
-
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 interfaceAccessibleSelection
- Parameters:
i
- the zero-based index of selectable items- See Also:
-
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 interfaceAccessibleSelection
- Parameters:
i
- the zero-based index of selectable items- See Also:
-
clearAccessibleSelection
public void clearAccessibleSelection()Clears the selection in the object, so that nothing in the object is selected.- Specified by:
clearAccessibleSelection
in interfaceAccessibleSelection
-
selectAllAccessibleSelection
public void selectAllAccessibleSelection()Causes every selected item in the object to be selected if the object supports multiple selections.- Specified by:
selectAllAccessibleSelection
in interfaceAccessibleSelection
-
getAccessibleActionCount
public int getAccessibleActionCount()Returns the number of accessible actions available in this tree node. If this node is not a leaf, there is at least one action (toggle expand), in addition to any available on the object behind the TreeCellRenderer.- Specified by:
getAccessibleActionCount
in interfaceAccessibleAction
- Returns:
- the number of Actions in this object
-
getAccessibleActionDescription
Return a description of the specified action of the tree node. If this node is not a leaf, there is at least one action description (toggle expand), in addition to any available on the object behind the TreeCellRenderer.- Specified by:
getAccessibleActionDescription
in interfaceAccessibleAction
- Parameters:
i
- zero-based index of the actions- Returns:
- a description of the action
- See Also:
-
doAccessibleAction
public boolean doAccessibleAction(int i) Perform the specified Action on the tree node. If this node is not a leaf, there is at least one action which can be done (toggle expand), in addition to any available on the object behind the TreeCellRenderer.- Specified by:
doAccessibleAction
in interfaceAccessibleAction
- Parameters:
i
- zero-based index of actions- Returns:
- true if the action was performed; else false.
- See Also:
-