1 /* DocumentEvent.java --
2    Copyright (C) 2002, 2004 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., 59 Temple Place, Suite 330, Boston, MA
19 02111-1307 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 	// Classes ----------------------------------------------------
52 	//-------------------------------------------------------------
53 
54 	/**
55 	 * ElementChange public interface
56 	 */
57 	public interface ElementChange {
58 
59 		//-------------------------------------------------------------
60 		// Methods ----------------------------------------------------
61 		//-------------------------------------------------------------
62 
63 		/**
64 		 * getIndex
65 		 * @returns int
66 		 */
getIndex()67 		int getIndex();
68 
69 		/**
70 		 * getElement
71 		 * @returns Element
72 		 */
getElement()73 		Element getElement();
74 
75 		/**
76 		 * getChildrenRemoved
77 		 * @returns Element[]
78 		 */
getChildrenRemoved()79 		Element[] getChildrenRemoved();
80 
81 		/**
82 		 * getChildrenAdded
83 		 * @returns Element[]
84 		 */
getChildrenAdded()85 		Element[] getChildrenAdded();
86 
87 
88 	} // ElementChange
89 
90 	/**
91 	 * EventType
92 	 */
93 	class EventType {
94 
95 		//-------------------------------------------------------------
96 		// Variables --------------------------------------------------
97 		//-------------------------------------------------------------
98 
99 		/**
100 		 * INSERT
101 		 */
102 		EventType INSERT = new EventType("INSERT"); // TODO
103 
104 		/**
105 		 * REMOVE
106 		 */
107 		EventType REMOVE = new EventType("REMOVE"); // TODO
108 
109 		/**
110 		 * CHANGE
111 		 */
112 		EventType CHANGE = new EventType("CHANGE"); // TODO
113 
114 		/**
115 		 * typeString
116 		 */
117 		private String type;
118 
119 
120 		//-------------------------------------------------------------
121 		// Initialization ---------------------------------------------
122 		//-------------------------------------------------------------
123 
124 		/**
125 		 * Constructor EventType
126 		 * @param type TODO
127 		 */
EventType(String type)128 		private EventType(String type) {
129 			this.type = type;
130 		} // EventType()
131 
132 
133 		//-------------------------------------------------------------
134 		// Methods ----------------------------------------------------
135 		//-------------------------------------------------------------
136 
137 		/**
138 		 * toString
139 		 * @returns String
140 		 */
toString()141 		public String toString() {
142 			return type; // TODO
143 		} // toString()
144 
145 
146 	} // EventType
147 
148 
149 	//-------------------------------------------------------------
150 	// Methods ----------------------------------------------------
151 	//-------------------------------------------------------------
152 
153 	/**
154 	 * getType
155 	 * @returns EventType
156 	 */
getType()157 	EventType getType();
158 
159 	/**
160 	 * getOffset
161 	 * @returns int
162 	 */
getOffset()163 	int getOffset();
164 
165 	/**
166 	 * getLength
167 	 * @returns int
168 	 */
getLength()169 	int getLength();
170 
171 	/**
172 	 * getDocument
173 	 * @returns Document
174 	 */
getDocument()175 	Document getDocument();
176 
177 	/**
178 	 * getChange
179 	 * @param element TODO
180 	 * @returns ElementChange
181 	 */
getChange(Element element)182 	ElementChange getChange(Element element);
183 
184 
185 } // DocumentEvent
186