01 /*
02 * Copyright 1998-2001 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25 package javax.swing.event;
26
27 import java.util.EventObject;
28
29 /**
30 * CaretEvent is used to notify interested parties that
31 * the text caret has changed in the event source.
32 * <p>
33 * <strong>Warning:</strong>
34 * Serialized objects of this class will not be compatible with
35 * future Swing releases. The current serialization support is
36 * appropriate for short term storage or RMI between applications running
37 * the same version of Swing. As of 1.4, support for long term storage
38 * of all JavaBeans<sup><font size="-2">TM</font></sup>
39 * has been added to the <code>java.beans</code> package.
40 * Please see {@link java.beans.XMLEncoder}.
41 *
42 * @version 1.20 05/05/07
43 * @author Timothy Prinzing
44 */
45 public abstract class CaretEvent extends EventObject {
46
47 /**
48 * Creates a new CaretEvent object.
49 *
50 * @param source the object responsible for the event
51 */
52 public CaretEvent(Object source) {
53 super (source);
54 }
55
56 /**
57 * Fetches the location of the caret.
58 *
59 * @return the dot >= 0
60 */
61 public abstract int getDot();
62
63 /**
64 * Fetches the location of other end of a logical
65 * selection. If there is no selection, this
66 * will be the same as dot.
67 *
68 * @return the mark >= 0
69 */
70 public abstract int getMark();
71 }
|