From f221f760a4ffe27de9e6002e900e0e2501e23892 Mon Sep 17 00:00:00 2001 From: William Victor Mote Date: Wed, 20 Aug 2003 17:56:24 +0000 Subject: [PATCH] style/javadoc changes only git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196816 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/fop/apps/Driver.java | 4 --- src/java/org/apache/fop/control/Document.java | 5 ++++ .../fop/fo/pagination/PageSequence.java | 30 +++++++++++++++++-- .../org/apache/fop/fo/pagination/Root.java | 4 +++ .../org/apache/fop/layout/LayoutStrategy.java | 6 ++++ .../apache/fop/layoutmgr/LayoutManagerLS.java | 1 + 6 files changed, 43 insertions(+), 7 deletions(-) diff --git a/src/java/org/apache/fop/apps/Driver.java b/src/java/org/apache/fop/apps/Driver.java index c93da0a39..b91a275ec 100644 --- a/src/java/org/apache/fop/apps/Driver.java +++ b/src/java/org/apache/fop/apps/Driver.java @@ -52,22 +52,18 @@ package org.apache.fop.apps; // 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 diff --git a/src/java/org/apache/fop/control/Document.java b/src/java/org/apache/fop/control/Document.java index f30bde00d..48c0c88de 100644 --- a/src/java/org/apache/fop/control/Document.java +++ b/src/java/org/apache/fop/control/Document.java @@ -103,6 +103,7 @@ public class Document implements FOTreeControl, FOTreeListener { /** * 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 @@ public class Document implements FOTreeControl, FOTreeListener { return layoutStrategy; } + /** + * Public accessor for the parent Driver of this Document + * @return the parent Driver for this Document + */ public Driver getDriver() { return driver; } diff --git a/src/java/org/apache/fop/fo/pagination/PageSequence.java b/src/java/org/apache/fop/fo/pagination/PageSequence.java index 6de86c768..240b02100 100644 --- a/src/java/org/apache/fop/fo/pagination/PageSequence.java +++ b/src/java/org/apache/fop/fo/pagination/PageSequence.java @@ -55,12 +55,9 @@ import org.apache.fop.fo.FONode; 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 @@ public class PageSequence extends FObj { 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; } diff --git a/src/java/org/apache/fop/fo/pagination/Root.java b/src/java/org/apache/fop/fo/pagination/Root.java index 415c3de4e..fa3491ac4 100644 --- a/src/java/org/apache/fop/fo/pagination/Root.java +++ b/src/java/org/apache/fop/fo/pagination/Root.java @@ -163,6 +163,10 @@ public class Root extends FObj { 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); } diff --git a/src/java/org/apache/fop/layout/LayoutStrategy.java b/src/java/org/apache/fop/layout/LayoutStrategy.java index aa522a3a8..390609174 100644 --- a/src/java/org/apache/fop/layout/LayoutStrategy.java +++ b/src/java/org/apache/fop/layout/LayoutStrategy.java @@ -72,6 +72,12 @@ public abstract class LayoutStrategy { 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; } diff --git a/src/java/org/apache/fop/layoutmgr/LayoutManagerLS.java b/src/java/org/apache/fop/layoutmgr/LayoutManagerLS.java index 9b59bab88..2ec3f8985 100644 --- a/src/java/org/apache/fop/layoutmgr/LayoutManagerLS.java +++ b/src/java/org/apache/fop/layoutmgr/LayoutManagerLS.java @@ -67,6 +67,7 @@ public class LayoutManagerLS extends LayoutStrategy { /** * 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 */ -- 2.39.5