home *** CD-ROM | disk | FTP | other *** search
/ Best Tools for JAVA / Best Tools for JAVA.iso / JAVA_ALL / IDE / SUBARTIC / SUB_ARCT / LIB / MENU_NOT.JAV < prev    next >
Encoding:
Text File  |  1996-10-04  |  2.3 KB  |  62 lines
  1. package sub_arctic.lib;
  2.  
  3. import sub_arctic.input.event;
  4. /**
  5.  * This interface is used by the menu agent code to notify interactors
  6.  * which have popped up menus. This is used for two primary purposes:<P>
  7.  *
  8.  * First, two allow the object popping up the menu know when the menu
  9.  * interaction is completed. Second, to allow the object popping the
  10.  * menu up to implement behavior during the menu interaction which will
  11.  * affect which menus are popped up. This is primarily intended for
  12.  * use in menubars, which need to be able to change the currently
  13.  * displayed menu during the menu interaction. 
  14.  * 
  15.  * @author Ian Smith
  16.  */
  17. public interface menu_notifier extends interactor {
  18.  
  19.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  20.  
  21.   /**
  22.    * This function gets called when the interaction with a menu ends.
  23.    */
  24.   public void menu_done();
  25.  
  26.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  27.  
  28.   /**
  29.    * This function is called to alert the notifier that the interaction
  30.    * is now over their area. The notifier should return true if it
  31.    * modified the set of objects in the menu focus in response to
  32.    * this call.
  33.    *
  34.    * @param int   x   the x coordinate (in the notifiers coordinate system) of 
  35.    *                  the cursor.
  36.    * @param int   y   the y coordinate (in the notifiers coordinate system) of 
  37.    *                  the cursor.
  38.    * @param event evt the event we are testing
  39.    * @return boolean true if the notifier modified the focus set of the menu 
  40.    *                      agent in response to this
  41.    */
  42.   public boolean menu_modify(int x,int y, event evt);
  43.  
  44.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  45. }
  46. /*=========================== COPYRIGHT NOTICE ===========================
  47.  
  48. This file is part of the subArctic user interface toolkit.
  49.  
  50. Copyright (c) 1996 Scott Hudson and Ian Smith
  51. All rights reserved.
  52.  
  53. The subArctic system is freely available for most uses under the terms
  54. and conditions described in 
  55.   http://www.cc.gatech.edu/gvu/ui/sub_arctic/sub_arctic/doc/usage.html 
  56. and appearing in full in the lib/interactor.java source file.
  57.  
  58. The current release and additional information about this software can be 
  59. found starting at: http://www.cc.gatech.edu/gvu/ui/sub_arctic/
  60.  
  61. ========================================================================*/
  62.