javax.accessibility

Interface AccessibleEditableText

All Superinterfaces:
AccessibleText
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()

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, getCharCount, getCharacterAttribute, getCharacterBounds, getIndexAtPoint, getSelectedText, getSelectionEnd, getSelectionStart

Method Details

cut

public 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

delete

public void delete(int start,
                   int end)
Delete the text between two points.
Parameters:
start - the start position, inclusive
end - the end position, exclusive

getTextRange

public String getTextRange(int start,
                           int end)
Return the text between two points.
Parameters:
start - the start position, inclusive
end - the end position, exclusive

insertTextAtIndex

public void insertTextAtIndex(int index,
                              String s)
Inserts the given string at the specified location.
Parameters:
index - the index for insertion
s - the new text

paste

public void paste(int start)
Paste the text from the system clipboard at the given index.
Parameters:
start - the start position

replaceText

public 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

public void selectText(int start,
                       int stop)
Select the text between two points.
Parameters:
start - the start position, inclusive

setAttributes

public 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

setTextContents

public void setTextContents(String s)
Set the text contents to the given string.
Parameters:
s - the new text

AccessibleEditableText.java -- aids in accessibly for editable text Copyright (C) 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.