vmote 2003/07/29 12:33:30
Modified: src/java/org/apache/fop/fo FOInputHandler.java
FOTreeBuilder.java FOTreeHandler.java
Log:
beef up the javadoc comments explaining what these classes do
Revision Changes Path
1.2 +10 -4 xml-fop/src/java/org/apache/fop/fo/FOInputHandler.java
Index: FOInputHandler.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/fo/FOInputHandler.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- FOInputHandler.java 29 Jul 2003 18:42:31 -0000 1.1
+++ FOInputHandler.java 29 Jul 2003 19:33:29 -0000 1.2
@@ -76,9 +76,15 @@
import org.xml.sax.SAXException;
/**
- * This class receives structure events from the FO Tree.
- * Sub-classes can then implement various methods to handle
- * the FO Tree when the SAX events occur.
+ * Abstract class defining what should be done with SAX events that map to
+ * XSL-FO input. The events are actually captured by fo/FOTreeBuilder, passed
+ * to the various fo Objects, which in turn, if needed, pass them to an instance
+ * of FOInputHandler.
+ *
+ * Sub-classes will generally fall into one of two categories:
+ * 1) a handler that actually builds an FO Tree from the events, or 2) a
+ * handler that builds a structured (as opposed to formatted) document, such
+ * as our MIF and RTF output targets.
*/
public abstract class FOInputHandler extends AbstractLogEnabled {
/**
1.9 +8 -3 xml-fop/src/java/org/apache/fop/fo/FOTreeBuilder.java
Index: FOTreeBuilder.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/fo/FOTreeBuilder.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- FOTreeBuilder.java 29 Jul 2003 18:42:31 -0000 1.8
+++ FOTreeBuilder.java 29 Jul 2003 19:33:29 -0000 1.9
@@ -74,15 +74,20 @@
import java.util.List;
/**
- * SAX Handler that builds the formatting object tree.
- *
- * Modified by Mark Lillywhite [EMAIL PROTECTED] Now uses
+ * SAX Handler that passes parsed data to the various
+ * FO objects, where they can be used either to build
+ * an FO Tree, or used by Structure Renderers to build
+ * other data structures.
+ * Now uses
* StreamRenderer to automagically render the document as
* soon as it receives a page-sequence end-tag. Also,
* calls methods to set up and shut down the renderer at
* the beginning and end of the FO document. Finally,
* supresses adding the PageSequence object to the Root,
* since it is parsed immediately.
+ *
+ * @author unascribed
+ * @author Mark Lillywhite [EMAIL PROTECTED]
*/
public class FOTreeBuilder extends DefaultHandler {
1.2 +4 -2 xml-fop/src/java/org/apache/fop/fo/FOTreeHandler.java
Index: FOTreeHandler.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/fo/FOTreeHandler.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- FOTreeHandler.java 29 Jul 2003 19:08:22 -0000 1.1
+++ FOTreeHandler.java 29 Jul 2003 19:33:29 -0000 1.2
@@ -82,9 +82,11 @@
import org.apache.fop.render.Renderer;
/**
- * Layout handler that receives the structure events.
+ * Defines how SAX events specific to XSL-FO input should be handled when
+ * an FO Tree needs to be built.
* This initiates layout processes and corresponding
* rendering processes such as start/end.
+ * @see FOInputHandler
*/
public class FOTreeHandler extends FOInputHandler {
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
