KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > spi > viewmodel > NodeModel


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.spi.viewmodel;
21
22
23 /**
24  * Provides display name, icon and tooltip value for some type of objects.
25  * Designed to be used with {@link TreeModel}.
26  *
27  * @author Jan Jancura
28  */
29 public interface NodeModel extends Model {
30
31     /**
32      * Returns display name for given node.
33      *
34      * @return display name for given node
35      */
36     public abstract String JavaDoc getDisplayName (Object JavaDoc node)
37     throws UnknownTypeException;
38
39     /**
40      * Returns icon for given node.
41      *
42      * @throws UnknownTypeException if this NodeModel implementation is not
43      * able to resolve icon for given node type
44      * @return icon for given node
45      */
46     public abstract String JavaDoc getIconBase (Object JavaDoc node)
47     throws UnknownTypeException;
48     
49     /**
50      * Returns tooltip for given node.
51      *
52      * @throws UnknownTypeException if this NodeModel implementation is not
53      * able to resolve tooltip for given node type
54      * @return tooltip for given node
55      */
56     public abstract String JavaDoc getShortDescription (Object JavaDoc node)
57     throws UnknownTypeException;
58
59     /**
60      * Registers given listener.
61      *
62      * @param l the listener to add
63      */
64     public abstract void addModelListener (ModelListener l);
65
66     /**
67      * Unregisters given listener.
68      *
69      * @param l the listener to remove
70      */
71     public abstract void removeModelListener (ModelListener l);
72 }
73
Popular Tags