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: import java.beans.PropertyEditor;
45:
46: /**
47: * <p>This interface extends the standard PropertyEditor interface and adds a hook to give the
48: * implementor access to the design-time context of the property being edited via the DesignProperty
49: * interface. This is useful if a PropertyEditor author wishes to display a list of instances
50: * within scope, or wishes to drill-in to the object that this property is being set on.</p>
51: *
52: * <p>NOTE: It is important to only use the passed-in DesignProperty for context purposes. This
53: * DesignProperty should not be directly manipulated, or the IDE could get into a recursive loop.</p>
54: *
55: * <P><B>IMPLEMENTED BY THE COMPONENT AUTHOR</B> - This interface is designed to be implemented by
56: * the component (bean) author.</P>
57: *
58: * @author Joe Nuxoll
59: * @version 1.0
60: */
61: public interface PropertyEditor2 extends PropertyEditor {
62:
63: /**
64: * <p>When the PropetyEditor is being invoked, the matching DesignProperty will be passed in for
65: * context. This can be used to dig into the DesignBean being edited and its surrounding context.
66: * </p>
67: *
68: * <p>NOTE: It is important to only use the passed-in DesignProperty for context purposes. This
69: * DesignProperty should not be directly manipulated, or the IDE could get into a recursive loop.
70: * </p>
71: *
72: * @param prop The DesignProperty currently being edited by this PropertyEditor2 - this may be
73: * used for context purposes only, and should not be used to manipulate the property.
74: */
75: public void setDesignProperty(DesignProperty prop);
76: }
|