blob: e867d22a15b0d56b7fb1159f9c91a31e94ca5dda [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 1998-2006 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * 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
26
27
28package java.awt.dnd;
29
30import java.util.EventListener;
31
32/**
33 * The listener interface for receiving drag gesture events.
34 * This interface is intended for a drag gesture recognition
35 * implementation. See a specification for {@code DragGestureRecognizer}
36 * for details on how to register the listener interface.
37 * Upon recognition of a drag gesture the {@code
38 * DragGestureRecognizer} calls this interface's
39 * {@link #dragGestureRecognized dragGestureRecognized()}
40 * method and passes a {@code DragGestureEvent}.
41
42 *
43 * @see java.awt.dnd.DragGestureRecognizer
44 * @see java.awt.dnd.DragGestureEvent
45 * @see java.awt.dnd.DragSource
46 */
47
48 public interface DragGestureListener extends EventListener {
49
50 /**
51 * This method is invoked by the {@code DragGestureRecognizer}
52 * when the {@code DragGestureRecognizer} detects a platform-dependent
53 * drag initiating gesture. To intiate the drag and drop operation,
54 * if approtiate, {@link DragGestureEvent#startDrag startDrag()} method on
55 * the {@code DragGestureEvent} has to be invoked.
56 * <P>
57 * @see java.awt.dnd.DragGestureRecognizer
58 * @see java.awt.dnd.DragGestureEvent
59 * @param dge the <code>DragGestureEvent</code> describing
60 * the gesture that has just occurred
61 */
62
63 void dragGestureRecognized(DragGestureEvent dge);
64}