home *** CD-ROM | disk | FTP | other *** search
/ Best Tools for JAVA / Best Tools for JAVA.iso / JAVA_ALL / IDE / SUBARTIC / SUB_ARCT / INPUT / DISPLAY_.JAV < prev    next >
Encoding:
Text File  |  1996-10-04  |  2.3 KB  |  55 lines
  1. package sub_arctic.input;
  2.  
  3. /**
  4.  * This input protocol is used to display help messages on the screen
  5.  * when an object has the mouse over it for some period of time.
  6.  * If you are considering implementing this interface, you should
  7.  * probably be sure to examine the display_help_container class
  8.  * in the lib package.<p>
  9.  *
  10.  * <STRONG>Warning</STRONG>: This protocol is based on the various mouse
  11.  * events that are dispatched by the system. If you modify an interface
  12.  * based on other types of events (e.g. animation), the display_help
  13.  * interface's help_close() call will not be made immediately. In particular,
  14.  * such a call will not be made until the next mouse event is processed.
  15.  *
  16.  * @author Ian Smith
  17.  */
  18. public interface display_help extends pointable {
  19.   /**
  20.    * This method is called to inform the object that the help text
  21.    * should be displayed now. This not called in response
  22.    * to an event, nor is there a way to claim that this is successfully
  23.    * dispatched, since no event is being processed. In particular,
  24.    * this method only gets called when the system is <STRONG>not</STRONG>
  25.    * not receiving mouse input (i.e. the user is not moving
  26.    * the mouse).
  27.    */
  28.   public void help_open(); //xx this *MUST* have an event and user_info added
  29.  
  30.   /**
  31.    * This method is called to inform the object that the help text
  32.    * should not be displayed any longer. Although this method is
  33.    * called in response to a user input, the display_help container
  34.    * cannot "dispatch" this event in the normal sense, since it
  35.    * is likely that other agents may have handled this event.
  36.    */
  37.   public void help_close(event evt); //xx need user_info
  38. }
  39. /*=========================== COPYRIGHT NOTICE ===========================
  40.  
  41. This file is part of the subArctic user interface toolkit.
  42.  
  43. Copyright (c) 1996 Scott Hudson and Ian Smith
  44. All rights reserved.
  45.  
  46. The subArctic system is freely available for most uses under the terms
  47. and conditions described in 
  48.   http://www.cc.gatech.edu/gvu/ui/sub_arctic/sub_arctic/doc/usage.html 
  49. and appearing in full in the lib/interactor.java source file.
  50.  
  51. The current release and additional information about this software can be 
  52. found starting at: http://www.cc.gatech.edu/gvu/ui/sub_arctic/
  53.  
  54. ========================================================================*/
  55.