[FOray-commit] SF.net SVN: foray: [7871] trunk/foray/foray-fotree/src/java/org/foray/ fotree/fo/obj/PageSequence.java

[<vic...@us...>]

Revision: 7871
          http://svn.sourceforge.net/foray/?rev=7871&view=rev
Author:   victormote
Date:     2006-09-03 13:23:13 -0700 (Sun, 03 Sep 2006)

Log Message:
-----------
Clean up some doc.

Modified Paths:
--------------
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequence.java

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequence.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequence.java	2006-09-03 20:15:25 UTC (rev 7870)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequence.java	2006-09-03 20:23:13 UTC (rev 7871)
@@ -42,32 +42,31 @@
  */
 public class PageSequence extends FObj implements org.axsl.foR.fo.PageSequence {
 
-    // There doesn't seem to be anything in the spec requiring flows
-    // to be in the order given, only that they map to the regions
-    // defined in the page sequence, so all we need is this one hashtable
-    // the set of flows includes StaticContent flows also
-
     /**
-     * Map of flows to their flow name (flow-name, Flow) Does only contain flows
-     * for static content!
+     * Map whose key is a String containing the flow-name and whose value is
+     * the related StaticContent instance.
      */
-    private HashMap flowMap;
+    private HashMap staticContentMap;
 
-    // according to communication from Paul Grosso (XSL-List,
-    // 001228, Number 406), confusion in spec section 6.4.5 about
-    // multiplicity of fo:flow in XSL 1.0 is cleared up - one (1)
-    // fo:flow per fo:page-sequence only.
+    /**
+     * The {@link Flow} instance for this page-sequence.
+     * According to communication from Paul Grosso (XSL-List,
+     * 001228, Number 406), confusion in spec section 6.4.5 about
+     * multiplicity of fo:flow in XSL 1.0 is cleared up - one (1)
+     * fo:flow per fo:page-sequence only.
+     */
     private Flow flow = null;
 
-    // page number and related formatting variables
+    /** Handles page numbering and related formatting. */
     private PageNumberGenerator pageNumberGenerator;
 
+    /** The object containing the template for the use of page masters. */
     private PageSequenceTemplate pageSequenceTemplate;
 
     public PageSequence(final FObj parent, final PropertyList propertyList,
             final String systemId, final int line, final int column) {
         super(parent, propertyList, systemId, line, column);
-        flowMap = new HashMap();
+        staticContentMap = new HashMap();
     }
 
     /**
@@ -128,7 +127,7 @@
             throwException("Only a single fo:flow permitted per "
                     + getFullName());
         }
-        if (flowMap.containsKey(flow.traitFlowName())) {
+        if (staticContentMap.containsKey(flow.traitFlowName())) {
             throwException("flow-names must be unique within an "
                     + getFullName());
         }
@@ -141,7 +140,7 @@
             throwException("Static content ('" + staticContent.traitFlowName()
                     + "') is not allowed after fo:flow");
         }
-        if (flowMap.containsKey(staticContent.traitFlowName())) {
+        if (staticContentMap.containsKey(staticContent.traitFlowName())) {
             throwException("flow-names must be unique within an "
                     + "fo:page-sequence");
         }
@@ -153,11 +152,11 @@
                     "region-name '" + staticContent.traitFlowName()
                             + "' doesn't exist in the layout-master-set.");
         }
-        flowMap.put(staticContent.traitFlowName(), staticContent);
+        staticContentMap.put(staticContent.traitFlowName(), staticContent);
     }
 
     public StaticContent getStaticContent(final String regionName) {
-        return (StaticContent) flowMap.get(regionName);
+        return (StaticContent) staticContentMap.get(regionName);
     }
 
     /**


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.