HtmlFormatter


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.api.gsf;
21  
22  /**
23   * A formatter used to format items for navigation, code completion, etc.
24   * Language plugins should build up HTML strings by calling logical
25   * methods on this class, and suitable HTML will be constructed (using
26   * whatever colors and attributes are appropriate for the different logical 
27   * sections and so on). This places formatting logic within the IDE such that
28   * it can be theme sensitive (and changed without replicating logic in the plugins).
29   *
30   * @author Tor Norbye
31   */
32  public abstract class HtmlFormatter {
33      public abstract void reset();
34      public abstract void appendHtml(String   html);
35      public abstract void appendText(String   text);
36      
37      public abstract void name(ElementKind kind, boolean start);
38      public abstract void parameters(boolean start);
39      public abstract void type(boolean start);
40      public abstract void deprecated(boolean start);
41      
42      public abstract String   getText();
43  }
44
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags