javax.accessibility
Interface AccessibleEditableText

All Superinterfaces:
AccessibleText
All Known Implementing Classes:
JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport, JPasswordField.AccessibleJPasswordField, JTextArea.AccessibleJTextArea, JTextComponent.AccessibleJTextComponent, JTextField.AccessibleJTextField

public interface AccessibleEditableText
extends AccessibleText

Objects which present editable textual information on the display should implement this interface. Accessibility software can use the implementations of this interface to change the content, attributes, and spacial location of the text.

The AccessibleContext.getAccessibleEditableText() method should return null if an object does not implement this interface.

Since:
1.2
See Also:
Accessible, AccessibleContext, AccessibleContext.getAccessibleText(), AccessibleContext.getAccessibleEditableText()

Field Summary
 
Fields inherited from interface javax.accessibility.AccessibleText
CHARACTER, SENTENCE, WORD
 
Method Summary
 void cut(int start, int end)
          Cut the text between two points to the system clipboard.
 void delete(int start, int end)
          Delete the text between two points.
 String getTextRange(int start, int end)
          Return the text between two points.
 void insertTextAtIndex(int index, String s)
          Inserts the given string at the specified location.
 void paste(int start)
          Paste the text from the system clipboard at the given index.
 void replaceText(int start, int end, String s)
          Replace the text between two points with the given string.
 void selectText(int start, int stop)
          Select the text between two points.
 void setAttributes(int start, int end, AttributeSet s)
          Set the attributes of text between two points.
 void setTextContents(String s)
          Set the text contents to the given string.
 
Methods inherited from interface javax.accessibility.AccessibleText
getAfterIndex, getAtIndex, getBeforeIndex, getCaretPosition, getCharacterAttribute, getCharacterBounds, getCharCount, getIndexAtPoint, getSelectedText, getSelectionEnd, getSelectionStart
 

Method Detail

setTextContents

void setTextContents(String s)
Set the text contents to the given string.

Parameters:
s - the new text

insertTextAtIndex

void insertTextAtIndex(int index,
                       String s)
Inserts the given string at the specified location.

Parameters:
index - the index for insertion
s - the new text

getTextRange

String getTextRange(int start,
                    int end)
Return the text between two points.

Parameters:
start - the start position, inclusive
end - the end position, exclusive

delete

void delete(int start,
            int end)
Delete the text between two points.

Parameters:
start - the start position, inclusive
end - the end position, exclusive

cut

void cut(int start,
         int end)
Cut the text between two points to the system clipboard.

Parameters:
start - the start position, inclusive
end - the end position, exclusive

paste

void paste(int start)
Paste the text from the system clipboard at the given index.

Parameters:
start - the start position

replaceText

void replaceText(int start,
                 int end,
                 String s)
Replace the text between two points with the given string.

Parameters:
start - the start position, inclusive
end - the end position, exclusive
s - the string to paste

selectText

void selectText(int start,
                int stop)
Select the text between two points.

Parameters:
start - the start position, inclusive
end - the end position, exclusive

setAttributes

void setAttributes(int start,
                   int end,
                   AttributeSet s)
Set the attributes of text between two points.

Parameters:
start - the start position, inclusive
end - the end position, exclusive
s - the new attribute set for the range