AutoTagImporterProvider


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.web.core.syntax.spi;
21  
22  import javax.swing.text.Document  ;
23  
24  /**
25   *
26   * @author Petr Pisl
27   */
28  
29  
30  /** Until NetBeans 5.5 the code completion usually offered 
31   * only tags of libraries, which are already imported in 
32   * the page. More user-friendly is when all possible tags 
33   * from libraries, which are on the classpath, are offered 
34   * with the  code completion. Similar to the java code 
35   * completion. Implementation of this class provides 
36   * the functionality that makes auto tag library definition 
37   * in the document. The way, how the tag library definition 
38   * is done, depends on the type of document.
39   * 
40   * The implementation has to be registered in the default 
41   * filesystem (in layer file) in the folder 
42   * Editors/${mime-types}/AutoTagImportProviders
43   */
44  
45  public interface AutoTagImporterProvider {
46      
47      /** The method is called, when user select a tag in 
48       * the code completion window and the tag is inserted into 
49       * the document. The implementation has to decide, 
50       * whether  the tag library is already defined, whether 
51       * the tag library has to be imported and if necessary  
52       * write the tag library declaration into the document.
53       * 
54       * @param doc document on which the declaration should be written.
55       * @param prefix prefix of the library
56       * @param uri uri of the library
57       */ 
58      public void importLibrary(Document   doc, String   prefix, String   uri);
59      
60  }
61
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags