Class JTextComponent.AccessibleJTextComponent
java.lang.Object
javax.accessibility.AccessibleContext
java.awt.Component.AccessibleAWTComponent
java.awt.Container.AccessibleAWTContainer
javax.swing.JComponent.AccessibleJComponent
javax.swing.text.JTextComponent.AccessibleJTextComponent
- All Implemented Interfaces:
- Serializable,- EventListener,- 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 JavaBeans
 has been added to the java.beans package.
 Please see XMLEncoder.
- 
Nested Class SummaryNested classes/interfaces declared in class javax.swing.JComponent.AccessibleJComponentJComponent.AccessibleJComponent.AccessibleContainerHandler, JComponent.AccessibleJComponent.AccessibleFocusHandlerNested classes/interfaces declared in class java.awt.Component.AccessibleAWTComponentComponent.AccessibleAWTComponent.AccessibleAWTComponentHandler, Component.AccessibleAWTComponent.AccessibleAWTFocusHandler
- 
Field SummaryFields declared in class javax.swing.JComponent.AccessibleJComponentaccessibleFocusHandlerFields declared in class java.awt.Container.AccessibleAWTContaineraccessibleContainerHandlerFields declared in class java.awt.Component.AccessibleAWTComponentaccessibleAWTComponentHandler, accessibleAWTFocusHandlerFields declared in class javax.accessibility.AccessibleContextACCESSIBLE_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, accessibleParentFields declared in interface javax.accessibility.AccessibleActionCLICK, DECREMENT, INCREMENT, TOGGLE_EXPAND, TOGGLE_POPUPFields declared in interface javax.accessibility.AccessibleExtendedTextATTRIBUTE_RUN, LINEFields declared in interface javax.accessibility.AccessibleTextCHARACTER, SENTENCE, WORD
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidHandles caret updates (fire appropriate property change event, which are AccessibleContext.ACCESSIBLE_CARET_PROPERTY and AccessibleContext.ACCESSIBLE_SELECTION_PROPERTY).voidHandles document remove (fire appropriate property change event, which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY).voidcut(int startIndex, int endIndex) Cuts the text between two indices into the system clipboard.voiddelete(int startIndex, int endIndex) Deletes the text between two indicesbooleandoAccessibleAction(int i) Performs the specified Action on the objectintReturns 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 a description of the specified action of the object.Returns the AccessibleEditableText interface for this text component.Gets the role of this object.Gets the state set of the JTextComponent.Get the AccessibleText associated with this object.getAfterIndex(int part, int index) Returns the String after a given index.getAtIndex(int part, int index) Returns the String at a given index.getBeforeIndex(int part, int index) Returns the String before a given index.intReturns the zero-based offset of the caret.getCharacterAttribute(int i) Returns the AttributeSet for a given character (at a given index).getCharacterBounds(int i) Determines the bounding box of the character at the given index into the string.intReturns the number of characters (valid indices)intGiven a point in local coordinates, return the zero-based index of the character under that Point.Returns the portion of the text that is selected.intReturns the end offset within the selected text.intReturns the start offset within the selected text.getTextBounds(int startIndex, int endIndex) Returns theRectangleenclosing the text between two indices.getTextRange(int startIndex, int endIndex) Returns the text string between two indices.getTextSequenceAfter(int part, int index) Returns theAccessibleTextSequenceafter a givenindex.getTextSequenceAt(int part, int index) Returns theAccessibleTextSequenceat a givenindex.getTextSequenceBefore(int part, int index) Returns theAccessibleTextSequencebefore a givenindex.voidinsertTextAtIndex(int index, String s) Inserts the specified string at the given indexvoidHandles document insert (fire appropriate property change event which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY).voidpaste(int startIndex) Pastes the text from the system clipboard into the text starting at the specified index.voidHandles document remove (fire appropriate property change event, which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY).voidreplaceText(int startIndex, int endIndex, String s) Replaces the text between two indices with the specified string.voidselectText(int startIndex, int endIndex) Selects the text between two indices.voidsetAttributes(int startIndex, int endIndex, AttributeSet as) Sets attributes for the text between two indices.voidSets the text contents to the specified string.Methods declared in class javax.swing.JComponent.AccessibleJComponentaddPropertyChangeListener, getAccessibleChild, getAccessibleChildrenCount, getAccessibleDescription, getAccessibleKeyBinding, getAccessibleName, getBorderTitle, getTitledBorderText, getToolTipText, removePropertyChangeListenerMethods declared in class java.awt.Container.AccessibleAWTContainergetAccessibleAtMethods declared in class java.awt.Component.AccessibleAWTComponentaddFocusListener, contains, getAccessibleComponent, getAccessibleIndexInParent, getAccessibleParent, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocale, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisibleMethods declared in class javax.accessibility.AccessibleContextfirePropertyChange, getAccessibleAction, getAccessibleIcon, getAccessibleRelationSet, getAccessibleSelection, getAccessibleTable, getAccessibleValue, setAccessibleDescription, setAccessibleName, setAccessibleParentMethods declared in class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods declared in interface javax.accessibility.AccessibleComponentaddFocusListener, contains, getAccessibleAt, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible
- 
Constructor Details- 
AccessibleJTextComponentpublic AccessibleJTextComponent()Constructs an AccessibleJTextComponent. Adds a listener to track caret change.
 
