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 JComponent.AccessibleJComponent
- All Implemented Interfaces:
- Serializable, AccessibleComponent, AccessibleExtendedComponent
- Direct Known Subclasses:
- AbstractButton.AccessibleAbstractButton, JColorChooser.AccessibleJColorChooser, JComboBox.AccessibleJComboBox, JDesktopPane.AccessibleJDesktopPane, JFileChooser.AccessibleJFileChooser, JInternalFrame.AccessibleJInternalFrame, JInternalFrame.JDesktopIcon.AccessibleJDesktopIcon, JLabel.AccessibleJLabel, JLayeredPane.AccessibleJLayeredPane, JList.AccessibleJList, JMenuBar.AccessibleJMenuBar, JOptionPane.AccessibleJOptionPane, JPanel.AccessibleJPanel, JPopupMenu.AccessibleJPopupMenu, JProgressBar.AccessibleJProgressBar, JRootPane.AccessibleJRootPane, JScrollBar.AccessibleJScrollBar, JScrollPane.AccessibleJScrollPane, JSeparator.AccessibleJSeparator, JSlider.AccessibleJSlider, JSpinner.AccessibleJSpinner, JSplitPane.AccessibleJSplitPane, JTabbedPane.AccessibleJTabbedPane, JTable.AccessibleJTable, JTableHeader.AccessibleJTableHeader, JTextComponent.AccessibleJTextComponent, JToolBar.AccessibleJToolBar, JToolTip.AccessibleJToolTip, JTree.AccessibleJTree, JViewport.AccessibleJViewport
- Enclosing class:
- JComponent
public abstract class JComponent.AccessibleJComponent
extends Container.AccessibleAWTContainer
implements AccessibleExtendedComponent
Inner class of JComponent used to provide default support for
accessibility. This class is not meant to be used directly by
application developers, but is instead meant only to be
subclassed by component developers.
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 |
Fire PropertyChange listener, if one is registered,
when children added/removed. |
protected class |
Fire PropertyChange listener, if one is registered,
when focus events happen |
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 |
protected |
Though the class is abstract, this should be called by
all sub-classes.
|
Method Summary |
void |
Adds a PropertyChangeListener to the listener list.
|
Accessible |
Returns the nth Accessible child of the object.
|
int |
Returns the number of accessible children in the object.
|
String |
Gets the accessible description of this object.
|
AccessibleKeyBinding |
Returns key bindings associated with this object
|
String |
Gets the accessible name of this object.
|
AccessibleRole |
Gets the role of this object.
|
AccessibleStateSet |
Gets the state of this object.
|
protected String |
Recursively search through the border hierarchy (if it exists)
for a TitledBorder with a non-null title.
|
String |
Returns the titled border text
|
String |
Returns the tool tip text
|
void |
Removes a PropertyChangeListener from the listener list.
|
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 |
accessibleContainerHandler
protected ContainerListener accessibleContainerHandler
-
accessibleFocusHandler
protected FocusListener accessibleFocusHandler
-
JComponent.AccessibleJComponent
protected JComponent.AccessibleJComponent()
-
Though the class is abstract, this should be called by
all sub-classes.
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
-
Adds a PropertyChangeListener to the listener list.
- Overrides:
addPropertyChangeListener
in class Container.AccessibleAWTContainer
- Parameters:
listener
- the PropertyChangeListener to be added
getAccessibleChild
public Accessible getAccessibleChild(int i)
-
Returns the nth Accessible child of the object.
- Overrides:
getAccessibleChild
in class Container.AccessibleAWTContainer
- Parameters:
i
- zero-based index of child
- Returns:
- the nth Accessible child of the object
getAccessibleChildrenCount
public int getAccessibleChildrenCount()
-
Returns the number of accessible children in the object. If all
of the children of this object implement Accessible, than this
method should return the number of children of this object.
- Overrides:
getAccessibleChildrenCount
in class Container.AccessibleAWTContainer
- Returns:
- the number of accessible children in the object.
getAccessibleDescription
public String getAccessibleDescription()
-
Gets the accessible description of this object. This should be
a concise, localized description of what this object is - what
is its meaning to the user. If the object has a tooltip, the
tooltip text may be an appropriate string to return, assuming
it contains a concise description of the object (instead of just
the name of the object - for example a "Save" icon on a toolbar that
had "save" as the tooltip text shouldn't return the tooltip
text as the description, but something like "Saves the current
text document" instead).
- Overrides:
getAccessibleDescription
in class Component.AccessibleAWTComponent
- Returns:
- the localized description of the object -- can be null if
this object does not have a description
getAccessibleKeyBinding
public AccessibleKeyBinding getAccessibleKeyBinding()
-
Returns key bindings associated with this object
- Returns:
- the key bindings, if supported, of the object;
otherwise, null
getAccessibleName
public String getAccessibleName()
-
Gets the accessible name of this object. This should almost never
return java.awt.Component.getName(), as that generally isn't
a localized name, and doesn't have meaning for the user. If the
object is fundamentally a text object (such as a menu item), the
accessible name should be the text of the object (for example,
"save").
If the object has a tooltip, the tooltip text may also be an
appropriate String to return.
- Overrides:
getAccessibleName
in class Component.AccessibleAWTComponent
- Returns:
- the localized name of the object -- can be null if this
object does not have a name
getAccessibleRole
public AccessibleRole getAccessibleRole()
-
Gets the role of this object.
- Overrides:
getAccessibleRole
in class Component.AccessibleAWTComponent
- Returns:
- an instance of AccessibleRole describing the role of the
object
getAccessibleStateSet
public AccessibleStateSet getAccessibleStateSet()
-
Gets the state of this object.
- Overrides:
getAccessibleStateSet
in class Component.AccessibleAWTComponent
- Returns:
- an instance of AccessibleStateSet containing the current
state set of the object
getBorderTitle
protected String getBorderTitle(Border b)
-
Recursively search through the border hierarchy (if it exists)
for a TitledBorder with a non-null title. This does a depth
first search on first the inside borders then the outside borders.
The assumption is that titles make really pretty inside borders
but not very pretty outside borders in compound border situations.
It's rather arbitrary, but hopefully decent UI programmers will
not create multiple titled borders for the same component.
- Parameters:
b
getTitledBorderText
public String getTitledBorderText()
-
Returns the titled border text
- Returns:
- the titled border text, if supported, of the object;
otherwise, null
getToolTipText
public String getToolTipText()
-
Returns the tool tip text
- Returns:
- the tool tip text, if supported, of the object;
otherwise, null
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
-
Removes a PropertyChangeListener from the listener list.
This removes a PropertyChangeListener that was registered
for all properties.
- Overrides:
removePropertyChangeListener
in class Component.AccessibleAWTComponent
- Parameters:
listener
- the PropertyChangeListener to be removed
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:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.