vmote 2003/08/20 10:56:25
Modified: src/java/org/apache/fop/apps Driver.java
src/java/org/apache/fop/control Document.java
src/java/org/apache/fop/fo/pagination PageSequence.java
Root.java
src/java/org/apache/fop/layout LayoutStrategy.java
src/java/org/apache/fop/layoutmgr LayoutManagerLS.java
Log:
style/javadoc changes only
Revision Changes Path
1.31 +0 -4 xml-fop/src/java/org/apache/fop/apps/Driver.java
Index: Driver.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/apps/Driver.java,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -r1.30 -r1.31
--- Driver.java 20 Aug 2003 16:35:27 -0000 1.30
+++ Driver.java 20 Aug 2003 17:56:24 -0000 1.31
@@ -52,22 +52,18 @@
// FOP
import org.apache.fop.area.AreaTree;
-import org.apache.fop.area.AreaTreeModel;
import org.apache.fop.control.Document;
import org.apache.fop.fo.ElementMapping;
import org.apache.fop.fo.FOTreeBuilder;
import org.apache.fop.fo.FOUserAgent;
import org.apache.fop.fo.FOInputHandler;
import org.apache.fop.fo.FOTreeHandler;
-import org.apache.fop.area.Title;
-import org.apache.fop.fo.pagination.PageSequence;
import org.apache.fop.mif.MIFHandler;
import org.apache.fop.render.Renderer;
import org.apache.fop.render.awt.AWTRenderer;
import org.apache.fop.rtf.renderer.RTFHandler;
import org.apache.fop.tools.DocumentInputSource;
import org.apache.fop.tools.DocumentReader;
-import org.apache.fop.layout.LayoutStrategy;
import org.apache.fop.layoutmgr.LayoutManagerLS;
// Avalon
1.7 +6 -1 xml-fop/src/java/org/apache/fop/control/Document.java
Index: Document.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/control/Document.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- Document.java 20 Aug 2003 17:25:43 -0000 1.6
+++ Document.java 20 Aug 2003 17:56:24 -0000 1.7
@@ -103,6 +103,7 @@
/**
* Main constructor
+ * @param driver the Driver object that is the "parent" of this Document
*/
public Document(Driver driver) {
this.driver = driver;
@@ -303,6 +304,10 @@
return layoutStrategy;
}
+ /**
+ * Public accessor for the parent Driver of this Document
+ * @return the parent Driver for this Document
+ */
public Driver getDriver() {
return driver;
}
1.9 +27 -3 xml-fop/src/java/org/apache/fop/fo/pagination/PageSequence.java
Index: PageSequence.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/fo/pagination/PageSequence.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- PageSequence.java 20 Aug 2003 17:25:43 -0000 1.8
+++ PageSequence.java 20 Aug 2003 17:56:24 -0000 1.9
@@ -55,12 +55,9 @@
import org.apache.fop.fo.FObj;
import org.apache.fop.fo.FOTreeVisitor;
import org.apache.fop.layout.PageMaster;
-import org.apache.fop.area.AreaTree;
import org.apache.fop.area.PageViewport;
import org.apache.fop.apps.FOPException;
-import org.apache.fop.layoutmgr.PageLayoutManager;
-
// Java
import java.util.HashMap;
@@ -772,26 +769,53 @@
return titleFO;
}
+ /**
+ * Hook for Visitor objects accessing the FO Tree.
+ * @param fotv the FOTreeVisitor object accessing this node of the FO Tree
+ */
public void acceptVisitor(FOTreeVisitor fotv) {
fotv.serveVisitor(this);
}
+ /**
+ * Public accessor for getting the MainFlow to which this PageSequence is
+ * attached.
+ * @return the MainFlow object to which this PageSequence is attached.
+ */
public Flow getMainFlow() {
return mainFlow;
}
+ /**
+ * Public accessor for getting the PageSequenceMaster to which this
+ * PageSequence is attached.
+ * @return the PageSequenceMaster to which this PageSequence is attached.
+ */
public PageSequenceMaster getPageSequenceMaster() {
return pageSequenceMaster;
}
+ /**
+ * Public accessor for getting the PageNumberGenerator.
+ * @return the PageNumberGenerator
+ */
public PageNumberGenerator getPageNumberGenerator() {
return pageNumberGenerator;
}
+ /**
+ * Public accessor for setting the currentPageNumber.
+ * @param currentPageNumber the value to which currentPageNumber should be
+ * set.
+ */
public void setCurrentPageNumber(int currentPageNumber) {
this.currentPageNumber = currentPageNumber;
}
+ /**
+ * Public accessor for the ancestor Root.
+ * @return the ancestor Root
+ */
public Root getRoot() {
return root;
}
1.8 +4 -0 xml-fop/src/java/org/apache/fop/fo/pagination/Root.java
Index: Root.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/fo/pagination/Root.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Root.java 20 Aug 2003 17:25:43 -0000 1.7
+++ Root.java 20 Aug 2003 17:56:24 -0000 1.8
@@ -163,6 +163,10 @@
return foTreeControl;
}
+ /**
+ * Hook for Visitor objects accessing the FO Tree.
+ * @param fotv the FOTreeVisitor object accessing this node of the FO Tree
+ */
public void acceptVisitor(FOTreeVisitor fotv) {
fotv.serveVisitor(this);
}
1.4 +7 -1 xml-fop/src/java/org/apache/fop/layout/LayoutStrategy.java
Index: LayoutStrategy.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/layout/LayoutStrategy.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- LayoutStrategy.java 20 Aug 2003 17:25:43 -0000 1.3
+++ LayoutStrategy.java 20 Aug 2003 17:56:24 -0000 1.4
@@ -72,6 +72,12 @@
return name;
}
+ /**
+ * Format a PageSequence into an AreaTree
+ * @param pageSeq the PageSequence to be formatted
+ * @param areaTree the AreaTree in which to place the formatted PageSequence
+ * @throws FOPException for errors during layout
+ */
public abstract void format (PageSequence pageSeq, AreaTree areaTree)
throws FOPException;
}
1.4 +2 -1 xml-fop/src/java/org/apache/fop/layoutmgr/LayoutManagerLS.java
Index: LayoutManagerLS.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/layoutmgr/LayoutManagerLS.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- LayoutManagerLS.java 20 Aug 2003 17:25:44 -0000 1.3
+++ LayoutManagerLS.java 20 Aug 2003 17:56:24 -0000 1.4
@@ -67,6 +67,7 @@
/**
* Runs the formatting of this page sequence into the given area tree
*
+ * @param pageSeq the PageSequence to be formatted
* @param areaTree the area tree to format this page sequence into
* @throws FOPException if there is an error formatting the contents
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
