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.text
class JTextComponent.AccessibleJTextComponent

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.text.JTextComponent.AccessibleJTextComponent
All Implemented Interfaces:
Serializable, AccessibleAction, AccessibleComponent, AccessibleEditableText, AccessibleExtendedComponent, AccessibleExtendedText, AccessibleText, CaretListener, DocumentListener
Direct Known Subclasses:
JEditorPane.AccessibleJEditorPane, JTextArea.AccessibleJTextArea, JTextField.AccessibleJTextField
Enclosing class:
JTextComponent

public class JTextComponent.AccessibleJTextComponent
extends JComponent.AccessibleJComponent
implements AccessibleText, CaretListener, DocumentListener, AccessibleAction, AccessibleEditableText, AccessibleExtendedText

This class implements accessibility support for the JTextComponent class. It provides an implementation of the Java Accessibility API appropriate to menu 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
 
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

          Constructs an AccessibleJTextComponent.
 
Method Summary
 void

          Handles caret updates (fire appropriate property change event, which are AccessibleContext.ACCESSIBLE_CARET_PROPERTY and AccessibleContext.ACCESSIBLE_SELECTION_PROPERTY).
 void

          Handles document remove (fire appropriate property change event, which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY).
 void
cut(int startIndex, int endIndex)

          Cuts the text between two indices into the system clipboard.
 void
delete(int startIndex, int endIndex)

          Deletes the text between two indices
 boolean

          Performs the specified Action on the object
 AccessibleAction

          Gets the AccessibleAction associated with this object that supports one or more actions.
 int

          Returns the number of accessible actions available in this object If there are more than one, the first one is considered the "default" action of the object.
 String

          Returns a description of the specified action of the object.
 AccessibleEditableText

          Returns the AccessibleEditableText interface for this text component.
 AccessibleRole

          Gets the role of this object.
 AccessibleStateSet

          Gets the state set of the JTextComponent.
 AccessibleText

          Get the AccessibleText associated with this object.
 String
getAfterIndex(int part, int index)

          Returns the String after a given index.
 String
getAtIndex(int part, int index)

          Returns the String at a given index.
 String
getBeforeIndex(int part, int index)

          Returns the String before a given index.
 int

          Returns the zero-based offset of the caret.
 AttributeSet

          Returns the AttributeSet for a given character (at a given index).
 Rectangle

          Determines the bounding box of the character at the given index into the string.
 int

          Returns the number of characters (valid indices)
 int

          Given a point in local coordinates, return the zero-based index of the character under that Point.
 String

          Returns the portion of the text that is selected.
 int

          Returns the end offset within the selected text.
 int

          Returns the start offset within the selected text.
 Rectangle
getTextBounds(int startIndex, int endIndex)

          Returns the Rectangle enclosing the text between two indicies.
 String
getTextRange(int startIndex, int endIndex)

          Returns the text string between two indices.
 AccessibleTextSequence
getTextSequenceAfter(int part, int index)

          Returns the AccessibleTextSequence after a given index.
 AccessibleTextSequence
getTextSequenceAt(int part, int index)

          Returns the AccessibleTextSequence at a given index.
 AccessibleTextSequence
getTextSequenceBefore(int part, int index)

          Returns the AccessibleTextSequence before a given index.
 void
insertTextAtIndex(int index, String s)

          Inserts the specified string at the given index
 void

          Handles document insert (fire appropriate property change event which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY).
 void
paste(int startIndex)

          Pastes the text from the system clipboard into the text starting at the specified index.
 void

          Handles document remove (fire appropriate property change event, which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY).
 void
replaceText(int startIndex, int endIndex, String s)

          Replaces the text between two indices with the specified string.
 void
selectText(int startIndex, int endIndex)

          Selects the text between two indices.
 void
setAttributes(int startIndex, int endIndex, AttributeSet as)

          Sets attributes for the text between two indices.
 void

          Sets the text contents to the specified string.
 
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

JTextComponent.AccessibleJTextComponent

public JTextComponent.AccessibleJTextComponent()
Constructs an AccessibleJTextComponent. Adds a listener to track caret change.

Method Detail

caretUpdate

public void caretUpdate(CaretEvent e)
Handles caret updates (fire appropriate property change event, which are AccessibleContext.ACCESSIBLE_CARET_PROPERTY and AccessibleContext.ACCESSIBLE_SELECTION_PROPERTY). This keeps track of the dot position internally. When the caret moves, the internal position is updated after firing the event.

