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 accessibleFocusHandleraccessibleContainerHandleraccessibleAWTComponentHandler, accessibleAWTFocusHandlerACCESSIBLE_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, accessibleParentCLICK, DECREMENT, INCREMENT, TOGGLE_EXPAND, TOGGLE_POPUPCHARACTER, SENTENCE, WORDATTRIBUTE_RUN, LINE| Constructor and Description |
|---|
AccessibleJTextComponent()
Constructs an AccessibleJTextComponent.
|
| Modifier and Type | Method and Description |
|---|---|
void |
caretUpdate(CaretEvent
Handles caret updates (fire appropriate property change event, which are AccessibleContext.ACCESSIBLE_CARET_PROPERTY and AccessibleContext.ACCESSIBLE_SELECTION_PROPERTY).
|
void |
changedUpdate(DocumentEvent
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.
|
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 |
getCharCount()
Returns the number of characters (valid indices)
|
int |
getIndexAtPoint(Point
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
Inserts the specified string at the given index
|
void |
insertUpdate(DocumentEvent
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
Handles document remove (fire appropriate property change event, which is AccessibleContext.ACCESSIBLE_TEXT_PROPERTY).
|
void |
replaceText(int startIndex, int endIndex, String
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
Sets attributes for the text between two indices.
|
void |
setTextContents(String
Sets the text contents to the specified string.
|
addPropertyChangeListener, getAccessibleChild, getAccessibleChildrenCount, getAccessibleDescription, getAccessibleKeyBinding, getAccessibleName, getBorderTitle, getTitledBorderText, getToolTipText, removePropertyChangeListenergetAccessibleAtaddFocusListener, 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, setVisiblefirePropertyChange, getAccessibleIcon, getAccessibleRelationSet, getAccessibleSelection, getAccessibleTable, getAccessibleValue, setAccessibleDescription, setAccessibleName, setAccessibleParentclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddFocusListener, 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, setVisiblepublic AccessibleJTextComponent()
public void caretUpdate(CaretEvente)
caretUpdate in interface
CaretListener
e - the CaretEvent
public void insertUpdate(DocumentEvente)
insertUpdate in interface
DocumentListener
e - the DocumentEvent
public void removeUpdate(DocumentEvente)
removeUpdate in interface
DocumentListener
e - the DocumentEvent
public void changedUpdate(DocumentEvente)
changedUpdate in interface
DocumentListener
e - the DocumentEvent
public AccessibleStateSetgetAccessibleStateSet()
getAccessibleStateSet in class
JComponent.AccessibleJComponent
AccessibleStateSet,
AccessibleState,
JComponent.AccessibleJComponent.addPropertyChangeListener(java.beans.PropertyChangeListener)
public AccessibleRolegetAccessibleRole()
getAccessibleRole in class
JComponent.AccessibleJComponent
AccessibleRole
public AccessibleTextgetAccessibleText()
getAccessibleText in class
AccessibleContext
AccessibleText
public int getIndexAtPoint(Pointp)
getIndexAtPoint in interface
AccessibleText
p - the Point in local coordinates
public RectanglegetCharacterBounds(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 ≥ 0
public int getCharCount()
getCharCount in interface
AccessibleText
public int getCaretPosition()
getCaretPosition in interface
AccessibleText
public AttributeSetgetCharacterAttribute(int i)
getCharacterAttribute in interface
AccessibleText
i - the zero-based index into the text
public int getSelectionStart()
getSelectionStart in interface
AccessibleText
public int getSelectionEnd()
getSelectionEnd in interface
AccessibleText
public StringgetSelectedText()
getSelectedText in interface
AccessibleText
public StringgetAtIndex(int part, int index)
getAtIndex in interface
AccessibleText
part - the CHARACTER, WORD, or SENTENCE to retrieve
index - an index within the text
public StringgetAfterIndex(int part, int index)
getAfterIndex in interface
AccessibleText
part - the CHARACTER, WORD, or SENTENCE to retrieve
index - an index within the text
public StringgetBeforeIndex(int part, int index)
getBeforeIndex in interface
AccessibleText
part - the CHARACTER, WORD, or SENTENCE to retrieve
index - an index within the text
public AccessibleEditableTextgetAccessibleEditableText()
getAccessibleEditableText in class
AccessibleContext
AccessibleEditableText
public void setTextContents(Strings)
setTextContents in interface
AccessibleEditableText
s - the string to set the text contents
public void insertTextAtIndex(int index,
String s)
insertTextAtIndex in interface
AccessibleEditableText
index - the index in the text where the string will be inserted
s - the string to insert in the text
public StringgetTextRange(int startIndex, int endIndex)
getTextRange in interface
AccessibleEditableText
getTextRange in interface
AccessibleExtendedText
startIndex - the starting index in the text
endIndex - the ending index in the text
public void delete(int startIndex,
int endIndex)
delete in interface
AccessibleEditableText
startIndex - the starting index in the text
endIndex - the ending index in the text
public void cut(int startIndex,
int endIndex)
cut in interface
AccessibleEditableText
startIndex - the starting index in the text
endIndex - the ending index in the text
public void paste(int startIndex)
paste in interface
AccessibleEditableText
startIndex - the starting index in the text
public void replaceText(int startIndex,
int endIndex,
String s)
replaceText in interface
AccessibleEditableText
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)
selectText in interface
AccessibleEditableText
startIndex - the starting index in the text
endIndex - the ending index in the text
public void setAttributes(int startIndex,
int endIndex,
AttributeSet as)
setAttributes in interface
AccessibleEditableText
startIndex - the starting index in the text
endIndex - the ending index in the text
as - the attribute set
AttributeSet
public AccessibleTextSequencegetTextSequenceAt(int part, int index)
AccessibleTextSequence at a given
index.
getTextSequenceAt in interface
AccessibleExtendedText
part - the
CHARACTER,
WORD,
SENTENCE,
LINE or
ATTRIBUTE_RUN to retrieve
index - an index within the text
AccessibleTextSequence specifying the text if
part and
index are valid. Otherwise,
null is returned
AccessibleText.CHARACTER ,
AccessibleText.WORD ,
AccessibleText.SENTENCE ,
AccessibleExtendedText.LINE ,
AccessibleExtendedText.ATTRIBUTE_RUN
public AccessibleTextSequencegetTextSequenceAfter(int part, int index)
AccessibleTextSequence after a given
index.
getTextSequenceAfter in interface
AccessibleExtendedText
part - the
CHARACTER,
WORD,
SENTENCE,
LINE or
ATTRIBUTE_RUN to retrieve
index - an index within the text
AccessibleTextSequence specifying the text if
part and
index are valid. Otherwise,
null is returned
AccessibleText.CHARACTER ,
AccessibleText.WORD ,
AccessibleText.SENTENCE ,
AccessibleExtendedText.LINE ,
AccessibleExtendedText.ATTRIBUTE_RUN
public AccessibleTextSequencegetTextSequenceBefore(int part, int index)
AccessibleTextSequence before a given
index.
getTextSequenceBefore in interface
AccessibleExtendedText
part - the
CHARACTER,
WORD,
SENTENCE,
LINE or
ATTRIBUTE_RUN to retrieve
index - an index within the text
AccessibleTextSequence specifying the text if
part and
index are valid. Otherwise,
null is returned
AccessibleText.CHARACTER ,
AccessibleText.WORD ,
AccessibleText.SENTENCE ,
AccessibleExtendedText.LINE ,
AccessibleExtendedText.ATTRIBUTE_RUN
public RectanglegetTextBounds(int startIndex, int endIndex)
Rectangle enclosing the text between two indicies.
getTextBounds in interface
AccessibleExtendedText
startIndex - the start index in the text
endIndex - the end index in the text
null is returned
public AccessibleActiongetAccessibleAction()
AccessibleContext
getAccessibleAction in class
AccessibleContext
AccessibleAction
public int getAccessibleActionCount()
getAccessibleActionCount in interface
AccessibleAction
public StringgetAccessibleActionDescription(int i)
getAccessibleActionDescription in interface
AccessibleAction
i - zero-based index of the actions
getAccessibleActionCount()
public boolean doAccessibleAction(int i)
doAccessibleAction in interface
AccessibleAction
i - zero-based index of actions
getAccessibleActionCount()