javax.swing.text

Class JTextComponent.AccessibleJTextComponent

java.lang.Object

javax.accessibility.AccessibleContext

javax.swing.JComponent.AccessibleJComponent

javax.swing.text.JTextComponent.AccessibleJTextComponent

All Implemented Interfaces:

java.io.Serializable, java.util.EventListener, javax.accessibility.AccessibleAction, javax.accessibility.AccessibleComponent, javax.accessibility.AccessibleEditableText, javax.accessibility.AccessibleExtendedComponent, javax.accessibility.AccessibleText, javax.swing.event.CaretListener, javax.swing.event.DocumentListener

Enclosing class:

JTextComponent

public class JTextComponent.AccessibleJTextComponent
extends javax.swing.JComponent.AccessibleJComponent
implements javax.accessibility.AccessibleText, javax.swing.event.CaretListener, javax.swing.event.DocumentListener, javax.accessibility.AccessibleAction, javax.accessibility.AccessibleEditableText

AccessibleJTextComponent implements accessibility hooks for JTextComponent. It allows an accessibility driver to read and manipulate the text component's contents as well as update UI elements such as the caret.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent.AccessibleJComponent

javax.swing.JComponent.AccessibleJComponent.AccessibleContainerHandler, javax.swing.JComponent.AccessibleJComponent.AccessibleFocusHandler

Field Summary

Fields inherited from class javax.swing.JComponent.AccessibleJComponent

accessibleContainerHandler, accessibleFocusHandler

Fields inherited from class javax.accessibility.AccessibleContext

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, accessibleDescription, accessibleName, accessibleParent

Fields inherited from interface javax.accessibility.AccessibleAction

CLICK, DECREMENT, INCREMENT, TOGGLE_EXPAND, TOGGLE_POPUP

Fields inherited from interface javax.accessibility.AccessibleText

CHARACTER, SENTENCE, WORD

Constructor Summary

Constructors

Constructor and Description
JTextComponent.AccessibleJTextComponent() Construct an AccessibleJTextComponent.

Method Summary

Methods

Modifier and Type	Method and Description
void	caretUpdate(javax.swing.event.CaretEvent e) Handle a change in the caret position and fire any applicable property change events.
void	changedUpdate(javax.swing.event.DocumentEvent e) Handle a text change event and fire an AccessibleContext.ACCESSIBLE_TEXT_PROPERTY property change event.
void	cut(int start, int end) Cuts the text between two indexes.
void	delete(int start, int end) Deletes the text between two indexes.
boolean	doAccessibleAction(int i) Performs the i-th action.
int	getAccessibleActionCount() Returns the number of actions for this object.
java.lang.String	getAccessibleActionDescription(int i) Returns the description of the i-th action.
javax.accessibility.AccessibleEditableText	getAccessibleEditableText() Retrieve an AccessibleEditableText object that controls this text component.
javax.accessibility.AccessibleRole	getAccessibleRole() Retrieve the accessible role of this component.
javax.accessibility.AccessibleStateSet	getAccessibleStateSet() Retreive the accessible state set of this component.
javax.accessibility.AccessibleText	getAccessibleText() Retrieve an AccessibleText object that controls this text component.
java.lang.String	getAfterIndex(int part, int index) Gets the text located after index. null is returned if the index or part is invalid.
java.lang.String	getAtIndex(int part, int index) Gets the text located at index. null is returned if the index or part is invalid.
java.lang.String	getBeforeIndex(int part, int index) Gets the text located before index. null is returned if the index or part is invalid.
int	getCaretPosition() Retrieve the current caret position.
AttributeSet	getCharacterAttribute(int index) Gets the character attributes of the character at index.
java.awt.Rectangle	getCharacterBounds(int index) Calculate the bounding box of the character at the given index.
int	getCharCount() Return the length of the text in this text component.
int	getIndexAtPoint(java.awt.Point p) Get the index of the character at the given point, in component pixel co-ordinates.
java.lang.String	getSelectedText() Retrieve the current text selection.
int	getSelectionEnd() Retrieve the index of the last character in the current text selection.
int	getSelectionStart() Retrieve the index of the first character in the current text selection.
java.lang.String	getTextRange(int start, int end) Gets the text between two indexes.
void	insertTextAtIndex(int index, java.lang.String s) Inserts the text at the given index.
void	insertUpdate(javax.swing.event.DocumentEvent e) Handle a text insertion event and fire an AccessibleContext.ACCESSIBLE_TEXT_PROPERTY property change event.
void	paste(int start) Pastes the text from the system clipboard to the given index.
void	removeUpdate(javax.swing.event.DocumentEvent e) Handle a text removal event and fire an AccessibleContext.ACCESSIBLE_TEXT_PROPERTY property change event.
void	replaceText(int start, int end, java.lang.String s) Replaces the text between two indexes with the given text.
void	selectText(int start, int end) Selects the text between two indexes.
void	setAttributes(int start, int end, AttributeSet s) Sets the attributes of all the text between two indexes.
void	setTextContents(java.lang.String s) Sets the text contents.

