View Javadoc

1   /*
2    * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
3    *
4    * This software is open source.
5    * See the bottom of this file for the licence.
6    */
7   
8   package org.dom4j.swing;
9   
10  import javax.swing.tree.DefaultTreeModel;
11  
12  import org.dom4j.Document;
13  
14  /***
15   * <p>
16   * <code>DocumentTreeModel</code> implements a Swing TreeModel for a dom4j XML
17   * Document.
18   * </p>
19   * 
20   * @author <a href="mailto:james.strachan@metastuff.com">James Strachan </a>
21   * @author Jakob Jenkov
22   * @version $Revision: 1.7 $
23   */
24  public class DocumentTreeModel extends DefaultTreeModel {
25      /*** The document for this model */
26      protected Document document;
27  
28      public DocumentTreeModel(Document document) {
29          super(new BranchTreeNode(document));
30          this.document = document;
31      }
32  
33      // Properties
34      // -------------------------------------------------------------------------
35  
36      /***
37       * DOCUMENT ME!
38       * 
39       * @return the <code>Document</code> instance that this
40       *         <code>TreeModel</code> is based on
41       */
42      public Document getDocument() {
43          return document;
44      }
45  
46      /***
47       * Sets the <code>Document</code> instance that this
48       * <code>TreeModel</code> is based on
49       * 
50       * @param document
51       *            DOCUMENT ME!
52       */
53      public void setDocument(Document document) {
54          this.document = document;
55          setRoot(new BranchTreeNode(document));
56      }
57  }
58  
59  /*
60   * Redistribution and use of this software and associated documentation
61   * ("Software"), with or without modification, are permitted provided that the
62   * following conditions are met:
63   * 
64   * 1. Redistributions of source code must retain copyright statements and
65   * notices. Redistributions must also contain a copy of this document.
66   * 
67   * 2. Redistributions in binary form must reproduce the above copyright notice,
68   * this list of conditions and the following disclaimer in the documentation
69   * and/or other materials provided with the distribution.
70   * 
71   * 3. The name "DOM4J" must not be used to endorse or promote products derived
72   * from this Software without prior written permission of MetaStuff, Ltd. For
73   * written permission, please contact dom4j-info@metastuff.com.
74   * 
75   * 4. Products derived from this Software may not be called "DOM4J" nor may
76   * "DOM4J" appear in their names without prior written permission of MetaStuff,
77   * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
78   * 
79   * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
80   * 
81   * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
82   * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
83   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
84   * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
85   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
86   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
87   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
88   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
89   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
90   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
91   * POSSIBILITY OF SUCH DAMAGE.
92   * 
93   * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
94   */