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 BeanCreateInfo describes an item on a Palette that will create a bean in a visual designer.
46: * This includes a display name, description, icon, etc. There is also (most importantly) a hook
47: * to programmatically manipulate the newly created bean immediately after is has been created.
48: * This is useful for setting a default state for the newly created bean.</P>
49: *
50: * <P>If the specified JavaBean has an associated DesignInfo, the DesignInfo's 'beanCreated'
51: * method will be called before the BeanCreateInfo's 'beanCreated' method is called. This gives the
52: * DesignInfo the "first crack", but it gives the BeanCreateInfo the "last word".</P>
53: *
54: * <P><B>IMPLEMENTED BY THE COMPONENT AUTHOR</B> - This interface is designed to be implemented by
55: * the component (bean) author. The BasicBeanCreateInfo class can be used for convenience.</P>
56: *
57: * @author Joe Nuxoll
58: * @version 1.0
59: * @see com.sun.rave.designtime.impl.BasicBeanCreateInfo
60: */
61: public interface BeanCreateInfo extends DisplayItem {
62:
63: /**
64: * Returns the class name of the new JavaBean to create when this BeanCreateInfo is invoked in
65: * a visual designer.
66: *
67: * @return The String fully qualified class name for the JavaBean to create.
68: */
69: public String getBeanClassName();
70:
71: /**
72: * <p>A hook that gets called after this JavaBean gets created initially. This is useful for a
73: * component author to setup an initial state for their JavaBean when it is first created. Note
74: * that this method is only called one time after the JavaBeans are initially created from the
75: * palette. This is *not* a hook that is called each time the project is reopened.</p>
76:
77: * <p>NOTE: If the specified bean has an associated DesignInfo class - it will have "first
78: * crack" at modifying the initial state of the bean. This method will be called after the
79: * DesignInfo one is called.</p>
80: *
81: * @return A standard Result object, indicating success or failure - and optionally including
82: * messages for the user.
83: */
84: public Result beanCreatedSetup(DesignBean designBean);
85: }
|