01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package com.sun.rave.designtime;
43:
44: /**
45: * <P>A BeanCreateInfoSet is a group version of the BeanCreateInfo interface. It describes a
46: * single item on a Palette that will create a set of beans in a visual designer. This includes a
47: * display name, description, icon, etc. There is also (most importantly) a hook to
48: * programmatically manipulate the newly created beans immediately after they have been created.
49: * This is useful for setting the default state for the newly created set of beans.</P>
50: *
51: * <P>If the any of the specified JavaBeans have an associated DesignInfo, the DesignInfo's
52: * 'beanCreatedSetup' method will be called before the BeanCreateInfoSet's 'beansCreatedSetup' method
53: * will be called. This gives the DesignInfo the "first crack", but it ultimately gives the
54: * BeanCreateInfoSet the "last word".</P>
55: *
56: * <P><B>IMPLEMENTED BY THE COMPONENT AUTHOR</B> - This interface is designed to be implemented by
57: * the component (bean) author. The BasicBeanCreateInfoSet class can be used for convenience.</P>
58: *
59: * @author Joe Nuxoll
60: * @version 1.0
61: * @see com.sun.rave.designtime.impl.BasicBeanCreateInfoSet
62: */
63: public interface BeanCreateInfoSet extends DisplayItem {
64:
65: /**
66: * Returns an array of class names of the new JavaBeans to create when this BeanCreateInfoSet
67: * is invoked in a visual designer.
68: *
69: * @return A String[] of fully qualified class names for the JavaBeans to create.
70: */
71: public String[] getBeanClassNames();
72:
73: /**
74: * <p>A hook that gets called after the full set of JavaBean gets created. This is useful for
75: * a component author to setup an initial state for a set of JavaBeans when they are first
76: * created. Note that this method is only called one time after the JavaBeans are initially
77: * created from the palette. This is *not* a hook that is called each time the project is
78: * reopened.</p>
79: *
80: * <P>If the any of the specified JavaBeans have an associated DesignInfo, the DesignInfo's
81: * 'beanCreated' method will be called before each of the BeanCreateInfo's 'beanCreated' methods
82: * are called. Once all of the beans have been created, and the individual 'beanCreated' methods
83: * have been called, this 'beansCreated' method will be called. This gives the DesignInfo the
84: * "first crack", but it ultimately gives the BeanCreateInfoSet the "last word".</P>
85: *
86: * @param designBeans The array of DesignBean objects representing the JavaBeans that have just been
87: * created.
88: * @return A standard Result object, indicating success or failure - and optionally including
89: * messages for the user.
90: */
91: public Result beansCreatedSetup(DesignBean[] designBeans);
92: }
|