Methods inherited from class javax.swing.JComponent.AccessibleJComponent

addPropertyChangeListener, getAccessibleChild, getAccessibleChildrenCount, getAccessibleDescription, getAccessibleKeyBinding, getAccessibleName, getBorderTitle, getTitledBorderText, getToolTipText, removePropertyChangeListener

Methods inherited from class javax.accessibility.AccessibleContext

firePropertyChange, getAccessibleAction, getAccessibleIcon, getAccessibleRelationSet, getAccessibleSelection, getAccessibleTable, getAccessibleValue, setAccessibleDescription, setAccessibleName, setAccessibleParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.accessibility.AccessibleComponent

addFocusListener, 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 Detail

JTextComponent.AccessibleJTextComponent

public JTextComponent.AccessibleJTextComponent()

Construct an AccessibleJTextComponent.

Method Detail

getCaretPosition

public int getCaretPosition()

Retrieve the current caret position. The index of the first caret position is 0.

Specified by:

getCaretPosition in interface javax.accessibility.AccessibleText

Returns:

caret position

getSelectedText

public java.lang.String getSelectedText()

Retrieve the current text selection. If no text is selected this method returns null.

Specified by:

getSelectedText in interface javax.accessibility.AccessibleText

Returns:

the currently selected text or null

getSelectionStart

public int getSelectionStart()

Retrieve the index of the first character in the current text selection. If there is no text in the text component, this method returns 0. If there is text in the text component, but there is no selection, this method returns the current caret position.

Specified by:

getSelectionStart in interface javax.accessibility.AccessibleText

Returns:

the index of the first character in the selection, the current caret position or 0

getSelectionEnd

public int getSelectionEnd()

Retrieve the index of the last character in the current text selection. If there is no text in the text component, this method returns 0. If there is text in the text component, but there is no selection, this method returns the current caret position.

Specified by:

getSelectionEnd in interface javax.accessibility.AccessibleText

Returns:

the index of the last character in the selection, the current caret position or 0

caretUpdate

public void caretUpdate(javax.swing.event.CaretEvent e)

Handle a change in the caret position and fire any applicable property change events.

Specified by:

caretUpdate in interface javax.swing.event.CaretListener

Parameters:

e - - the caret update event

getAccessibleStateSet

public javax.accessibility.AccessibleStateSet getAccessibleStateSet()

Retreive the accessible state set of this component.

Overrides:

getAccessibleStateSet in class javax.swing.JComponent.AccessibleJComponent

Returns:

the accessible state set of this component

See Also:

AccessibleState

getAccessibleRole

public javax.accessibility.AccessibleRole getAccessibleRole()

Retrieve the accessible role of this component.

Overrides:

getAccessibleRole in class javax.swing.JComponent.AccessibleJComponent

Returns:

the accessible role of this component

See Also:

AccessibleRole

getAccessibleEditableText

public javax.accessibility.AccessibleEditableText getAccessibleEditableText()

Retrieve an AccessibleEditableText object that controls this text component.

Overrides:

getAccessibleEditableText in class javax.accessibility.AccessibleContext

Returns:

this

See Also:

AccessibleEditableText

getAccessibleText

public javax.accessibility.AccessibleText getAccessibleText()

Retrieve an AccessibleText object that controls this text component.

Overrides:

getAccessibleText in class javax.accessibility.AccessibleContext

Returns:

this

See Also:

AccessibleText

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent e)

Handle a text insertion event and fire an AccessibleContext.ACCESSIBLE_TEXT_PROPERTY property change event.

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - - the insertion event

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent e)

Handle a text removal event and fire an AccessibleContext.ACCESSIBLE_TEXT_PROPERTY property change event.

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - - the removal event

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent e)

Handle a text change event and fire an AccessibleContext.ACCESSIBLE_TEXT_PROPERTY property change event.

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - - text change event

getIndexAtPoint

public int getIndexAtPoint(java.awt.Point p)

Get the index of the character at the given point, in component pixel co-ordinates. If the point argument is invalid this method returns -1.

Specified by:

getIndexAtPoint in interface javax.accessibility.AccessibleText

Parameters:

p - - a point in component pixel co-ordinates

Returns:

a character index, or -1

getCharacterBounds

public java.awt.Rectangle getCharacterBounds(int index)

Calculate the bounding box of the character at the given index. The returned x and y co-ordinates are relative to this text component's top-left corner. If the index is invalid this method returns null.

