public class

JTextComponent.AccessibleJTextComponent

extends JComponent.AccessibleJComponent
implements AccessibleAction AccessibleEditableText AccessibleExtendedText AccessibleText CaretListener DocumentListener

java.lang.Object
↳	javax.accessibility.AccessibleContext
	↳	java.awt.Component.AccessibleAWTComponent
		↳	java.awt.Container.AccessibleAWTContainer
			↳	javax.swing.JComponent.AccessibleJComponent
				↳	javax.swing.text.JTextComponent.AccessibleJTextComponent

Known Direct Subclasses

JEditorPane.AccessibleJEditorPane, JTextArea.AccessibleJTextArea, JTextField.AccessibleJTextField

Known Indirect Subclasses

JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport, JPasswordField.AccessibleJPasswordField

Class Overview

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 JavaBeans^TM has been added to the java.beans package. Please see XMLEncoder.

Summary

[Expand]

Inherited Constants

From class javax.accessibility.AccessibleContext

String	ACCESSIBLE_ACTION_PROPERTY	Constant used to indicate that the supported set of actions has changed.
String	ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY	Constant used to determine when the active descendant of a component has changed.
String	ACCESSIBLE_CARET_PROPERTY	Constant used to determine when the accessibleText caret has changed.
String	ACCESSIBLE_CHILD_PROPERTY	Constant used to determine when Accessible children are added/removed from the object.
String	ACCESSIBLE_COMPONENT_BOUNDS_CHANGED	PropertyChangeEvent which indicates that a change has occurred in a component's bounds.
String	ACCESSIBLE_DESCRIPTION_PROPERTY	Constant used to determine when the accessibleDescription property has changed.
String	ACCESSIBLE_HYPERTEXT_OFFSET	Constant used to indicate that a hypertext element has received focus.
String	ACCESSIBLE_INVALIDATE_CHILDREN	PropertyChangeEvent which indicates that a significant change has occurred to the children of a component like a tree or text.
String	ACCESSIBLE_NAME_PROPERTY	Constant used to determine when the accessibleName property has changed.
String	ACCESSIBLE_SELECTION_PROPERTY	Constant used to determine when the accessibleSelection has changed.
String	ACCESSIBLE_STATE_PROPERTY	Constant used to determine when the accessibleStateSet property has changed.
String	ACCESSIBLE_TABLE_CAPTION_CHANGED	Constant used to indicate that the table caption has changed The old value in the PropertyChangeEvent will be an Accessible representing the previous table caption and the new value will be an Accessible representing the new table caption.
String	ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED	Constant used to indicate that the column description has changed The old value in the PropertyChangeEvent will be null and the new value will be an Integer representing the column index.
String	ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED	Constant used to indicate that the column header has changed The old value in the PropertyChangeEvent will be null and the new value will be an AccessibleTableModelChange representing the header change.
String	ACCESSIBLE_TABLE_MODEL_CHANGED	Constant used to indicate that table data has changed.
String	ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED	Constant used to indicate that the row description has changed The old value in the PropertyChangeEvent will be null and the new value will be an Integer representing the row index.
String	ACCESSIBLE_TABLE_ROW_HEADER_CHANGED	Constant used to indicate that the row header has changed The old value in the PropertyChangeEvent will be null and the new value will be an AccessibleTableModelChange representing the header change.
String	ACCESSIBLE_TABLE_SUMMARY_CHANGED	Constant used to indicate that the table summary has changed The old value in the PropertyChangeEvent will be an Accessible representing the previous table summary and the new value will be an Accessible representing the new table summary.
String	ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED	PropertyChangeEvent which indicates that text attributes have changed.
String	ACCESSIBLE_TEXT_PROPERTY	PropertyChangeEvent which indicates that text has changed.
String	ACCESSIBLE_VALUE_PROPERTY	Constant used to determine when the accessibleValue property has changed.
String	ACCESSIBLE_VISIBLE_DATA_PROPERTY	Constant used to determine when the visual appearance of the object has changed.

From interface javax.accessibility.AccessibleExtendedText

From interface javax.accessibility.AccessibleText

[Expand]

Inherited Fields

From class javax.swing.JComponent.AccessibleJComponent

From class java.awt.Container.AccessibleAWTContainer

From class java.awt.Component.AccessibleAWTComponent

From class javax.accessibility.AccessibleContext

From interface javax.accessibility.AccessibleAction

Public Constructors
	JTextComponent.AccessibleJTextComponent() Constructs an AccessibleJTextComponent.

