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: /*
43: * RenderDataProvider.java
44: *
45: * Created on January 29, 2004, 12:01 AM
46: */
47:
48: package org.netbeans.swing.outline;
49:
50: import java.awt.Color;
51: import javax.swing.Icon;
52:
53: /** A class which can provide rendering data for the tree portion an Outline,
54: * such as converting values to text, providing tooltip text and icons.
55: * Makes it possible to provide most of the interesting data that affects
56: * display without needing to provide a custom cell renderer. An Outline
57: * will use its RenderDataProvider to fetch data for <strong>all</strong>
58: * its columns, so it is possible to affect the display of both property
59: * columns and the tree column via this interface.
60: *
61: * @author Tim Boudreau
62: */
63: public interface RenderDataProvider {
64: /** Convert an object in the tree to the string that should be used to
65: * display its node */
66: public String getDisplayName(Object o);
67:
68: /** Returns true of the display name for this object should use HTML
69: * rendering (future support for integration of the lightweight HTML
70: * renderer into NetBeans). */
71: public boolean isHtmlDisplayName(Object o);
72:
73: /** Get the background color to be used for rendering this node. Return
74: * null if the standard table background or selected color should be used.
75: */
76: public Color getBackground(Object o);
77:
78: /** Get the foreground color to be used for rendering this node. Return
79: * null if the standard table foreground or selected foreground should be
80: * used. */
81: public Color getForeground(Object o);
82:
83: /** Get a description for this object suitable for use in a tooltip. Return
84: * null if no tooltip is desired. */
85: public String getTooltipText(Object o);
86:
87: /** Get an icon to be used for this object. Return null if the look and
88: * feel's default tree folder/leaf icons should be used as appropriate. */
89: public Icon getIcon(Object o);
90: }
|