1/*
2 * Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25package javax.swing.event;
26
27import java.util.EventObject;
28
29
30/**
31 * CaretEvent is used to notify interested parties that
32 * the text caret has changed in the event source.
33 * <p>
34 * <strong>Warning:</strong>
35 * Serialized objects of this class will not be compatible with
36 * future Swing releases. The current serialization support is
37 * appropriate for short term storage or RMI between applications running
38 * the same version of Swing.  As of 1.4, support for long term storage
39 * of all JavaBeans&trade;
40 * has been added to the <code>java.beans</code> package.
41 * Please see {@link java.beans.XMLEncoder}.
42 *
43 * @author  Timothy Prinzing
44 */
45@SuppressWarnings("serial") // Same-version serialization only
46public abstract class CaretEvent extends EventObject {
47
48    /**
49     * Creates a new CaretEvent object.
50     *
51     * @param source the object responsible for the event
52     */
53    public CaretEvent(Object source) {
54        super(source);
55    }
56
57    /**
58     * Fetches the location of the caret.
59     *
60     * @return the dot &gt;= 0
61     */
62    public abstract int getDot();
63
64    /**
65     * Fetches the location of other end of a logical
66     * selection.  If there is no selection, this
67     * will be the same as dot.
68     *
69     * @return the mark &gt;= 0
70     */
71    public abstract int getMark();
72}
73