1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
/* * @(#)BeanInfo.java 1.29 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.beans; /** * 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. */ public interface BeanInfo { /** * Gets the beans <code>BeanDescriptor</code>. * * @return 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. */ BeanDescriptor getBeanDescriptor(); /** * Gets the beans <code>EventSetDescriptor</code>s. * * @return 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. */ EventSetDescriptor[] getEventSetDescriptors(); /** * A bean may have a "default" event that is the event that will * mostly commonly be used by humans when using the bean. * @return Index of default event in the EventSetDescriptor array * returned by getEventSetDescriptors. * <P> Returns -1 if there is no default event. */ int getDefaultEventIndex(); /** * Gets the beans <code>PropertyDescriptor</code>s. * * @return 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. */ PropertyDescriptor[] getPropertyDescriptors(); /** * 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. * @return Index of default property in the PropertyDescriptor array * returned by getPropertyDescriptors. * <P> Returns -1 if there is no default property. */ int getDefaultPropertyIndex(); /** * Gets the beans <code>MethodDescriptor</code>s. * * @return 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. */ MethodDescriptor[] getMethodDescriptors(); /** * 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. * * @return an array of BeanInfo objects. May return null. */ BeanInfo[] getAdditionalBeanInfo(); /** * 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. * * @param 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. * @return An image object representing the requested icon. May * return null if no suitable icon is available. */ java.awt.Image getIcon(int iconKind); /** * Constant to indicate a 16 x 16 color icon. */ final static int ICON_COLOR_16x16 = 1; /** * Constant to indicate a 32 x 32 color icon. */ final static int ICON_COLOR_32x32 = 2; /** * Constant to indicate a 16 x 16 monochrome icon. */ final static int ICON_MONO_16x16 = 3; /** * Constant to indicate a 32 x 32 monochrome icon. */ final static int ICON_MONO_32x32 = 4; }