<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<!--NewPage-->
<html>
<head>
<!-- Generated by javadoc on Wed Jul 28 01:21:15 GMT 1999 -->
<title>
  Interface java.beans.BeanInfo
</title>
</head>
<body>
<a name="_top_"></a>
<pre>
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-java.beans.html">This Package</a>  <a href="Package-java.beans.html">Previous</a>  <a href="java.beans.Customizer.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
<hr>
<h1>
  Interface java.beans.BeanInfo
</h1>
<dl>
  <dt> public interface <b>BeanInfo</b>
</dl>
A bean implementor who wishes to provide explicit information about
 their bean may provide a BeanInfo class that implements this BeanInfo
 interface and provides explicit information about the methods,
 properties, events, etc, of their  bean.
 <p>
 A bean implementor doesn't need to provide a complete set of
 explicit information.  You can pick and choose which information
 you want to provide and the rest will be obtained by automatic
 analysis using low-level reflection of the bean classes' methods
 and applying standard design patterns.
 <p>
 You get the opportunity to provide lots and lots of different
 information as part of the various XyZDescriptor classes.  But
 don't panic, you only really need to provide the minimal core
 information required by the various constructors.
 <P>
 See also the SimpleBeanInfo class which provides a convenient
 "noop" base class for BeanInfo classes, which you can override
 for those specific places where you want to return explicit info.
 <P>
 To learn about all the behaviour of a bean see the Introspector class.
<p>
<hr>
<a name="index"></a>
<h2>
  <img src="images/variable-index.gif" width=207 height=38 alt="Variable Index">
</h2>
<dl>
  <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#ICON_COLOR_16x16"><b>ICON_COLOR_16x16</b></a>
  <dd>  Constant to indicate a 16 x 16 color icon.
  <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#ICON_COLOR_32x32"><b>ICON_COLOR_32x32</b></a>
  <dd>  Constant to indicate a 32 x 32 color icon.
  <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#ICON_MONO_16x16"><b>ICON_MONO_16x16</b></a>
  <dd>  Constant to indicate a 16 x 16 monochrome icon.
  <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#ICON_MONO_32x32"><b>ICON_MONO_32x32</b></a>
  <dd>  Constant to indicate a 32 x 32 monochrome icon.
</dl>
<h2>
  <img src="images/method-index.gif" width=207 height=38 alt="Method Index">
</h2>
<dl>
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#getAdditionalBeanInfo()"><b>getAdditionalBeanInfo</b></a>()
  <dd>  This method allows a BeanInfo object to return an arbitrary collection
 of other BeanInfo objects that provide additional information on the
 current bean.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#getBeanDescriptor()"><b>getBeanDescriptor</b></a>()
  <dd>  
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#getDefaultEventIndex()"><b>getDefaultEventIndex</b></a>()
  <dd>  A bean may have a "default" event that is the event that will
 mostly commonly be used by human's when using the bean.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#getDefaultPropertyIndex()"><b>getDefaultPropertyIndex</b></a>()
  <dd>  A bean may have a "default" property that is the property that will
 mostly commonly be initially chosen for update by human's who are 
 customizing the bean.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#getEventSetDescriptors()"><b>getEventSetDescriptors</b></a>()
  <dd>  
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#getIcon(int)"><b>getIcon</b></a>(int)
  <dd>  This method returns an image object that can be used to
 represent the bean in toolboxes, toolbars, etc.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#getMethodDescriptors()"><b>getMethodDescriptors</b></a>()
  <dd>  
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#getPropertyDescriptors()"><b>getPropertyDescriptors</b></a>()
  <dd>  
</dl>
<a name="variables"></a>
<h2>
  <img src="images/variables.gif" width=153 height=38 alt="Variables">
</h2>
<a name="ICON_COLOR_16x16"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
<b>ICON_COLOR_16x16</b>
<pre>
 public static final int ICON_COLOR_16x16
</pre>
<dl>
  <dd> Constant to indicate a 16 x 16 color icon.<p>
</dl>
<a name="ICON_COLOR_32x32"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
<b>ICON_COLOR_32x32</b>
<pre>
 public static final int ICON_COLOR_32x32
</pre>
<dl>
  <dd> Constant to indicate a 32 x 32 color icon.<p>
</dl>
<a name="ICON_MONO_16x16"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
<b>ICON_MONO_16x16</b>
<pre>
 public static final int ICON_MONO_16x16
</pre>
<dl>
  <dd> Constant to indicate a 16 x 16 monochrome icon.<p>
</dl>
<a name="ICON_MONO_32x32"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
<b>ICON_MONO_32x32</b>
<pre>
 public static final int ICON_MONO_32x32
</pre>
<dl>
  <dd> Constant to indicate a 32 x 32 monochrome icon.<p>
</dl>
<a name="methods"></a>
<h2>
  <img src="images/methods.gif" width=151 height=38 alt="Methods">
</h2>
<a name="getBeanDescriptor()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getBeanDescriptor"><b>getBeanDescriptor</b></a>
<pre>
 public abstract <a href="java.beans.BeanDescriptor.html#_top_">BeanDescriptor</a> getBeanDescriptor()