Public Methods
void	caretUpdate(CaretEvent e) Handles caret updates (fire appropriate property change event, which are AccessibleContext.ACCESSIBLE_CARET_PROPERTY and AccessibleContext.ACCESSIBLE_SELECTION_PROPERTY).
void	changedUpdate(DocumentEvent e) 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	doAccessibleAction(int i) Performs the specified Action on the object
AccessibleAction	getAccessibleAction() Gets the AccessibleAction associated with this object that supports one or more actions.
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.
String	getAccessibleActionDescription(int i) Returns a description of the specified action of the object.
AccessibleEditableText	getAccessibleEditableText() Returns the AccessibleEditableText interface for this text component.
AccessibleRole	getAccessibleRole() Gets the role of this object.
AccessibleStateSet	getAccessibleStateSet() Gets the state set of the JTextComponent.
AccessibleText	getAccessibleText() 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	getCaretPosition() Returns the zero-based offset of the caret.
int	getCharCount() Returns the number of characters (valid indices)
AttributeSet	getCharacterAttribute(int i) Returns the AttributeSet for a given character (at a given index).
Rectangle	getCharacterBounds(int i) Determines the bounding box of the character at the given index into the string.
int	getIndexAtPoint(Point p) Given a point in local coordinates, return the zero-based index of the character under that Point.
String	getSelectedText() Returns the portion of the text that is selected.
int	getSelectionEnd() Returns the end offset within the selected text.
int	getSelectionStart() 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	insertUpdate(DocumentEvent e) 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	removeUpdate(DocumentEvent e) 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	setTextContents(String s) Sets the text contents to the specified string.

[Expand]

Inherited Methods

From class javax.swing.JComponent.AccessibleJComponent

From class java.awt.Container.AccessibleAWTContainer

From class java.awt.Component.AccessibleAWTComponent

From class javax.accessibility.AccessibleContext

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface javax.accessibility.AccessibleAction

From interface javax.accessibility.AccessibleComponent

abstract void	addFocusListener(FocusListener l) Adds the specified focus listener to receive focus events from this component.
abstract boolean	contains(Point p) 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.
abstract Accessible	getAccessibleAt(Point p) Returns the Accessible child, if one exists, contained at the local coordinate Point.
abstract Color	getBackground() Gets the background color of this object.
abstract Rectangle	getBounds() Gets the bounds of this object in the form of a Rectangle object.
abstract Cursor	getCursor() Gets the Cursor of this object.
abstract Font	getFont() Gets the Font of this object.
abstract FontMetrics	getFontMetrics(Font f) Gets the FontMetrics of this object.
abstract Color	getForeground() Gets the foreground color of this object.
abstract Point	getLocation() 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.
abstract Point	getLocationOnScreen() Returns the location of the object on the screen.
abstract Dimension	getSize() Returns the size of this object in the form of a Dimension object.
abstract boolean	isEnabled() Determines if the object is enabled.
abstract boolean	isFocusTraversable() Returns whether this object can accept focus or not.
abstract boolean	isShowing() Determines if the object is showing.
abstract boolean	isVisible() Determines if the object is visible.
abstract void	removeFocusListener(FocusListener l) Removes the specified focus listener so it no longer receives focus events from this component.
abstract void	requestFocus() Requests focus for this object.
abstract void	setBackground(Color c) Sets the background color of this object.
abstract void	setBounds(Rectangle r) Sets the bounds of this object in the form of a Rectangle object.
abstract void	setCursor(Cursor cursor) Sets the Cursor of this object.
abstract void	setEnabled(boolean b) Sets the enabled state of the object.
abstract void	setFont(Font f) Sets the Font of this object.
abstract void	setForeground(Color c) Sets the foreground color of this object.
abstract void	setLocation(Point p) Sets the location of the object relative to the parent.
abstract void	setSize(Dimension d) Resizes this object so that it has width and height.
abstract void	setVisible(boolean b) Sets the visible state of the object.

From interface javax.accessibility.AccessibleEditableText

abstract void	cut(int startIndex, int endIndex) Cuts the text between two indices into the system clipboard.
abstract void	delete(int startIndex, int endIndex) Deletes the text between two indices
abstract String	getTextRange(int startIndex, int endIndex) Returns the text string between two indices.
abstract void	insertTextAtIndex(int index, String s) Inserts the specified string at the given index/
abstract void	paste(int startIndex) Pastes the text from the system clipboard into the text starting at the specified index.
abstract void	replaceText(int startIndex, int endIndex, String s) Replaces the text between two indices with the specified string.
abstract void	selectText(int startIndex, int endIndex) Selects the text between two indices.
abstract void	setAttributes(int startIndex, int endIndex, AttributeSet as) Sets attributes for the text between two indices.
abstract void	setTextContents(String s) Sets the text contents to the specified string.

