This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.accessibility
interface AccessibleEditableText

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

public interface AccessibleEditableText
extends AccessibleText

The AccessibleEditableText interface should be implemented by all classes that present editable textual information on the display. Along with the AccessibleText interface, this interface provides the standard mechanism for an assistive technology to access that text via its content, attributes, and spatial location. Applications can determine if an object supports the AccessibleEditableText interface by first obtaining its AccessibleContext (see {@link Accessible}) and then calling the {@link AccessibleContext#getAccessibleEditableText} method of AccessibleContext. If the return value is not null, the object supports this interface.


Field Summary
 
Fields inherited from class javax.accessibility.AccessibleText
CHARACTER, SENTENCE, WORD
 
Method Summary
 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
 String
getTextRange(int startIndex, int endIndex)

          Returns the text string between two indices.
 void
insertTextAtIndex(int index, String s)

          Inserts the specified string at the given index/
 void
paste(int startIndex)

          Pastes the text from the system clipboard into the text starting at the specified index.
 void
replaceText(int startIndex, int endIndex, String s)

          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 as)

          Sets attributes for the text between two indices.
 void

          Sets the text contents to the specified string.
 
Methods inherited from class javax.accessibility.AccessibleText
getAfterIndex, getAtIndex, getBeforeIndex, getCaretPosition, getCharacterAttribute, getCharacterBounds, getCharCount, getIndexAtPoint, getSelectedText, getSelectionEnd, getSelectionStart
 

Method Detail

cut

public void cut(int startIndex,
                int endIndex)
Cuts the text between two indices into the system clipboard.

Parameters:
startIndex - the starting index in the text
endIndex - the ending index in the text

delete

public void delete(int startIndex,
                   int endIndex)
Deletes the text between two indices

Parameters:
startIndex - the starting index in the text
endIndex - the ending index in the text

getTextRange

public String getTextRange(int startIndex,
                           int endIndex)
Returns the text string between two indices.

Parameters:
startIndex - the starting index in the text
endIndex - the ending index in the text
Returns:
the text string between the indices

insertTextAtIndex

public void insertTextAtIndex(int index,
                              String s)
Inserts the specified string at the given index/

Parameters:
index - the index in the text where the string will be inserted
s - the string to insert in the text

paste

public void paste(int startIndex)
Pastes the text from the system clipboard into the text starting at the specified index.

Parameters:
startIndex - the starting index in the text

replaceText

public void replaceText(int startIndex,
                        int endIndex,
                        String s)
Replaces the text between two indices with the specified string.

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

selectText

public void selectText(int startIndex,
                       int endIndex)
Selects the text between two indices.

Parameters:
startIndex - the starting index in the text
endIndex - the ending index in the text

setAttributes

public void setAttributes(int startIndex,
                          int endIndex,
                          AttributeSet as)
Sets attributes for the text between two indices.

Parameters:
startIndex - the starting index in the text
endIndex - the ending index in the text
as - the attribute set

setTextContents

public void setTextContents(String s)
Sets the text contents to the specified string.

Parameters:
s - the string to set the text contents


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.