- 
- 
Method Details- 
caretUpdateHandles 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.- Specified by:
- caretUpdatein interface- CaretListener
- Parameters:
- e- the CaretEvent
 
- 
insertUpdateHandles document insert (fire appropriate property change event which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY). This tracks the changed offset via the event.- Specified by:
- insertUpdatein interface- DocumentListener
- Parameters:
- e- the DocumentEvent
 
- 
removeUpdateHandles document remove (fire appropriate property change event, which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY). This tracks the changed offset via the event.- Specified by:
- removeUpdatein interface- DocumentListener
- Parameters:
- e- the DocumentEvent
 
- 
changedUpdateHandles document remove (fire appropriate property change event, which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY). This tracks the changed offset via the event.- Specified by:
- changedUpdatein interface- DocumentListener
- Parameters:
- e- the DocumentEvent
 
- 
getAccessibleStateSetGets 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:
- getAccessibleStateSetin class- JComponent.AccessibleJComponent
- Returns:
- an instance of AccessibleStateSet containing the current state set of the object
- See Also:
 
- 
getAccessibleRoleGets the role of this object.- Overrides:
- getAccessibleRolein class- JComponent.AccessibleJComponent
- Returns:
- an instance of AccessibleRole describing the role of the object (AccessibleRole.TEXT)
- See Also:
 
- 
getAccessibleTextGet 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:
- getAccessibleTextin class- AccessibleContext
- Returns:
- this object
- See Also:
 
- 
getIndexAtPointGiven 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.- Specified by:
- getIndexAtPointin interface- AccessibleText
- Parameters:
- p- the Point in local coordinates
- Returns:
- the zero-based index of the character under Point p.
 
- 
getCharacterBoundsDetermines 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.- Specified by:
- getCharacterBoundsin interface- AccessibleText
- Parameters:
- i- the index into the String ≥ 0
- Returns:
- the screen coordinates of the character's bounding box
 
- 
getCharCountpublic int getCharCount()Returns the number of characters (valid indices)- Specified by:
- getCharCountin interface- AccessibleText
- Returns:
- the number of characters ≥ 0
 
- 
getCaretPositionpublic 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).- Specified by:
- getCaretPositionin interface- AccessibleText
- Returns:
- the zero-based offset of the caret.
 
- 
getCharacterAttributeReturns the AttributeSet for a given character (at a given index).- Specified by:
- getCharacterAttributein interface- AccessibleText
- Parameters:
- i- the zero-based index into the text
- Returns:
- the AttributeSet of the character
 
- 
getSelectionStartpublic 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.- Specified by:
- getSelectionStartin interface- AccessibleText
- Returns:
- the index into the text of the start of the selection ≥ 0
 
- 
getSelectionEndpublic 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.- Specified by:
- getSelectionEndin interface- AccessibleText
- Returns:
- the index into the text of the end of the selection ≥ 0
 
- 
getSelectedTextReturns the portion of the text that is selected.- Specified by:
- getSelectedTextin interface- AccessibleText
- Returns:
- the text, null if no selection
 
- 
getAtIndexReturns the String at a given index. Whitespace between words is treated as a word.- Specified by:
- getAtIndexin interface- AccessibleText
- Parameters:
- part- the CHARACTER, WORD, or SENTENCE to retrieve
- index- an index within the text
- Returns:
- the letter, word, or sentence.
 
- 
getAfterIndexReturns the String after a given index. Whitespace between words is treated as a word.- Specified by:
- getAfterIndexin interface- AccessibleText
- Parameters:
- part- the CHARACTER, WORD, or SENTENCE to retrieve
- index- an index within the text
- Returns:
- the letter, word, or sentence.
 
- 
getBeforeIndexReturns the String before a given index. Whitespace between words is treated a word.- Specified by:
- getBeforeIndexin interface- AccessibleText
- Parameters:
- part- the CHARACTER, WORD, or SENTENCE to retrieve
- index- an index within the text
- Returns:
- the letter, word, or sentence.
 
- 
getAccessibleEditableTextReturns the AccessibleEditableText interface for this text component.- Overrides:
- getAccessibleEditableTextin class- AccessibleContext
- Returns:
- the AccessibleEditableText interface
- Since:
- 1.4
- See Also:
 
