resolveRefID() --> getFirstPVWithID() renaming.

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/Temp_KnuthStylePageBreaking@198608 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/fop/layoutmgr/AbstractLayoutManager.java b/src/java/org/apache/fop/layoutmgr/AbstractLayoutManager.java
index f7812b9e33a7cebbe04e901f590fcc0475d5cd01..9ead2229c77239fb1f5d2f6a5fa0857635585b38 100644 (file)
--- a/src/java/org/apache/fop/layoutmgr/AbstractLayoutManager.java
+++ b/src/java/org/apache/fop/layoutmgr/AbstractLayoutManager.java
@@ -353,12 +353,12 @@ public abstract class AbstractLayoutManager implements LayoutManager, Constants
     }
 
     /**
-     * Delegate resolving the id reference to the parent layout manager.
+     * Delegate resolving the id reference to the PSLM
      *
      * @see org.apache.fop.layoutmgr.LayoutManager
      */
-    public PageViewport resolveRefID(String ref) {
-        return parentLM.resolveRefID(ref);
+    public PageViewport getFirstPVWithID(String ref) {
+        return parentLM.getFirstPVWithID(ref);
     }
 
     /**

diff --git a/src/java/org/apache/fop/layoutmgr/BasicLinkLayoutManager.java b/src/java/org/apache/fop/layoutmgr/BasicLinkLayoutManager.java
index 528ce4e6faad27e183b4c9b6fed055e1c160734c..0224f1114e8241b9a6cc8310dac7bd99c4ccd214 100644 (file)
--- a/src/java/org/apache/fop/layoutmgr/BasicLinkLayoutManager.java
+++ b/src/java/org/apache/fop/layoutmgr/BasicLinkLayoutManager.java
@@ -51,13 +51,13 @@ public class BasicLinkLayoutManager extends InlineLayoutManager {
          if (fobj.getExternalDestination() != null) {
              area.addTrait(Trait.EXTERNAL_LINK, fobj.getExternalDestination());
          } else {
-             String link = fobj.getInternalDestination();
-             PageViewport page = parentLM.resolveRefID(link);
+             String idref = fobj.getInternalDestination();
+             PageViewport page = parentLM.getFirstPVWithID(idref);
              if (page != null) {
                  area.addTrait(Trait.INTERNAL_LINK, page.getKey());
              } else {
-                 LinkResolver res = new LinkResolver(link, area);
-                 parentLM.addUnresolvedArea(link, res);
+                 LinkResolver res = new LinkResolver(idref, area);
+                 parentLM.addUnresolvedArea(idref, res);
              }
          }
      }

diff --git a/src/java/org/apache/fop/layoutmgr/ContentLayoutManager.java b/src/java/org/apache/fop/layoutmgr/ContentLayoutManager.java
index a92b0a70ca5e75668284f57041fb549581e92d07..690d2f85fba623b8f90cfa00d9f2ac7858b3b85a 100644 (file)
--- a/src/java/org/apache/fop/layoutmgr/ContentLayoutManager.java
+++ b/src/java/org/apache/fop/layoutmgr/ContentLayoutManager.java
@@ -255,8 +255,8 @@ public class ContentLayoutManager implements InlineLevelLayoutManager {
     }
 
     /** @see org.apache.fop.layoutmgr.LayoutManager */
-    public PageViewport resolveRefID(String ref) {
-        return parentLM.resolveRefID(ref);
+    public PageViewport getFirstPVWithID(String ref) {
+        return parentLM.getFirstPVWithID(ref);
     }
 
     /** @see org.apache.fop.layoutmgr.LayoutManager */

diff --git a/src/java/org/apache/fop/layoutmgr/LayoutManager.java b/src/java/org/apache/fop/layoutmgr/LayoutManager.java
index b69cc918f017dfe0aa46e7e6d938f88020cd0ea5..c55f37302603313b6eb06e6f0201734ca8923680 100644 (file)
--- a/src/java/org/apache/fop/layoutmgr/LayoutManager.java
+++ b/src/java/org/apache/fop/layoutmgr/LayoutManager.java
@@ -173,49 +173,6 @@ public interface LayoutManager {
      */
     PageViewport getCurrentPV();
 
-    /**
-     * Resolve the id reference.
-     * This is called by an area looking for an id reference.
-     * If the id reference is not found then it should add a resolvable object.
-     *
-     * @param ref the id reference
-     * @return the page containing the id reference or null if not found
-     */
-    PageViewport resolveRefID(String ref);
-
-    /**
-     * Add an id to the page.
-     * (todo) add the location of the area on the page
-     *
-     * @param id the id reference to add.
-     */
-    void addIDToPage(String id);
-
-    /**
-     * Add an unresolved area.
-     * The is used to add a resolvable object to the page for a given id.
-     *
-     * @param id the id reference this object needs for resolving
-     * @param res the resolvable object
-     */
-    void addUnresolvedArea(String id, Resolvable res);
-
-    /**
-     * Retrieve a marker.
-     * This method is used when retrieve a marker.
-     *
-     * @param name the class name of the marker
-     * @param pos the retrieve position
-     * @param boundary the boundary for retrieving the marker
-     * @return the layout manaager of the retrieved marker if any
-     */
-    Marker retrieveMarker(String name, int pos, int boundary);
-
-    /**
-     * @return the LayoutManagerMaker object.
-     */
-    LayoutManagerMaker getLayoutManagerMaker();
-
     /**
      * Load next child LMs, up to child LM index pos
      * @param pos index up to which child LMs are requested
@@ -264,6 +221,20 @@ public interface LayoutManager {
     LinkedList getChangedKnuthElements(List oldList, /*int flaggedPenalty,*/
                                        int alignment);
 
-    public static final int FLAGGED_PENALTY = 50;
+    /** @see PageSequenceLayoutManager#getFirstPVWithID(String) */
+    PageViewport getFirstPVWithID(String ref);
+
+    /** @see PageSequenceLayoutManager#addIDToPage(String) */
+    void addIDToPage(String id);
+
+    /** @see PageSequenceLayoutManager#addUnresolvedArea(String, Resolvable) */
+    void addUnresolvedArea(String id, Resolvable res);
+
+    /** @see PageSequenceLayoutManager#retrieveMarker(String, int, int) */
+    Marker retrieveMarker(String name, int pos, int boundary);
+
+    /** @see PageSequenceLayoutManager#getLayoutManagerMaker() */
+    LayoutManagerMaker getLayoutManagerMaker();
 
+    public static final int FLAGGED_PENALTY = 50;
 }

diff --git a/src/java/org/apache/fop/layoutmgr/PageNumberCitationLayoutManager.java b/src/java/org/apache/fop/layoutmgr/PageNumberCitationLayoutManager.java
index d2755fea38b53ca8baaef057f0fd12f881e4657e..f050108db54abc00607bc5daf9e4fc2e1d8ba58b 100644 (file)
--- a/src/java/org/apache/fop/layoutmgr/PageNumberCitationLayoutManager.java
+++ b/src/java/org/apache/fop/layoutmgr/PageNumberCitationLayoutManager.java
@@ -71,7 +71,7 @@ public class PageNumberCitationLayoutManager extends LeafNodeLayoutManager {
      * return a resolvable area
      */
     private InlineArea getPageNumberCitationInlineArea(LayoutManager parentLM) {
-        PageViewport page = parentLM.resolveRefID(fobj.getRefId());
+        PageViewport page = parentLM.getFirstPVWithID(fobj.getRefId());
         InlineArea inline = null;
         if (page != null) {
             String str = page.getPageNumberString();

diff --git a/src/java/org/apache/fop/layoutmgr/PageSequenceLayoutManager.java b/src/java/org/apache/fop/layoutmgr/PageSequenceLayoutManager.java
index 60fb20948103077b687ebceb99bed82b993b6d3a..3c3ef5dd54c37718f76bdf77b85bf713ca8f455e 100644 (file)
--- a/src/java/org/apache/fop/layoutmgr/PageSequenceLayoutManager.java
+++ b/src/java/org/apache/fop/layoutmgr/PageSequenceLayoutManager.java
@@ -270,15 +270,14 @@ public class PageSequenceLayoutManager extends AbstractLayoutManager {
     }
 
     /**
-     * Resolve a reference ID.
-     * This resolves a reference ID and returns the first PageViewport
-     * that contains the reference ID or null if reference not found.
+     * This returns the first PageViewport that contains an id trait
+     * matching the idref argument, or null if no such PV exists.
      *
-     * @param id the reference ID to lookup
-     * @return the first page viewport that contains the reference
+     * @param idref the idref trait needing to be resolved 
+     * @return the first PageViewport that contains the ID trait
      */
-    public PageViewport resolveRefID(String id) {
-        List list = areaTreeHandler.getPageViewportsContainingID(id);
+    public PageViewport getFirstPVWithID(String idref) {
+        List list = areaTreeHandler.getPageViewportsContainingID(idref);
         if (list != null && list.size() > 0) {
             return (PageViewport) list.get(0);
         }