home *** CD-ROM | disk | FTP | other *** search
/ Best Tools for JAVA / Best Tools for JAVA.iso / JAVA_ALL / IDE / SUBARTIC / SUB_ARCT / INPUT / INOUT_DR.JAV < prev    next >
Encoding:
Text File  |  1996-10-04  |  3.5 KB  |  97 lines
  1.  
  2. package sub_arctic.input;
  3.  
  4. import sub_arctic.lib.interactor;
  5.  
  6. /** 
  7.  * Input protocol for objects wishing to drag drag into and out of their
  8.  * bounds.  
  9.  *
  10.  * @see sub_arctic.input.inout_drag_agent
  11.  * @author Scott Hudson
  12.  */
  13. public interface inout_draggable extends focusable, interactor {
  14.  
  15.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  16.  
  17.   /** Dispatch input corresponding to the start of an inout tracking drag. 
  18.    *  The boolean parameter is passed as true if the drag starts inside the 
  19.    *  object.  Returns true if the drag is accepted (and hence the event 
  20.    *  consumed).<p>
  21.    *
  22.    * @param  event    evt           the event associated with the start of drag.
  23.    * @param  boolean  starts_inside does the mouse start inside the object.
  24.    * @param  Object   ui            user info that was passed in when the 
  25.    *                                object was picked.
  26.    */
  27.   public boolean inout_drag_start(
  28.     event    evt, 
  29.     boolean  starts_inside, 
  30.     Object   ui);
  31.  
  32.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  33.  
  34.   /** Dispatch "drag" into the bounds of the object.  Returns true if the 
  35.    *  input is accepted (and hence the event consumed).<p>
  36.    *
  37.    * @param  event    evt           the event associated with the start of drag.
  38.    * @param  Object   ui            user info that was passed in when the 
  39.    *                                object was picked.
  40.    */
  41.   public boolean inout_drag_enter(event evt, Object user_info);
  42.  
  43.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  44.  
  45.   /** Dispatch "drag" out of the bounds of the object.  Returns true if the 
  46.    *  input is accepted (and hence the event consumed).<p>
  47.    *
  48.    * @param  event    evt           the event associated with the start of drag.
  49.    * @param  Object   ui            user info that was passed in when the 
  50.    *                                object was picked.
  51.    */
  52.   public boolean inout_drag_exit(event evt, Object user_info);
  53.  
  54.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  55.  
  56.   /** Dispatch input corresponding to the end of an inout drag.  The boolean
  57.    *  parameter is passes as true if the drag ended inside the object, false
  58.    *  otherwise.  This routine should return true if the input was accepted
  59.    *  (and hence the event consumed).<p>
  60.    *
  61.    * @param  event    evt           the event associated with the start of drag.
  62.    * @param  boolean  starts_inside does the mouse start inside the object.
  63.    * @param  Object   ui            user info that was passed in when the 
  64.    *                                object was picked.
  65.    */
  66.   public boolean inout_drag_end(
  67.     event   evt, 
  68.     boolean ended_inside, 
  69.     Object  user_info);
  70.  
  71.    //had:
  72.    //* @exception general 
  73.  
  74.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  75. }
  76.  
  77.  
  78.  
  79.  
  80.  
  81. /*=========================== COPYRIGHT NOTICE ===========================
  82.  
  83. This file is part of the subArctic user interface toolkit.
  84.  
  85. Copyright (c) 1996 Scott Hudson and Ian Smith
  86. All rights reserved.
  87.  
  88. The subArctic system is freely available for most uses under the terms
  89. and conditions described in 
  90.   http://www.cc.gatech.edu/gvu/ui/sub_arctic/sub_arctic/doc/usage.html 
  91. and appearing in full in the lib/interactor.java source file.
  92.  
  93. The current release and additional information about this software can be 
  94. found starting at: http://www.cc.gatech.edu/gvu/ui/sub_arctic/
  95.  
  96. ========================================================================*/
  97.