DocumentModel


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  
20  package org.netbeans.modules.xml.xam.dom;
21  
22  import org.netbeans.modules.xml.xam.Model;
23  import org.w3c.dom.Document  ;
24  import org.w3c.dom.Element  ;
25  import org.w3c.dom.Node  ;
26  
27  /**
28   * Interface describing an abstract model. The model is based on a
29   * document representation that represents the persistent form.
30   * @author Chris Webster
31   * @author Nam Nguyen
32   * @author Rico Cruz
33   */
34  public interface DocumentModel<C extends DocumentComponent<C>> extends Model<C>{
35      
36      /**
37       * @return the DOM Document node.
38       */
39      Document   getDocument();
40      
41      /**
42       * Returns model root component.
43       */
44      C getRootComponent();
45      
46      /**
47       * @return true if two DOM nodes have same identity.
48       */
49      public boolean areSameNodes(Node   n1, Node   n2);
50      
51      /**
52       * Return XPath expression for the given component.
53       */
54      String   getXPathExpression(DocumentComponent component);
55      
56      /**
57       * Create component to be added as child of given component.
58       */
59      C createComponent(C parent, Element   element);
60      
61      /**
62       * Find component given a position into the Swing document.
63       * @return component if found.
64       */
65      DocumentComponent findComponent(int position);
66  }
67
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags