KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > tax > cookies > TreeDocumentCookie


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 package org.netbeans.modules.xml.tax.cookies;
20
21 import javax.swing.text.Element JavaDoc;
22
23 import org.openide.nodes.Node;
24 import org.openide.cookies.EditorCookie;
25
26 import org.netbeans.tax.TreeDocumentRoot;
27 import org.netbeans.tax.TreeNode;
28
29 /**
30  * Everything what can be represented as the tree can return this cookie.
31  * It particurary can be DTD and XML document (fragment).
32  *
33  * @author Libor Kramolis
34  * @version 0.1
35  */
36 public interface TreeDocumentCookie extends Node.Cookie {
37
38     /**
39      * Return current state of model (it may be different from state when cookie was queried).
40      * @return root of tree hiearchy or null if source can not be represented as tree
41      * (can not be parsed etc.)
42      */
43     public TreeDocumentRoot getDocumentRoot ();
44     
45     
46     /**
47      */
48     /* public */ static interface Editor extends TreeDocumentCookie, EditorCookie {
49     
50     /**
51      */
52     Element JavaDoc treeToText (TreeNode treeNode);
53
54     /**
55      */
56     TreeNode textToTree (Element JavaDoc textElement);
57
58     }
59
60 }
61
Popular Tags