Specified by:

getCharacterBounds in interface javax.accessibility.AccessibleText

Parameters:

index - - the character index

Returns:

a character's bounding box, or null

getCharCount

public int getCharCount()

Return the length of the text in this text component.

Specified by:

getCharCount in interface javax.accessibility.AccessibleText

Returns:

a character length

getCharacterAttribute

public AttributeSet getCharacterAttribute(int index)

Gets the character attributes of the character at index. If the index is out of bounds, null is returned.

Specified by:

getCharacterAttribute in interface javax.accessibility.AccessibleText

Parameters:

index - - index of the character

Returns:

the character's attributes

getAtIndex

public java.lang.String getAtIndex(int part,
                          int index)

Gets the text located at index. null is returned if the index or part is invalid.

Specified by:

getAtIndex in interface javax.accessibility.AccessibleText

Parameters:

part - - AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE

index - - index of the part

Returns:

the part of text at that index, or null

getAfterIndex

public java.lang.String getAfterIndex(int part,
                             int index)

Gets the text located after index. null is returned if the index or part is invalid.

Specified by:

getAfterIndex in interface javax.accessibility.AccessibleText

Parameters:

part - - AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE

index - - index after the part

Returns:

the part of text after that index, or null

getBeforeIndex

public java.lang.String getBeforeIndex(int part,
                              int index)

Gets the text located before index. null is returned if the index or part is invalid.

Specified by:

getBeforeIndex in interface javax.accessibility.AccessibleText

Parameters:

part - - AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE

index - - index before the part

Returns:

the part of text before that index, or null

getAccessibleActionCount

public int getAccessibleActionCount()

Returns the number of actions for this object. The zero-th object represents the default action.

Specified by:

getAccessibleActionCount in interface javax.accessibility.AccessibleAction

Returns:

the number of actions (0-based).

getAccessibleActionDescription

public java.lang.String getAccessibleActionDescription(int i)

Returns the description of the i-th action. Null is returned if i is out of bounds.

Specified by:

getAccessibleActionDescription in interface javax.accessibility.AccessibleAction

Parameters:

i - - the action to get the description for

Returns:

description of the i-th action

doAccessibleAction

public boolean doAccessibleAction(int i)

Performs the i-th action. Nothing happens if i is out of bounds.

Specified by:

doAccessibleAction in interface javax.accessibility.AccessibleAction

Parameters:

i - - the action to perform

Returns:

true if the action was performed successfully

setTextContents

public void setTextContents(java.lang.String s)

Sets the text contents.

Specified by:

setTextContents in interface javax.accessibility.AccessibleEditableText

Parameters:

s - - the new text contents.

insertTextAtIndex

public void insertTextAtIndex(int index,
                     java.lang.String s)

Inserts the text at the given index.

Specified by:

insertTextAtIndex in interface javax.accessibility.AccessibleEditableText

Parameters:

index - - the index to insert the new text at.

s - - the new text

getTextRange

public java.lang.String getTextRange(int start,
                            int end)

Gets the text between two indexes.

Specified by:

getTextRange in interface javax.accessibility.AccessibleEditableText

Parameters:

start - - the starting index (inclusive)

end - - the ending index (exclusive)

delete

public void delete(int start,
          int end)

Deletes the text between two indexes.

Specified by:

delete in interface javax.accessibility.AccessibleEditableText

Parameters:

start - - the starting index (inclusive)

end - - the ending index (exclusive)

cut

public void cut(int start,
       int end)

Cuts the text between two indexes. The text is put into the system clipboard.

Specified by:

cut in interface javax.accessibility.AccessibleEditableText

Parameters:

start - - the starting index (inclusive)

end - - the ending index (exclusive)

paste

public void paste(int start)

Pastes the text from the system clipboard to the given index.

Specified by:

paste in interface javax.accessibility.AccessibleEditableText

Parameters:

start - - the starting index

replaceText

public void replaceText(int start,
               int end,
               java.lang.String s)

Replaces the text between two indexes with the given text.

Specified by:

replaceText in interface javax.accessibility.AccessibleEditableText

Parameters:

start - - the starting index (inclusive)

end - - the ending index (exclusive)

s - - the text to paste

selectText

public void selectText(int start,
              int end)

Selects the text between two indexes.

Specified by:

selectText in interface javax.accessibility.AccessibleEditableText

Parameters:

start - - the starting index (inclusive)

end - - the ending index (exclusive)

setAttributes

public void setAttributes(int start,
                 int end,
                 AttributeSet s)

Sets the attributes of all the text between two indexes.

Specified by:

setAttributes in interface javax.accessibility.AccessibleEditableText

Parameters:

start - - the starting index (inclusive)

end - - the ending index (exclusive)

s - - the new attribute set for the text in the range