01: /*
02: * Author: Chris Seguin
03: *
04: * This software has been developed under the copyleft
05: * rules of the GNU General Public License. Please
06: * consult the GNU General Public License for more
07: * details about use and distribution of this software.
08: */
09: package org.acm.seguin.pretty;
10:
11: /**
12: * Possible to store java doc components
13: *
14: *@author Chris Seguin
15: *@created April 15, 1999
16: */
17: public interface JavaDocable {
18: /**
19: * Allows you to add a java doc component
20: *
21: *@param component the component that can be added
22: */
23: public void addJavaDocComponent(JavaDocComponent component);
24:
25: /**
26: * Prints all the java doc components
27: *
28: *@param printData the print data
29: */
30: public void printJavaDocComponents(PrintData printData);
31:
32: /**
33: * Makes sure all the java doc components are present
34: */
35: public void finish();
36:
37: /**
38: * Checks to see if it was printed
39: *
40: *@return true if it still needs to be printed
41: */
42: public boolean isRequired();
43: }
|