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: package org.openide.explorer.view;
42:
43: import org.openide.nodes.Node;
44:
45: import javax.swing.tree.*;
46:
47: /** This class provide access to thread safe layer that
48: * reflects the hierarchy of Nodes, but is updated only in
49: * event dispatch thread (in contrast to nodes that can be updated from any thread).
50: * That is why this class is useful for writers of explorer views,
51: * because it guarantees that all changes will be done safely.
52: * <P>
53: * NodeTreeModel, NodeListModel, etc. use these objects as its
54: * model values.
55: *
56: * @author Jaroslav Tulach
57: */
58: public class Visualizer extends Object {
59: /** No constructor. */
60: private Visualizer() {
61: }
62:
63: /** Methods that create a tree node for given node.
64: * The tree node reflects the state of the associated node as close
65: * as possible, but is updated asynchronously in event dispatch thread.
66: * <P>
67: * This method can be called only from AWT-Event dispatch thread.
68: *
69: * @param node node to create safe representant for
70: * @return tree node that represents the node
71: */
72: public static TreeNode findVisualizer(Node node) {
73: return VisualizerNode.getVisualizer(null, node);
74: }
75:
76: /** Converts visualizer object back to its node representant.
77: *
78: * @param visualizer visualizer create by findVisualizer method
79: * @return node associated with the visualizer
80: * @exception ClassCastException if the parameter is invalid
81: */
82: public static Node findNode(Object visualizer) {
83: if (visualizer instanceof Node) {
84: return (Node) visualizer;
85: } else {
86: return ((VisualizerNode) visualizer).node;
87: }
88: }
89: }
|