Parameters:
e - the CaretEvent

changedUpdate

public void changedUpdate(DocumentEvent e)
Handles document remove (fire appropriate property change event, which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY). This tracks the changed offset via the event.

Parameters:
e - the DocumentEvent

cut

public void cut(int startIndex,
                int endIndex)
Cuts the text between two indices into the system clipboard.

Parameters:
startIndex - the starting index in the text
endIndex - the ending index in the text

delete

public void delete(int startIndex,
                   int endIndex)
Deletes the text between two indices

Parameters:
startIndex - the starting index in the text
endIndex - the ending index in the text

doAccessibleAction

public boolean doAccessibleAction(int i)
Performs the specified Action on the object

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

getAccessibleAction

public AccessibleAction getAccessibleAction()
Overrides:
getAccessibleAction in class AccessibleContext

getAccessibleActionCount

public int getAccessibleActionCount()
Returns the number of accessible actions available in this object If there are more than one, the first one is considered the "default" action of the object.

Returns:
the zero-based number of Actions in this object

getAccessibleActionDescription

public String getAccessibleActionDescription(int i)
Returns a description of the specified action of the object.

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

getAccessibleEditableText

public AccessibleEditableText getAccessibleEditableText()
Returns the AccessibleEditableText interface for this text component.

Overrides:
getAccessibleEditableText in class AccessibleContext
Returns:
the AccessibleEditableText interface

getAccessibleRole

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

Overrides:
getAccessibleRole in class JComponent.AccessibleJComponent
Returns:
an instance of AccessibleRole describing the role of the object (AccessibleRole.TEXT)

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()
Gets the state set of the JTextComponent. The AccessibleStateSet of an object is composed of a set of unique AccessibleState's. A change in the AccessibleStateSet of an object will cause a PropertyChangeEvent to be fired for the AccessibleContext.ACCESSIBLE_STATE_PROPERTY property.

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

getAccessibleText

public AccessibleText getAccessibleText()
Get the AccessibleText associated with this object. In the implementation of the Java Accessibility API for this class, return this object, which is responsible for implementing the AccessibleText interface on behalf of itself.

Overrides:
getAccessibleText in class AccessibleContext
Returns:
this object

getAfterIndex

public String getAfterIndex(int part,
                            int index)
Returns the String after a given index. Whitespace between words is treated as a word.

Parameters:
part - the CHARACTER, WORD, or SENTENCE to retrieve
index - an index within the text
Returns:
the letter, word, or sentence.

getAtIndex

public String getAtIndex(int part,
                         int index)
Returns the String at a given index. Whitespace between words is treated as a word.

Parameters:
part - the CHARACTER, WORD, or SENTENCE to retrieve
index - an index within the text
Returns:
the letter, word, or sentence.

getBeforeIndex

public String getBeforeIndex(int part,
                             int index)
Returns the String before a given index. Whitespace between words is treated a word.

Parameters:
part - the CHARACTER, WORD, or SENTENCE to retrieve
index - an index within the text
Returns:
the letter, word, or sentence.

getCaretPosition

public int getCaretPosition()
Returns the zero-based offset of the caret. Note: The character to the right of the caret will have the same index value as the offset (the caret is between two characters).

Returns:
the zero-based offset of the caret.

getCharacterAttribute

public AttributeSet getCharacterAttribute(int i)
Returns the AttributeSet for a given character (at a given index).

Parameters:
i - the zero-based index into the text
Returns:
the AttributeSet of the character

getCharacterBounds

public Rectangle getCharacterBounds(int i)
Determines the bounding box of the character at the given index into the string. The bounds are returned in local coordinates. If the index is invalid a null rectangle is returned. The screen coordinates returned are "unscrolled coordinates" if the JTextComponent is contained in a JScrollPane in which case the resulting rectangle should be composed with the parent coordinates. A good algorithm to use is: Accessible a: AccessibleText at = a.getAccessibleText(); AccessibleComponent ac = a.getAccessibleComponent(); Rectangle r = at.getCharacterBounds(); Point p = ac.getLocation(); r.x += p.x; r.y += p.y; Note: the JTextComponent must have a valid size (e.g. have been added to a parent container whose ancestor container is a valid top-level window) for this method to be able to return a meaningful (non-null) value.