</pre>
<dl>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> A BeanDescriptor providing overall information about
 the bean, such as its displayName, its customizer, etc.  May
 return null if the information should be obtained by automatic
 analysis.
  </dl></dd>
</dl>
<a name="getEventSetDescriptors()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getEventSetDescriptors"><b>getEventSetDescriptors</b></a>
<pre>
 public abstract <a href="java.beans.EventSetDescriptor.html#_top_">EventSetDescriptor</a>[] getEventSetDescriptors()
</pre>
<dl>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> An array of EventSetDescriptors describing the kinds of
 events fired by this bean.  May return null if the information
 should be obtained by automatic analysis.
  </dl></dd>
</dl>
<a name="getDefaultEventIndex()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getDefaultEventIndex"><b>getDefaultEventIndex</b></a>
<pre>
 public abstract int getDefaultEventIndex()
</pre>
<dl>
  <dd> A bean may have a "default" event that is the event that will
 mostly commonly be used by human's when using the bean.
<p>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> Index of default event in the EventSetDescriptor array
		returned by getEventSetDescriptors.
 <P>	Returns -1 if there is no default event.
  </dl></dd>
</dl>
<a name="getPropertyDescriptors()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getPropertyDescriptors"><b>getPropertyDescriptors</b></a>
<pre>
 public abstract <a href="java.beans.PropertyDescriptor.html#_top_">PropertyDescriptor</a>[] getPropertyDescriptors()
</pre>
<dl>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> An array of PropertyDescriptors describing the editable
 properties supported by this bean.  May return null if the
 information should be obtained by automatic analysis.
 <p>
 If a property is indexed, then its entry in the result array will
 belong to the IndexedPropertyDescriptor subclass of PropertyDescriptor.
 A client of getPropertyDescriptors can use "instanceof" to check
 if a given PropertyDescriptor is an IndexedPropertyDescriptor.
  </dl></dd>
</dl>
<a name="getDefaultPropertyIndex()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getDefaultPropertyIndex"><b>getDefaultPropertyIndex</b></a>
<pre>
 public abstract int getDefaultPropertyIndex()
</pre>
<dl>
  <dd> A bean may have a "default" property that is the property that will
 mostly commonly be initially chosen for update by human's who are 
 customizing the bean.
<p>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> Index of default property in the PropertyDescriptor array
 		returned by getPropertyDescriptors.
 <P>	Returns -1 if there is no default property.
  </dl></dd>
</dl>
<a name="getMethodDescriptors()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getMethodDescriptors"><b>getMethodDescriptors</b></a>
<pre>
 public abstract <a href="java.beans.MethodDescriptor.html#_top_">MethodDescriptor</a>[] getMethodDescriptors()
</pre>
<dl>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> An array of MethodDescriptors describing the externally
 visible methods supported by this bean.  May return null if
 the information should be obtained by automatic analysis.
  </dl></dd>
</dl>
<a name="getAdditionalBeanInfo()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getAdditionalBeanInfo"><b>getAdditionalBeanInfo</b></a>
<pre>
 public abstract <a href="#_top_">BeanInfo</a>[] getAdditionalBeanInfo()
</pre>
<dl>
  <dd> This method allows a BeanInfo object to return an arbitrary collection
 of other BeanInfo objects that provide additional information on the
 current bean.
 <P>
 If there are conflicts or overlaps between the information provided
 by different BeanInfo objects, then the current BeanInfo takes precedence
 over the getAdditionalBeanInfo objects, and later elements in the array
 take precedence over earlier ones.
<p>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> an array of BeanInfo objects.  May return null.
  </dl></dd>
</dl>
<a name="getIcon(int)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getIcon"><b>getIcon</b></a>
<pre>
 public abstract <a href="java.awt.Image.html#_top_">Image</a> getIcon(int iconKind)
</pre>
<dl>
  <dd> This method returns an image object that can be used to
 represent the bean in toolboxes, toolbars, etc.   Icon images
 will typically be GIFs, but may in future include other formats.
 <p>
 Beans aren't required to provide icons and may return null from
 this method.
 <p>
 There are four possible flavors of icons (16x16 color,
 32x32 color, 16x16 mono, 32x32 mono).  If a bean choses to only
 support a single icon we recommend supporting 16x16 color.
 <p>
 We recommend that icons have a "transparent" background
 so they can be rendered onto an existing background.
<p>
  <dd><dl>
    <dt> <b>Parameters:</b>
    <dd> iconKind - The kind of icon requested.  This should be
    one of the constant values ICON_COLOR_16x16, ICON_COLOR_32x32, 
    ICON_MONO_16x16, or ICON_MONO_32x32.
    <dt> <b>Returns:</b>
    <dd> An image object representing the requested icon.  May
    return null if no suitable icon is available.
  </dl></dd>
</dl>
<hr>
<pre>
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-java.beans.html">This Package</a>  <a href="Package-java.beans.html">Previous</a>  <a href="java.beans.Customizer.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
</body>
</html>
