← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to projects/projectuiapi/src/org/netbeans/spi/project/ui/support/NodeList.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
projects/projectuiapi/src/org/netbeans/spi/project/ui/support/NodeList.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "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.project.ui.support;
 
43
 
 
44
import java.util.List;
 
45
import javax.swing.event.ChangeListener;
 
46
import org.openide.nodes.Node;
 
47
 
 
48
/**
 
49
 * Represents a series of nodes which can be spliced into a children list.
 
50
 * @param K the type of key you would like to use to represent nodes
 
51
 * @author mkleint
 
52
 * @since org.netbeans.modules.projectuiapi/1 1.18
 
53
 * @see NodeFactory
 
54
 * @see NodeFactorySupport
 
55
 * @see org.openide.nodes.Children.Keys
 
56
 */
 
57
public interface NodeList<K> {
 
58
    /**
 
59
     * Obtains child keys which will be passed to {@link #node}.
 
60
     * If there is a change in the set of keys based on external events,
 
61
     * fire a <code>ChangeEvent</code>.
 
62
     * @return list of zero or more keys to display
 
63
     */
 
64
    List<K> keys();
 
65
    /**
 
66
     * Adds a listener to a change in keys.
 
67
     * @param l a listener to add
 
68
     */
 
69
    void addChangeListener(ChangeListener l);
 
70
    /**
 
71
     * Removes a change listener.
 
72
     * @param l a listener to remove
 
73
     */
 
74
    void removeChangeListener(ChangeListener l);
 
75
    /**
 
76
     * Creates a node for a given key.
 
77
     * @param key a key which was included in {@link #keys}
 
78
     * @return a node which should represent that key visually
 
79
     */
 
80
    Node node(K key);
 
81
    /**
 
82
     * Called when the node list is to be active. Equivalent to {@link org.openide.nodes.Children#addNotify}.
 
83
     * If there is any need to register listeners or begin caching of state, do it here.
 
84
     * @see org.openide.nodes.Children#addNotify
 
85
     */
 
86
    void addNotify();
 
87
    /**
 
88
     * Called when the node list is no longer needed. Equivalent to {@link org.openide.nodes.Children#removeNotify}.
 
89
     * Unregister any listeners and perform any general cleanup.
 
90
     * @see org.openide.nodes.Children#removeNotify
 
91
     */
 
92
    void removeNotify();
 
93
}