From interface javax.accessibility.AccessibleExtendedComponent

From interface javax.accessibility.AccessibleExtendedText

From interface javax.accessibility.AccessibleText

abstract String	getAfterIndex(int part, int index) Returns the String after a given index.
abstract String	getAtIndex(int part, int index) Returns the String at a given index.
abstract String	getBeforeIndex(int part, int index) Returns the String before a given index.
abstract int	getCaretPosition() Returns the zero-based offset of the caret.
abstract int	getCharCount() Returns the number of characters (valid indicies)
abstract AttributeSet	getCharacterAttribute(int i) Returns the AttributeSet for a given character at a given index
abstract Rectangle	getCharacterBounds(int i) Determines the bounding box of the character at the given index into the string.
abstract int	getIndexAtPoint(Point p) Given a point in local coordinates, return the zero-based index of the character under that Point.
abstract String	getSelectedText() Returns the portion of the text that is selected.
abstract int	getSelectionEnd() Returns the end offset within the selected text.
abstract int	getSelectionStart() Returns the start offset within the selected text.

From interface javax.swing.event.CaretListener

From interface javax.swing.event.DocumentListener

Public Constructors

public JTextComponent.AccessibleJTextComponent ()

Constructs an AccessibleJTextComponent. Adds a listener to track caret change.

Public Methods

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

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

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

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

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.

public AccessibleAction getAccessibleAction ()

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

Returns

AccessibleAction if supported by object; else return null

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

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

public AccessibleEditableText getAccessibleEditableText ()

Returns the AccessibleEditableText interface for this text component.

Returns

the AccessibleEditableText interface

public AccessibleRole getAccessibleRole ()

Gets the role of this object.

Returns

an instance of AccessibleRole describing the role of the object (AccessibleRole.TEXT)

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.

Returns

an instance of AccessibleStateSet containing the current state set of the object

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.

Returns

this object

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.

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.

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.

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.

public int getCharCount ()

Returns the number of characters (valid indices)

Returns

the number of characters >= 0

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

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

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.

public String getSelectedText ()

Returns the portion of the text that is selected.

Returns

the text, null if no selection

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public void setTextContents (String s)

Sets the text contents to the specified string.

Parameters

s	the string to set the text contents

Interfaces

Classes

Exceptions

JTextComponent.AccessibleJTextComponent

Class Overview

Summary

Public Constructors

public JTextComponent.AccessibleJTextComponent ()

Public Methods

public void caretUpdate (CaretEvent e)

Parameters

public void changedUpdate (DocumentEvent e)

Parameters

public void cut (int startIndex, int endIndex)

Parameters

public void delete (int startIndex, int endIndex)

Parameters

public boolean doAccessibleAction (int i)

Parameters

Returns

See Also

public AccessibleAction getAccessibleAction ()

Returns

public int getAccessibleActionCount ()

Returns

public String getAccessibleActionDescription (int i)

Parameters

Returns

See Also

public AccessibleEditableText getAccessibleEditableText ()

Returns

public AccessibleRole getAccessibleRole ()

Returns

See Also

public AccessibleStateSet getAccessibleStateSet ()

Returns

See Also

public AccessibleText getAccessibleText ()

Returns

public String getAfterIndex (int part, int index)

Parameters

Returns

public String getAtIndex (int part, int index)

Parameters

Returns

public String getBeforeIndex (int part, int index)

Parameters

Returns

public int getCaretPosition ()

Returns

public int getCharCount ()

Returns

public AttributeSet getCharacterAttribute (int i)

Parameters

Returns

public Rectangle getCharacterBounds (int i)

Parameters

Returns

public int getIndexAtPoint (Point p)

Parameters

Returns

public String getSelectedText ()

Returns

public int getSelectionEnd ()

Returns

public int getSelectionStart ()

Returns

public Rectangle getTextBounds (int startIndex, int endIndex)

Parameters

Returns

public String getTextRange (int startIndex, int endIndex)

Parameters

Returns

public AccessibleTextSequence getTextSequenceAfter (int part, int index)

Parameters

Returns

See Also

public AccessibleTextSequence getTextSequenceAt (int part, int index)

Parameters

Returns