home *** CD-ROM | disk | FTP | other *** search
/ Best Tools for JAVA / Best Tools for JAVA.iso / JAVA_ALL / IDE / SUBARTIC / SUB_ARCT / INPUT / FOCUSABL.JAV < prev    next >
Encoding:
Text File  |  1996-10-04  |  2.6 KB  |  69 lines
  1.  
  2. package sub_arctic.input;
  3.  
  4. /** 
  5.  * Input protocol interface for objects which are to be informed of entry to 
  6.  * and exit from a focus set.  This protocol serves as a base interface which
  7.  * all focus based dispatch protocols inherit from.  Note: because many focus
  8.  * based protocols actually override the use of these methods with something
  9.  * more specific (i.e. they deliver the same inputs using other more specific
  10.  * methods), these methods have been implemented in base_interactor and are 
  11.  * by default ignored.  
  12.  *
  13.  * @author Scott Hudson
  14.  */
  15. public interface focusable {
  16.  
  17.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  18.  
  19.   /** 
  20.    * Inform the object that it has entered the focus set of the given 
  21.    * dispatch agent. <p>
  22.    * 
  23.    * @param event                cause_evt the event that caused the focus.
  24.    * @param focus_dispatch_agent of_agent  the agent doing the focus.
  25.    * @param Object               user_info uninterpreted information that was
  26.    *                                       given to the agent when the focus
  27.    *                                       was established.
  28.    */
  29.   public void focus_set_enter(
  30.     event                cause_evt, 
  31.     focus_dispatch_agent of_agent, 
  32.     Object               user_info);
  33.   
  34.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  35.  
  36.   /** 
  37.    * Inform the object that it has left the focus set of the given 
  38.    * dispatch agent. <p>
  39.    * 
  40.    * @param event                cause_evt the event that caused this.
  41.    * @param focus_dispatch_agent of_agent  the agent doing the this.
  42.    * @param Object               user_info uninterpreted information that was
  43.    *                                       given to the agent when the focus
  44.    *                                       was established.
  45.    */
  46.   public void focus_set_exit(
  47.     event                cause_evt, 
  48.     focus_dispatch_agent of_agent,
  49.     Object               user_info);
  50.  
  51.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  52. }
  53. /*=========================== COPYRIGHT NOTICE ===========================
  54.  
  55. This file is part of the subArctic user interface toolkit.
  56.  
  57. Copyright (c) 1996 Scott Hudson and Ian Smith
  58. All rights reserved.
  59.  
  60. The subArctic system is freely available for most uses under the terms
  61. and conditions described in 
  62.   http://www.cc.gatech.edu/gvu/ui/sub_arctic/sub_arctic/doc/usage.html 
  63. and appearing in full in the lib/interactor.java source file.
  64.  
  65. The current release and additional information about this software can be 
  66. found starting at: http://www.cc.gatech.edu/gvu/ui/sub_arctic/
  67.  
  68. ========================================================================*/
  69.