Source for java.awt.dnd.DragSourceListener

   1: /* DragSourceListener.java -- listen to events during the drag
   2:    Copyright (C) 2002, 2005  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: 
  39: package java.awt.dnd;
  40: 
  41: import java.util.EventListener;
  42: 
  43: /**
  44:  * This class allows an object to listen for drag and drop events. It can
  45:  * be used to provide appropriate feedback for "drag over" actions. You can
  46:  * also use a <code>DragSourceAdapter</code> to filter the events you are
  47:  * interested in.
  48:  *
  49:  * @author Eric Blake (ebb9@email.byu.edu)
  50:  * @since 1.2
  51:  * @status updated to 1.4
  52:  */
  53: public interface DragSourceListener extends EventListener
  54: {
  55:   /**
  56:    * Called when the cursor hotspot enters a drop site which will accept the
  57:    * drag.
  58:    *
  59:    * @param e the drag source drag event
  60:    */
  61:   void dragEnter(DragSourceDragEvent e);
  62: 
  63:   /**
  64:    * Called when the cursor hotspot moves inside of a drop site which will
  65:    * accept the drag.
  66:    *
  67:    * @param e the drag source drag event
  68:    */
  69:   void dragOver(DragSourceDragEvent e);
  70: 
  71:   /**
  72:    * Called when the user modifies the drop gesture. This is often the case
  73:    * when additional mouse or key events are received during the drag.
  74:    *
  75:    * @param e the drag source drag event
  76:    */
  77:   void dropActionChanged(DragSourceDragEvent e);
  78: 
  79:   /**
  80:    * Called when the cursor hotspot moves outside of a drop site which will
  81:    * accept the drag. This could also happen if the drop site is no longer
  82:    * active, or no longer accepts the drag.
  83:    *
  84:    * @param e the drag source drag event
  85:    */
  86:   void dragExit(DragSourceEvent e);
  87: 
  88:   /**
  89:    * Called when the drag and drop operation is complete. After this event,
  90:    * <code>getDropSuccess</code> of the event is valid, and
  91:    * <code>getDropAction</code> holds the action requested by the drop site.
  92:    * Furthermore, the <code>DragSourceContext</code> is invalidated.
  93:    *
  94:    * @param e the drag source drag event
  95:    */
  96:   void dragDropEnd(DragSourceDropEvent e);
  97: } // interface DragSourceListener