001 /* AccessibleEditableText.java -- aids in accessibly for editable text 002 Copyright (C) 2002, 2005 Free Software Foundation, Inc. 003 004 This file is part of GNU Classpath. 005 006 GNU Classpath is free software; you can redistribute it and/or modify 007 it under the terms of the GNU General Public License as published by 008 the Free Software Foundation; either version 2, or (at your option) 009 any later version. 010 011 GNU Classpath is distributed in the hope that it will be useful, but 012 WITHOUT ANY WARRANTY; without even the implied warranty of 013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 General Public License for more details. 015 016 You should have received a copy of the GNU General Public License 017 along with GNU Classpath; see the file COPYING. If not, write to the 018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 019 02110-1301 USA. 020 021 Linking this library statically or dynamically with other modules is 022 making a combined work based on this library. Thus, the terms and 023 conditions of the GNU General Public License cover the whole 024 combination. 025 026 As a special exception, the copyright holders of this library give you 027 permission to link this library with independent modules to produce an 028 executable, regardless of the license terms of these independent 029 modules, and to copy and distribute the resulting executable under 030 terms of your choice, provided that you also meet, for each linked 031 independent module, the terms and conditions of the license of that 032 module. An independent module is a module which is not derived from 033 or based on this library. If you modify this library, you may extend 034 this exception to your version of the library, but you are not 035 obligated to do so. If you do not wish to do so, delete this 036 exception statement from your version. */ 037 038 package javax.accessibility; 039 040 import javax.swing.text.AttributeSet; 041 042 /** 043 * Objects which present editable textual information on the display should 044 * implement this interface. Accessibility software can use the 045 * implementations of this interface to change the content, attributes, 046 * and spacial location of the text. 047 * 048 * <p>The <code>AccessibleContext.getAccessibleEditableText()</code> method 049 * should return <code>null</code> if an object does not implement this 050 * interface. 051 * 052 * @author Eric Blake (ebb9@email.byu.edu) 053 * @see Accessible 054 * @see AccessibleContext 055 * @see AccessibleContext#getAccessibleText() 056 * @see AccessibleContext#getAccessibleEditableText() 057 * @since 1.2 058 * @status updated to 1.4, except for javax.swing support 059 */ 060 public interface AccessibleEditableText extends AccessibleText 061 { 062 /** 063 * Set the text contents to the given string. 064 * 065 * @param s the new text 066 */ 067 // XXX What happens if s is null? 068 void setTextContents(String s); 069 070 /** 071 * Inserts the given string at the specified location. 072 * 073 * @param index the index for insertion 074 * @param s the new text 075 */ 076 // XXX What happens if index is out of bounds, or s is null? 077 void insertTextAtIndex(int index, String s); 078 079 /** 080 * Return the text between two points. 081 * 082 * @param start the start position, inclusive 083 * @param end the end position, exclusive 084 */ 085 // XXX What happens if indices are out of bounds? 086 String getTextRange(int start, int end); 087 088 /** 089 * Delete the text between two points. 090 * 091 * @param start the start position, inclusive 092 * @param end the end position, exclusive 093 */ 094 // XXX What happens if indices are out of bounds? 095 void delete(int start, int end); 096 097 /** 098 * Cut the text between two points to the system clipboard. 099 * 100 * @param start the start position, inclusive 101 * @param end the end position, exclusive 102 */ 103 // XXX What happens if indices are out of bounds? 104 void cut(int start, int end); 105 106 /** 107 * Paste the text from the system clipboard at the given index. 108 * 109 * @param start the start position 110 */ 111 // XXX What happens if start is out of bounds? 112 void paste(int start); 113 114 /** 115 * Replace the text between two points with the given string. 116 * 117 * @param start the start position, inclusive 118 * @param end the end position, exclusive 119 * @param s the string to paste 120 */ 121 // XXX What happens if indices are out of bounds, or s is null? 122 void replaceText(int start, int end, String s); 123 124 /** 125 * Select the text between two points. 126 * 127 * @param start the start position, inclusive 128 * @param stop the end position, exclusive 129 */ 130 // XXX What happens if indices are out of bounds? 131 void selectText(int start, int stop); 132 133 /** 134 * Set the attributes of text between two points. 135 * 136 * @param start the start position, inclusive 137 * @param end the end position, exclusive 138 * @param s the new attribute set for the range 139 */ 140 // XXX What happens if indices are out of bounds, or s is null? 141 void setAttributes(int start, int end, AttributeSet s); 142 } // interface AccessibleEditableText