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.project.ui;
43:
44: import org.openide.nodes.Node;
45:
46: /**
47: * Ability for a {@link org.netbeans.api.project.Project} to supply
48: * a logical view of itself.
49: * @see org.netbeans.api.project.Project#getLookup
50: * @author Jesse Glick
51: */
52: public interface LogicalViewProvider {
53:
54: /**
55: * Create a logical view node.
56: * Projects should not attempt to cache this node in any way;
57: * this call should always create a fresh node with no parent.
58: * The node's lookup should contain the project object.
59: * @return a node displaying the contents of the project in an intuitive way
60: */
61: Node createLogicalView();
62:
63: /**
64: * Try to find a given node in the logical view.
65: * If some node within the logical view tree has the supplied object
66: * in its lookup, it ought to be returned if that is practical.
67: * If there are multiple such nodes, the one most suitable for display
68: * to the user should be returned.<BR>
69: * This may be used to select nodes corresponding to files, etc.
70: * The following constraint should hold:
71: * <pre>
72: * private static boolean isAncestor(Node root, Node n) {
73: * if (n == null) return false;
74: * if (n == root) return true;
75: * return isAncestor(root, n.getParentNode());
76: * }
77: * // ...
78: * Node root = ...;
79: * Object target = ...;
80: * LogicalViewProvider lvp = ...;
81: * Node n = lvp.findPath(root, target);
82: * if (n != null) {
83: * assert isAncestor(root, n);
84: * Lookup.Template tmpl = new Lookup.Template(null, null, target);
85: * Collection res = n.getLookup().lookup(tmpl).allInstances();
86: * assert Collections.singleton(target).equals(new HashSet(res));
87: * }
88: * </pre>
89: * @param root a root node. E.g. a node from {@link #createLogicalView} or some wapper
90: * (FilterNode) around the node. The provider of the functionality is
91: * responsible for finding the appropriate node in the wrapper's children.
92: * @param target a target cookie, such as a {@link org.openide.loaders.DataObject}
93: * @return a subnode with that cookie, or null
94: */
95: Node findPath(Node root, Object target);
96:
97: }
|