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.AccessibleJTreeNode

java.lang.Object extended by javax.accessibility.AccessibleContext extended by 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.


Field Summary
 
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

          Constructs an AccessibleJTreeNode
 
Method Summary
 void

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

          
 void

          Add a PropertyChangeListener to the listener list.
 void

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

          
 boolean

          Perform the specified Action on the tree node.
 AccessibleAction

          Get the AccessibleAction associated with this object.
 int

          Returns the number of accessible actions available in this tree node.
 String

          Return a description of the specified action of the tree node.
 Accessible

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

          Return the specified Accessible child of the object.
 int

          Returns the number of accessible children in the object.
 AccessibleComponent

          Get the AccessibleComponent associated with this object.
 AccessibleContext

          Get the AccessibleContext associated with this tree node.
 String

          Get the accessible description of this object.
 int

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

          Get the accessible name of this object.
 Accessible

          Get the Accessible parent of this object.
 AccessibleRole

          Get the role of this object.
 AccessibleSelection

          Get the AccessibleSelection associated with this object if one exists.
 Accessible

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

          Returns the number of items currently selected.
 AccessibleStateSet

          Get the state set of this object.
 AccessibleText

          Get the AccessibleText associated with this object if one exists.
 AccessibleValue

          Get the AccessibleValue associated with this object if one exists.
 Color

          Get the background color of this object.
 Rectangle

          
 Cursor

          
 Font

          
 FontMetrics

          
 Color

          Get the foreground color of this object.
 Locale

          Gets the locale of the component.
 Point

          
protected Point

          
 Point

          
 Dimension

          
 boolean

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

          
 boolean

          
 boolean

          
 boolean

          
 void

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

          
 void

          Remove a PropertyChangeListener from the listener list.
 void

          
 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

          
 void

          
 void
setEnabled(boolean b)

          
 void

          
 void

          
 void

          
 void

          
 void
setVisible(boolean b)

          
 
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.AccessibleJTreeNode

public JTree.AccessibleJTree.AccessibleJTreeNode(JTree t,
                                                 TreePath p,
                                                 Accessible ap)
Constructs an AccessibleJTreeNode

Parameters:
t
p
ap
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

addFocusListener

public void addFocusListener(FocusListener l)
Parameters:
l

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)
Add a PropertyChangeListener to the listener list. The listener is registered for all properties.

Overrides:
addPropertyChangeListener in class AccessibleContext
Parameters:
l - The PropertyChangeListener to be added

clearAccessibleSelection

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


contains

public boolean contains(Point p)
Parameters:
p

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.

Parameters:
i - zero-based index of actions
Returns:
true if the the action was performed; else false.

getAccessibleAction

public AccessibleAction 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 class AccessibleContext
Returns:
this object

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.

Returns:
the number of Actions in this object

getAccessibleActionDescription

public String getAccessibleActionDescription(int i)
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.

Parameters:
i - zero-based index of the actions
Returns:
a description of the action

getAccessibleAt

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

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 specified Accessible child of the object.

Overrides:
getAccessibleChild in class AccessibleContext
Parameters:
i - zero-based index of child
Returns:
the Accessible child of the object

getAccessibleChildrenCount

public int getAccessibleChildrenCount()
Returns the number of accessible children in the object.

Overrides:
getAccessibleChildrenCount in class AccessibleContext
Returns:
the number of accessible children in the object.

getAccessibleComponent

public AccessibleComponent 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 class AccessibleContext
Returns:
this object

getAccessibleContext

public AccessibleContext 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.

Returns:
this object

getAccessibleDescription

public String getAccessibleDescription()
Get the accessible description of this object.

Overrides:
getAccessibleDescription in class AccessibleContext
Returns:
the localized description of the object; null if this object does not have a description

getAccessibleIndexInParent

public int getAccessibleIndexInParent()
Get the index of this object in its accessible parent.

Overrides:
getAccessibleIndexInParent in class AccessibleContext
Returns:
the index of this object in its parent; -1 if this object does not have an accessible parent.

