1 /* DocumentEvent.java -- 2 Copyright (C) 2002, 2004, 2005, 2006, Free Software Foundation, Inc. 3 4 This file is part of GNU Classpath. 5 6 GNU Classpath is free software; you can redistribute it and/or modify 7 it under the terms of the GNU General Public License as published by 8 the Free Software Foundation; either version 2, or (at your option) 9 any later version. 10 11 GNU Classpath is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with GNU Classpath; see the file COPYING. If not, write to the 18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19 02110-1301 USA. 20 21 Linking this library statically or dynamically with other modules is 22 making a combined work based on this library. Thus, the terms and 23 conditions of the GNU General Public License cover the whole 24 combination. 25 26 As a special exception, the copyright holders of this library give you 27 permission to link this library with independent modules to produce an 28 executable, regardless of the license terms of these independent 29 modules, and to copy and distribute the resulting executable under 30 terms of your choice, provided that you also meet, for each linked 31 independent module, the terms and conditions of the license of that 32 module. An independent module is a module which is not derived from 33 or based on this library. If you modify this library, you may extend 34 this exception to your version of the library, but you are not 35 obligated to do so. If you do not wish to do so, delete this 36 exception statement from your version. */ 37 38 package javax.swing.event; 39 40 import javax.swing.text.Document; 41 import javax.swing.text.Element; 42 43 /** 44 * DocumentEvent public interface 45 * @author Andrew Selkirk 46 * @author Ronald Veldema 47 */ 48 public interface DocumentEvent 49 { 50 /** 51 * ElementChange public interface 52 */ 53 public static interface ElementChange 54 { 55 /** 56 * getIndex 57 * @return int 58 */ getIndex()59 int getIndex(); 60 61 /** 62 * getElement 63 * @return Element 64 */ getElement()65 Element getElement(); 66 67 /** 68 * getChildrenRemoved 69 * @return Element[] 70 */ getChildrenRemoved()71 Element[] getChildrenRemoved(); 72 73 /** 74 * getChildrenAdded 75 * @return Element[] 76 */ getChildrenAdded()77 Element[] getChildrenAdded(); 78 79 } 80 81 /** 82 * EventType 83 */ 84 final class EventType 85 { 86 /** 87 * INSERT 88 */ 89 public static final EventType INSERT = new EventType("INSERT"); // TODO 90 91 /** 92 * REMOVE 93 */ 94 public static final EventType REMOVE = new EventType("REMOVE"); // TODO 95 96 /** 97 * CHANGE 98 */ 99 public static final EventType CHANGE = new EventType("CHANGE"); // TODO 100 101 /** 102 * typeString 103 */ 104 private String type; 105 106 /** 107 * Constructor EventType 108 * @param type TODO 109 */ EventType(String type)110 private EventType(String type) 111 { 112 this.type = type; 113 } 114 115 /** 116 * toString 117 * @return String 118 */ toString()119 public String toString() 120 { 121 return type; 122 } 123 } 124 125 /** 126 * getType 127 * @return EventType 128 */ getType()129 EventType getType(); 130 131 /** 132 * getOffset 133 * @return int 134 */ getOffset()135 int getOffset(); 136 137 /** 138 * getLength 139 * @return int 140 */ getLength()141 int getLength(); 142 143 /** 144 * getDocument 145 * @return Document 146 */ getDocument()147 Document getDocument(); 148 149 /** 150 * getChange 151 * @param element TODO 152 * @return ElementChange 153 */ getChange(Element element)154 ElementChange getChange(Element element); 155 156 } 157