Serializable
, EventListener
, AccessibleAction
, AccessibleComponent
, AccessibleEditableText
, AccessibleExtendedComponent
, AccessibleExtendedText
, AccessibleText
, CaretListener
, DocumentListener
JEditorPane.AccessibleJEditorPane
, JTextArea.AccessibleJTextArea
, JTextField.AccessibleJTextField
JTextComponent
public class JTextComponent.AccessibleJTextComponent extends JComponent.AccessibleJComponent implements AccessibleText, CaretListener, DocumentListener, AccessibleAction, AccessibleEditableText, AccessibleExtendedText
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
.
JComponent.AccessibleJComponent.AccessibleContainerHandler, JComponent.AccessibleJComponent.AccessibleFocusHandler
Component.AccessibleAWTComponent.AccessibleAWTComponentHandler, Component.AccessibleAWTComponent.AccessibleAWTFocusHandler
accessibleFocusHandler
accessibleContainerHandler
accessibleAWTComponentHandler, accessibleAWTFocusHandler
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
CLICK, DECREMENT, INCREMENT, TOGGLE_EXPAND, TOGGLE_POPUP
ATTRIBUTE_RUN, LINE
CHARACTER, SENTENCE, WORD
Constructor | Description |
---|---|
AccessibleJTextComponent() |
Constructs an AccessibleJTextComponent. |
Modifier and Type | Method | Description |
---|---|---|
void |
caretUpdate |
Handles caret updates (fire appropriate property change event, which are AccessibleContext.ACCESSIBLE_CARET_PROPERTY and AccessibleContext.ACCESSIBLE_SELECTION_PROPERTY). |
void |
changedUpdate |
Handles document remove (fire appropriate property change event, which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY). |
void |
cut |
Cuts the text between two indices into the system clipboard. |
void |
delete |
Deletes the text between two indices |
boolean |
doAccessibleAction |
Performs the specified Action on the object |
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 |
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 |
Returns the String after a given index. |
String |
getAtIndex |
Returns the String at a given index. |
String |
getBeforeIndex |
Returns the String before a given index. |
int |
getCaretPosition() |
Returns the zero-based offset of the caret. |
AttributeSet |
getCharacterAttribute |
Returns the AttributeSet for a given character (at a given index). |
Rectangle |
getCharacterBounds |
Determines the bounding box of the character at the given index into the string. |
int |
getCharCount() |
Returns the number of characters (valid indices) |
int |
getIndexAtPoint |
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 |
Returns the Rectangle enclosing the text between two indices. |
String |
getTextRange |
Returns the text string between two indices. |
AccessibleTextSequence |
getTextSequenceAfter |
Returns the AccessibleTextSequence after a given index . |
AccessibleTextSequence |
getTextSequenceAt |
Returns the AccessibleTextSequence at a given index . |
AccessibleTextSequence |
getTextSequenceBefore |
Returns the AccessibleTextSequence before a given index . |
void |
insertTextAtIndex |
Inserts the specified string at the given index |
void |
insertUpdate |
Handles document insert (fire appropriate property change event which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY). |
void |
paste |
Pastes the text from the system clipboard into the text starting at the specified index. |
void |
removeUpdate |
Handles document remove (fire appropriate property change event, which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY). |
void |
replaceText |
Replaces the text between two indices with the specified string. |
void |
selectText |
Selects the text between two indices. |
void |
setAttributes |
Sets attributes for the text between two indices. |
void |
setTextContents |
Sets the text contents to the specified string. |
addPropertyChangeListener, getAccessibleChild, getAccessibleChildrenCount, getAccessibleDescription, getAccessibleKeyBinding, getAccessibleName, getBorderTitle, getTitledBorderText, getToolTipText, removePropertyChangeListener
getAccessibleAt
addFocusListener, 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, setVisible
firePropertyChange, getAccessibleAction, getAccessibleIcon, getAccessibleRelationSet, getAccessibleSelection, getAccessibleTable, getAccessibleValue, setAccessibleDescription, setAccessibleName, setAccessibleParent
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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
public AccessibleJTextComponent()
public void caretUpdate(CaretEvent e)
caretUpdate
in interface CaretListener
e
- the CaretEventpublic void insertUpdate(DocumentEvent e)
insertUpdate
in interface DocumentListener
e
- the DocumentEventpublic void removeUpdate(DocumentEvent e)
removeUpdate
in interface DocumentListener
e
- the DocumentEventpublic void changedUpdate(DocumentEvent e)
changedUpdate
in interface DocumentListener
e
- the DocumentEventpublic AccessibleStateSet getAccessibleStateSet()
getAccessibleStateSet
in class JComponent.AccessibleJComponent
public AccessibleRole getAccessibleRole()
getAccessibleRole
in class JComponent.AccessibleJComponent
public AccessibleText getAccessibleText()
getAccessibleText
in class AccessibleContext
public int getIndexAtPoint(Point p)
getIndexAtPoint
in interface AccessibleText
p
- the Point in local coordinatespublic Rectangle getCharacterBounds(int i)
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.
getCharacterBounds
in interface AccessibleText
i
- the index into the String ≥ 0public int getCharCount()
getCharCount
in interface AccessibleText
public int getCaretPosition()
getCaretPosition
in interface AccessibleText
public AttributeSet getCharacterAttribute(int i)
getCharacterAttribute
in interface AccessibleText
i
- the zero-based index into the textpublic int getSelectionStart()
getSelectionStart
in interface AccessibleText
public int getSelectionEnd()
getSelectionEnd
in interface AccessibleText
public String getSelectedText()
getSelectedText
in interface AccessibleText
public String getAtIndex(int part, int index)
getAtIndex
in interface AccessibleText
part
- the CHARACTER, WORD, or SENTENCE to retrieveindex
- an index within the textpublic String getAfterIndex(int part, int index)
getAfterIndex
in interface AccessibleText
part
- the CHARACTER, WORD, or SENTENCE to retrieveindex
- an index within the textpublic String getBeforeIndex(int part, int index)
getBeforeIndex
in interface AccessibleText
part
- the CHARACTER, WORD, or SENTENCE to retrieveindex
- an index within the textpublic AccessibleEditableText getAccessibleEditableText()
getAccessibleEditableText
in class AccessibleContext
public void setTextContents(String s)
setTextContents
in interface AccessibleEditableText
s
- the string to set the text contentspublic void insertTextAtIndex(int index, String s)
insertTextAtIndex
in interface AccessibleEditableText
index
- the index in the text where the string will be inserteds
- the string to insert in the textpublic String getTextRange(int startIndex, int endIndex)
getTextRange
in interface AccessibleEditableText
getTextRange
in interface AccessibleExtendedText
startIndex
- the starting index in the textendIndex
- the ending index in the textpublic void delete(int startIndex, int endIndex)
delete
in interface AccessibleEditableText
startIndex
- the starting index in the textendIndex
- the ending index in the textpublic void cut(int startIndex, int endIndex)
cut
in interface AccessibleEditableText
startIndex
- the starting index in the textendIndex
- the ending index in the textpublic void paste(int startIndex)
paste
in interface AccessibleEditableText
startIndex
- the starting index in the textpublic void replaceText(int startIndex, int endIndex, String s)
replaceText
in interface AccessibleEditableText
startIndex
- the starting index in the textendIndex
- the ending index in the texts
- the string to replace the text between two indicespublic void selectText(int startIndex, int endIndex)
selectText
in interface AccessibleEditableText
startIndex
- the starting index in the textendIndex
- the ending index in the textpublic void setAttributes(int startIndex, int endIndex, AttributeSet as)
setAttributes
in interface AccessibleEditableText
startIndex
- the starting index in the textendIndex
- the ending index in the textas
- the attribute setpublic AccessibleTextSequence getTextSequenceAt(int part, int index)
AccessibleTextSequence
at a given index
.getTextSequenceAt
in interface AccessibleExtendedText
part
- the CHARACTER
, WORD
, SENTENCE
, LINE
or ATTRIBUTE_RUN
to retrieveindex
- an index within the textAccessibleTextSequence
specifying the text if part
and index
are valid. Otherwise, null
is returnedpublic AccessibleTextSequence getTextSequenceAfter(int part, int index)
AccessibleTextSequence
after a given index
.getTextSequenceAfter
in interface AccessibleExtendedText
part
- the CHARACTER
, WORD
, SENTENCE
, LINE
or ATTRIBUTE_RUN
to retrieveindex
- an index within the textAccessibleTextSequence
specifying the text if part
and index
are valid. Otherwise, null
is returnedpublic AccessibleTextSequence getTextSequenceBefore(int part, int index)
AccessibleTextSequence
before a given index
.getTextSequenceBefore
in interface AccessibleExtendedText
part
- the CHARACTER
, WORD
, SENTENCE
, LINE
or ATTRIBUTE_RUN
to retrieveindex
- an index within the textAccessibleTextSequence
specifying the text if part
and index
are valid. Otherwise, null
is returnedpublic Rectangle getTextBounds(int startIndex, int endIndex)
Rectangle
enclosing the text between two indices.getTextBounds
in interface AccessibleExtendedText
startIndex
- the start index in the textendIndex
- the end index in the textnull
is returnedpublic int getAccessibleActionCount()
getAccessibleActionCount
in interface AccessibleAction
public String getAccessibleActionDescription(int i)
getAccessibleActionDescription
in interface AccessibleAction
i
- zero-based index of the actionspublic boolean doAccessibleAction(int i)
doAccessibleAction
in interface AccessibleAction
i
- zero-based index of actions
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/text/JTextComponent.AccessibleJTextComponent.html