Source for java.beans.Visibility

   1: /* java.beans.Visibility
   2:    Copyright (C) 1998, 1999 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.beans;
  40: 
  41: /**
  42:  * Visibility is an interface a Bean may implement so that the environment
  43:  * can tell the Bean whether there is a GUI or not, and so that the Bean
  44:  * can tell the environment whether it needs one or can run without one.
  45:  * <P>
  46:  *
  47:  * Sun decided not to use standard Introspection patterns so that these
  48:  * methods did not get included when the Introspector made its sweep on
  49:  * the class.
  50:  *
  51:  * @author John Keiser
  52:  * @since JDK1.1
  53:  * @version 1.1.0, 29 Jul 1998
  54:  */
  55: 
  56: public interface Visibility {
  57:     /**
  58:      * Tells whether the Bean can run without a GUI or not.
  59:      * @return false if Bean can run without a GUI, else true.
  60:      */
  61:     boolean needsGui();
  62: 
  63:     /**
  64:      * Tells whether Bean is trying not to use the GUI.
  65:      * If needsGui() is true, this method should always return false.
  66:      * @return true if definitely not using GUI, otherwise false.
  67:      */
  68:     boolean avoidingGui();
  69: 
  70:     /**
  71:      * Tells the Bean not to use GUI methods.
  72:      * If needsGUI() is false, then after this method is called,
  73:      * avoidingGui() should return true.
  74:      */
  75:     void dontUseGui();
  76: 
  77:     /**
  78:      * Tells the Bean it may use the GUI.
  79:      * The Bean is not required to use the GUI in this case, it is
  80:      * merely being <EM>permitted</EM> to use it.  If needsGui() is
  81:      * false, avoidingGui() may return true or false after this method
  82:      * is called.
  83:      */
  84:     void okToUseGui();
  85: }