01: /*
02: * Sun Public License Notice
03: *
04: * The contents of this file are subject to the Sun Public License
05: * Version 1.0 (the "License"). You may not use this file except in
06: * compliance with the License. A copy of the License is available at
07: * http://www.sun.com/
08: *
09: * The Original Code is NetBeans. The Initial Developer of the Original
10: * Code is Sun Microsystems, Inc. Portions Copyright 1997-2000 Sun
11: * Microsystems, Inc. All Rights Reserved.
12: */
13:
14: package org.netbeans.editor.ext;
15:
16: /**
17: * Formatting layer that can be added to <tt>BaseFormatter</tt> to format the
18: * tokens.
19: *
20: * @author Miloslav Metelka
21: * @version 1.00
22: */
23:
24: public interface FormatLayer {
25:
26: /**
27: * Get the name of the layer. This name is used to identify the layer when
28: * it's being removed or replaced and it can be used for debugging purposes
29: * too.
30: */
31: public String getName();
32:
33: /**
34: * Format the tokens begining with the firstItem till the end.
35: *
36: * @param fw
37: * format-writer to be formatted. The format-layer will usually
38: * create the format-support as an abstraction level over the
39: * format-layer.
40: */
41: public void format(FormatWriter fw);
42:
43: }
|