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-2006 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: package org.openide.explorer.propertysheet.editors;
42:
43: import java.awt.Component;
44:
45: /** Enhances standard property editor to support in-place custom editors and tagged values.
46: * <strong>Use of this class is strongly discouraged</strong> - the original
47: * NetBeans property sheet did not specify a strong contract for when the
48: * property should be updated from an editor such as the custom inplace editor
49: * this interface allows you to provide. The new (NetBeans 4.0 and later)
50: * property sheet does specify such a contract, and the InplaceEditor
51: * interface exists to allow it to be fulfilled.
52: * @author Jan Jancura, Ian Formanek
53: * @deprecated Instead of this class, implement ExPropertyEditor and InplaceEditor.Factory. Also
54: * create an implementation of InplaceEditor for the custom inline editor.
55: * In the <code>attachEnv()</code> method of your ExPropertyEditor, call
56: * <code>PropertyEnv.registerInplaceEditorFactory(this)</code>. <p><strong>
57: * Before you do any of this</strong> read the prose documentation on the
58: * Explorer API and be sure you cannot do what you need with an existing
59: * property editor - it is very rare to actually need to provide a custom
60: * editor component.
61: * @see org.openide.explorer.propertysheet.InplaceEditor
62: * @see org.openide.explorer.propertysheet.InplaceEditor.Factory
63: * @see org.openide.explorer.propertysheet.PropertyEnv
64: */
65: public @Deprecated
66: interface EnhancedPropertyEditor extends java.beans.PropertyEditor {
67: /** Get an in-place editor.
68: * @return a custom property editor to be shown inside the property
69: * sheet
70: */
71: public Component getInPlaceCustomEditor();
72:
73: /** Test for support of in-place custom editors.
74: * @return <code>true</code> if supported
75: */
76: public boolean hasInPlaceCustomEditor();
77:
78: /** Test for support of editing of tagged values.
79: * Must also accept custom strings, otherwise you may may specify a standard property editor accepting only tagged values.
80: * @return <code>true</code> if supported
81: */
82: public boolean supportsEditingTaggedValues();
83: }
|