- 
setTextContentsSets the text contents to the specified string.- Specified by:
- setTextContentsin interface- AccessibleEditableText
- Parameters:
- s- the string to set the text contents
- Since:
- 1.4
 
- 
insertTextAtIndexInserts the specified string at the given index- Specified by:
- insertTextAtIndexin interface- AccessibleEditableText
- Parameters:
- index- the index in the text where the string will be inserted
- s- the string to insert in the text
- Since:
- 1.4
 
- 
getTextRangeReturns the text string between two indices.- Specified by:
- getTextRangein interface- AccessibleEditableText
- Specified by:
- getTextRangein interface- AccessibleExtendedText
- Parameters:
- startIndex- the starting index in the text
- endIndex- the ending index in the text
- Returns:
- the text string between the indices
- Since:
- 1.4
 
- 
deletepublic void delete(int startIndex, int endIndex) Deletes the text between two indices- Specified by:
- deletein interface- AccessibleEditableText
- Parameters:
- startIndex- the starting index in the text
- endIndex- the ending index in the text
- Since:
- 1.4
 
- 
cutpublic void cut(int startIndex, int endIndex) Cuts the text between two indices into the system clipboard.- Specified by:
- cutin interface- AccessibleEditableText
- Parameters:
- startIndex- the starting index in the text
- endIndex- the ending index in the text
- Since:
- 1.4
 
- 
pastepublic void paste(int startIndex) Pastes the text from the system clipboard into the text starting at the specified index.- Specified by:
- pastein interface- AccessibleEditableText
- Parameters:
- startIndex- the starting index in the text
- Since:
- 1.4
 
- 
replaceTextReplaces the text between two indices with the specified string.- Specified by:
- replaceTextin interface- AccessibleEditableText
- 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
- Since:
- 1.4
 
- 
selectTextpublic void selectText(int startIndex, int endIndex) Selects the text between two indices.- Specified by:
- selectTextin interface- AccessibleEditableText
- Parameters:
- startIndex- the starting index in the text
- endIndex- the ending index in the text
- Since:
- 1.4
 
- 
setAttributesSets attributes for the text between two indices.- Specified by:
- setAttributesin interface- AccessibleEditableText
- Parameters:
- startIndex- the starting index in the text
- endIndex- the ending index in the text
- as- the attribute set
- Since:
- 1.4
- See Also:
 
- 
getTextSequenceAtReturns theAccessibleTextSequenceat a givenindex.- Specified by:
- getTextSequenceAtin interface- AccessibleExtendedText
- Parameters:
- part- the- CHARACTER,- WORD,- SENTENCE,- LINEor- ATTRIBUTE_RUNto retrieve
- index- an index within the text
- Returns:
- an AccessibleTextSequencespecifying the text ifpartandindexare valid. Otherwise,nullis returned
- Since:
- 1.6
- See Also:
 
- 
getTextSequenceAfterReturns theAccessibleTextSequenceafter a givenindex.- Specified by:
- getTextSequenceAfterin interface- AccessibleExtendedText
- Parameters:
- part- the- CHARACTER,- WORD,- SENTENCE,- LINEor- ATTRIBUTE_RUNto retrieve
- index- an index within the text
- Returns:
- an AccessibleTextSequencespecifying the text ifpartandindexare valid. Otherwise,nullis returned
- Since:
- 1.6
- See Also:
 
- 
getTextSequenceBeforeReturns theAccessibleTextSequencebefore a givenindex.- Specified by:
- getTextSequenceBeforein interface- AccessibleExtendedText
- Parameters:
- part- the- CHARACTER,- WORD,- SENTENCE,- LINEor- ATTRIBUTE_RUNto retrieve
- index- an index within the text
- Returns:
- an AccessibleTextSequencespecifying the text ifpartandindexare valid. Otherwise,nullis returned
- Since:
- 1.6
- See Also:
 
- 
getTextBoundsReturns theRectangleenclosing the text between two indices.- Specified by:
- getTextBoundsin interface- AccessibleExtendedText
- 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, nullis returned
- Since:
- 1.6
 
- 
getAccessibleActionCountpublic 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.- Specified by:
- getAccessibleActionCountin interface- AccessibleAction
- Returns:
- the zero-based number of Actions in this object
- Since:
- 1.4
 
- 
getAccessibleActionDescriptionReturns a description of the specified action of the object.- Specified by:
- getAccessibleActionDescriptionin interface- AccessibleAction
- Parameters:
- i- zero-based index of the actions
- Returns:
- a String description of the action
- Since:
- 1.4
- See Also:
 
- 
doAccessibleActionpublic boolean doAccessibleAction(int i) Performs the specified Action on the object- Specified by:
- doAccessibleActionin interface- AccessibleAction
- Parameters:
- i- zero-based index of actions
- Returns:
- true if the action was performed; otherwise false.
- Since:
- 1.4
- See Also:
 
 
-