KickJava   Java API By Example, From Geeks To Geeks.

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


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  * Filters content of some existing {@link NodeModel}. You can change display
25  * name, tooltip, or icon for some existing object here.
26  *
27  * @author Jan Jancura
28  */
29 public interface NodeModelFilter extends Model {
30
31     /**
32      * Returns filterred display name for given node. You should not
33      * throw UnknownTypeException directly from this method!
34      *
35      * @throws UnknownTypeException this exception can be thrown from
36      * <code>original.getDisplayName (...)</code> method call only!
37      * @return display name for given node
38      */
39     public abstract String JavaDoc getDisplayName (NodeModel original, Object JavaDoc node)
40     throws UnknownTypeException;
41     
42     /**
43      * Returns filterred icon for given node. You should not throw
44      * UnknownTypeException directly from this method!
45      *
46      * @throws UnknownTypeException this exception can be thrown from
47      * <code>original.getIconBase (...)</code> method call only!
48      * @return icon for given node
49      */
50     public abstract String JavaDoc getIconBase (NodeModel original, Object JavaDoc node)
51     throws UnknownTypeException;
52     
53     /**
54      * Returns filterred tooltip for given node. You should not throw
55      * UnknownTypeException directly from this method!
56      *
57      * @throws UnknownTypeException this exception can be thrown from
58      * <code>original.getShortDescription (...)</code> method call only!
59      * @return tooltip for given node
60      */
61     public abstract String JavaDoc getShortDescription (NodeModel original, Object JavaDoc node)
62     throws UnknownTypeException;
63
64
65     /**
66      * Registers given listener.
67      *
68      * @param l the listener to add
69      */
70     public abstract void addModelListener (ModelListener l);
71
72     /**
73      * Unregisters given listener.
74      *
75      * @param l the listener to remove
76      */
77     public abstract void removeModelListener (ModelListener l);
78 }
79
Popular Tags