KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > editor > ext > FormatLayer


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.editor.ext;
21
22 /**
23 * Formatting layer that can be added to <tt>BaseFormatter</tt>
24 * to format the tokens.
25 *
26 * @author Miloslav Metelka
27 * @version 1.00
28 */
29
30 public interface FormatLayer {
31
32     /** Get the name of the layer. This name is used to identify
33     * the layer when it's being removed or replaced and it can
34     * be used for debugging purposes too.
35     */
36     public String JavaDoc getName();
37
38     /** Format the tokens begining with the firstItem till the end.
39     * @param fw format-writer to be formatted. The format-layer
40     * will usually create the format-support as an abstraction
41     * level over the format-layer.
42     */
43     public void format(FormatWriter fw);
44
45 }
46
Popular Tags