Parameters:
i - the index into the String >= 0
Returns:
the screen coordinates of the character's bounding box

getCharCount

public int getCharCount()
Returns the number of characters (valid indices)

Returns:
the number of characters >= 0

getIndexAtPoint

public int getIndexAtPoint(Point p)
Given a point in local coordinates, return the zero-based index of the character under that Point. If the point is invalid, this method returns -1.

Parameters:
p - the Point in local coordinates
Returns:
the zero-based index of the character under Point p.

getSelectedText

public String getSelectedText()
Returns the portion of the text that is selected.

Returns:
the text, null if no selection

getSelectionEnd

public int getSelectionEnd()
Returns the end offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same. Return 0 if the text is empty, or the caret position if no selection.

Returns:
the index into teh text of the end of the selection >= 0

getSelectionStart

public int getSelectionStart()
Returns the start offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same. Return 0 if the text is empty, or the caret position if no selection.

Returns:
the index into the text of the start of the selection >= 0

getTextBounds

public Rectangle getTextBounds(int startIndex,
                               int endIndex)
Returns the Rectangle enclosing the text between two indicies.

Parameters:
startIndex - the start index in the text
endIndex - the end index in the text
Returns:
the bounding rectangle of the text if the indices are valid. Otherwise, null is returned

getTextRange

public String getTextRange(int startIndex,
                           int endIndex)
Returns the text string between two indices.

Parameters:
startIndex - the starting index in the text
endIndex - the ending index in the text
Returns:
the text string between the indices

getTextSequenceAfter

public AccessibleTextSequence getTextSequenceAfter(int part,
                                                   int index)
Returns the AccessibleTextSequence after a given index.

Parameters:
part - the CHARACTER, WORD, SENTENCE, LINE or ATTRIBUTE_RUN to retrieve
index - an index within the text
Returns:
an AccessibleTextSequence specifying the text if part and index are valid. Otherwise, null is returned

getTextSequenceAt

public AccessibleTextSequence getTextSequenceAt(int part,
                                                int index)
Returns the AccessibleTextSequence at a given index.

Parameters:
part - the CHARACTER, WORD, SENTENCE, LINE or ATTRIBUTE_RUN to retrieve
index - an index within the text
Returns:
an AccessibleTextSequence specifying the text if part and index are valid. Otherwise, null is returned

getTextSequenceBefore

public AccessibleTextSequence getTextSequenceBefore(int part,
                                                    int index)
Returns the AccessibleTextSequence before a given index.

Parameters:
part - the CHARACTER, WORD, SENTENCE, LINE or ATTRIBUTE_RUN to retrieve
index - an index within the text
Returns:
an AccessibleTextSequence specifying the text if part and index are valid. Otherwise, null is returned

insertTextAtIndex

public void insertTextAtIndex(int index,
                              String s)
Inserts the specified string at the given index

Parameters:
index - the index in the text where the string will be inserted
s - the string to insert in the text

insertUpdate

public void insertUpdate(DocumentEvent e)
Handles document insert (fire appropriate property change event which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY). This tracks the changed offset via the event.

Parameters:
e - the DocumentEvent

paste

public void paste(int startIndex)
Pastes the text from the system clipboard into the text starting at the specified index.

Parameters:
startIndex - the starting index in the text

removeUpdate

public void removeUpdate(DocumentEvent e)
Handles document remove (fire appropriate property change event, which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY). This tracks the changed offset via the event.

Parameters:
e - the DocumentEvent

replaceText

public void replaceText(int startIndex,
                        int endIndex,
                        String s)
Replaces the text between two indices with the specified string.

Parameters:
startIndex - the starting index in the text
endIndex - the ending index in the text
s - the string to replace the text between two indices

selectText

public void selectText(int startIndex,
                       int endIndex)
Selects the text between two indices.

Parameters:
startIndex - the starting index in the text
endIndex - the ending index in the text

setAttributes

public void setAttributes(int startIndex,
                          int endIndex,
                          AttributeSet as)
Sets attributes for the text between two indices.

Parameters:
startIndex - the starting index in the text
endIndex - the ending index in the text
as - the attribute set

setTextContents

public void setTextContents(String s)
Sets the text contents to the specified string.

Parameters:
s - the string to set the text contents


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