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:
42: package org.netbeans.spi.viewmodel;
43:
44: /**
45: * Provides display name, icon and tooltip value for some type of objects.
46: * Designed to be used with {@link TreeModel}.
47: *
48: * @author Jan Jancura
49: */
50: public interface NodeModel extends Model {
51:
52: /**
53: * Returns display name for given node.
54: *
55: * @return display name for given node
56: */
57: public abstract String getDisplayName(Object node)
58: throws UnknownTypeException;
59:
60: /**
61: * Returns icon for given node.
62: *
63: * @throws UnknownTypeException if this NodeModel implementation is not
64: * able to resolve icon for given node type
65: * @return icon for given node
66: */
67: public abstract String getIconBase(Object node)
68: throws UnknownTypeException;
69:
70: /**
71: * Returns tooltip for given node.
72: *
73: * @throws UnknownTypeException if this NodeModel implementation is not
74: * able to resolve tooltip for given node type
75: * @return tooltip for given node
76: */
77: public abstract String getShortDescription(Object node)
78: throws UnknownTypeException;
79:
80: /**
81: * Registers given listener.
82: *
83: * @param l the listener to add
84: */
85: public abstract void addModelListener(ModelListener l);
86:
87: /**
88: * Unregisters given listener.
89: *
90: * @param l the listener to remove
91: */
92: public abstract void removeModelListener(ModelListener l);
93: }
|