getAccessibleName

public String getAccessibleName()
Get the accessible name of this object.

Overrides:
getAccessibleName in class AccessibleContext
Returns:
the localized name of the object; null if this object does not have a name

getAccessibleParent

public Accessible getAccessibleParent()
Get the Accessible parent of this object.

Overrides:
getAccessibleParent in class AccessibleContext
Returns:
the Accessible parent of this object; null if this object does not have an Accessible parent

getAccessibleRole

public AccessibleRole getAccessibleRole()
Get the role of this object.

Overrides:
getAccessibleRole in class AccessibleContext
Returns:
an instance of AccessibleRole describing the role of the object

getAccessibleSelection

public AccessibleSelection getAccessibleSelection()
Get the AccessibleSelection associated with this object if one exists. Otherwise return null.

Overrides:
getAccessibleSelection in class AccessibleContext
Returns:
the AccessibleSelection, or null

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.

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()
Get the state set of this object.

Overrides:
getAccessibleStateSet in class AccessibleContext
Returns:
an instance of AccessibleStateSet containing the current state set of the object

getAccessibleText

public AccessibleText getAccessibleText()
Get the AccessibleText associated with this object if one exists. Otherwise return null.

Overrides:
getAccessibleText in class AccessibleContext
Returns:
the AccessibleText, or null

getAccessibleValue

public AccessibleValue getAccessibleValue()
Get the AccessibleValue associated with this object if one exists. Otherwise return null.

Overrides:
getAccessibleValue in class AccessibleContext
Returns:
the AccessibleValue, or null

getBackground

public Color getBackground()
Get the background color of this object.

Returns:
the background color, if supported, of the object; otherwise, null

getBounds

public Rectangle getBounds()

getCursor

public Cursor getCursor()

getFont

public Font getFont()

getFontMetrics

public FontMetrics getFontMetrics(Font f)
Parameters:
f

getForeground

public Color getForeground()
Get the foreground color of this object.

Returns:
the foreground color, if supported, of the object; otherwise, null

getLocale

public Locale getLocale()
Gets the locale of the component. If the component does not have a locale, then the locale of its parent is returned.

Overrides:
getLocale in class AccessibleContext
Returns:
This component's locale. If this component does not have a locale, the locale of its parent is returned.

getLocation

public Point getLocation()

getLocationInJTree

protected Point getLocationInJTree()

getLocationOnScreen

public Point getLocationOnScreen()

getSize

public Dimension getSize()

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.

isEnabled

public boolean isEnabled()

isFocusTraversable

public boolean isFocusTraversable()

isShowing

public boolean isShowing()

isVisible

public boolean isVisible()

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

removeFocusListener

public void removeFocusListener(FocusListener l)
Parameters:
l

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)
Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.

Overrides:
removePropertyChangeListener in class AccessibleContext
Parameters:
l - The PropertyChangeListener to be removed

requestFocus

public void requestFocus()

selectAllAccessibleSelection

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


setAccessibleDescription

public void setAccessibleDescription(String s)
Set the accessible description of this object.

Overrides:
setAccessibleDescription in class AccessibleContext
Parameters:
s - the new localized description of the object

setAccessibleName

public void setAccessibleName(String s)
Set the localized accessible name of this object.

Overrides:
setAccessibleName in class AccessibleContext
Parameters:
s - the new localized name of the object.

setBackground

public void setBackground(Color c)
Set the background color of this object.

Parameters:
c - the new Color for the background

setBounds

public void setBounds(Rectangle r)
Parameters:
r

setCursor

public void setCursor(Cursor c)
Parameters:
c

setEnabled

public void setEnabled(boolean b)
Parameters:
b

setFont

public void setFont(Font f)
Parameters:
f

setForeground

public void setForeground(Color c)
Parameters:
c

setLocation

public void setLocation(Point p)
Parameters:
p

setSize

public void setSize(Dimension d)
Parameters:
d

setVisible

public void setVisible(boolean b)
Parameters:
b


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/.