Source for java.beans.DesignMode

   1: /* java.beans.DesignMode
   2:    Copyright (C) 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:  * <code>BeanContextChild</code> implementors implement this to get information about whether they are in a design time or runtime environment.
  43:  * The reason this is restricted to <code>BeanContextChild</code>ren is that
  44:  * only things in the <code>BeanContext</code> hierarchy are given this
  45:  * information in the first place.
  46:  *
  47:  * @author John Keiser
  48:  * @since JDK1.2
  49:  * @see java.beans.beancontext.BeanContextChild
  50:  */
  51: 
  52: public interface DesignMode {
  53:     /**
  54:      * Use this name when firing <code>PropertyChangeEvent</code>s from your Bean.  
  55:      * @fixme Check whether PROPERTYNAME is set to same value as Sun.
  56:      */
  57:     String PROPERTYNAME = "designTime";
  58: 
  59:     /**
  60:      * The environment will call this method on your
  61:      * <code>BeanContextChild</code> when it is registered in a parent
  62:      * <code>BeanContext</code> or when behavior needs to switch from
  63:      * design time to runtime behavior (or vice versa).
  64:      * <P>
  65:      *
  66:      * <code>BeanContext</code>s are required to fire
  67:      * <code>PropertyChangeEvent</code>s when properties change.
  68:      * <code>designTime</code> is a property, and therefore when you
  69:      * implement <code>setDesignTime()</code>, you need to fire a
  70:      * <code>PropertyChangeEvent</code> with the old value, the new
  71:      * value and using <code>PROPERTYNAME</code> as the property name.
  72:      *
  73:      * @param designTime the new value of design time,
  74:      *        <code>true</code> if it is design time,
  75:      *        <code>false</code> if it is runtime.
  76:      *
  77:      * @fixme I'm frankly not really sure whether it's the case that
  78:      *        the BeanContext can <em>change</em> the status of the Bean from
  79:      *        design time to runtime.  But it appears that it may be so.
  80:      *
  81:      * @see java.util.PropertyChangeEvent
  82:      * @see java.beans.beancontext.BeanContext
  83:      * @see #PROPERTYNAME
  84:      */
  85:     void setDesignTime(boolean designTime);
  86: 
  87:     /**
  88:      * This method should tell whether it is design time or runtime.
  89:      * @return <code>true</code> if design time, <code>false</code> if
  90:      *         runtime.
  91:      */
  92:     boolean isDesignTime();
  93: }