Source for java.beans.DesignMode

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