TreeEditorCookie


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 java.io.IOException  ;
22  import java.beans.PropertyChangeListener  ;
23  
24  import org.openide.nodes.Node;
25  import org.openide.util.Task;
26  import org.openide.loaders.XMLDataObject;
27  
28  import org.netbeans.tax.TreeDocumentRoot;
29  import org.netbeans.tax.TreeException;
30  
31  /**
32   *
33   * @author  Petr Kuzel
34   * @version
35   */
36  public interface TreeEditorCookie extends Node.Cookie {
37  
38      /** property name of document property */
39      public static final String   PROP_DOCUMENT_ROOT = "documentRoot"; // NOI18N
40  
41      /** the result of parsing */
42      public static final String   PROP_STATUS        = "status"; // NOI18N
43      
44  
45      /**
46       * Detailed status of model not yet available (model not loaded).
47       */
48      public static final int STATUS_NOT     = XMLDataObject.STATUS_NOT;
49      
50      /**
51       * Model is OK.
52       */
53      public static final int STATUS_OK      = XMLDataObject.STATUS_OK;
54      
55      /**
56       * Model was constructed with some warnings.
57       */
58      public static final int STATUS_WARNING = XMLDataObject.STATUS_WARNING;
59      
60      /**
61       * Model can not be constructed.
62       */
63      public static final int STATUS_ERROR   = XMLDataObject.STATUS_ERROR;
64      
65  
66      /*
67       * Wait until document is loaded/parsed.
68       */
69      public TreeDocumentRoot openDocumentRoot () throws IOException  , TreeException;
70      
71      /*
72       *
73       */
74      public Task prepareDocumentRoot ();
75      
76      /*
77       * May return null.
78       */
79      public TreeDocumentRoot getDocumentRoot ();
80      
81  
82      /**
83       */
84      public int getStatus();
85      
86      
87      /**
88       */
89      public void addPropertyChangeListener (PropertyChangeListener   listener);
90      
91      /**
92       */
93      public void removePropertyChangeListener (PropertyChangeListener   listener);
94  
95  }
96
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags