Thread: [FOray-commit] SF.net SVN: foray: [7137] trunk/foray/foray-areatree/src/java/org/foray/area

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 7137
Author:   victormote
Date:     2006-05-04 15:00:18 -0700 (Thu, 04 May 2006)
ViewCVS:  http://svn.sourceforge.net/foray/?rev=7137&view=rev

Log Message:
-----------
Rename class FObjProxy to FOrayFONodeProxy, for consistency and clarity.

Modified Paths:
--------------
    trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
    trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java
    trunk/foray/foray-areatree/src/java/org/foray/area/LayoutStrategy.java
    trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
    trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java
    trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java

Added Paths:
-----------
    trunk/foray/foray-areatree/src/java/org/foray/area/FOrayFONodeProxy.java

Removed Paths:
-------------
    trunk/foray/foray-areatree/src/java/org/foray/area/FObjProxy.java
Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
===================================================================

--- trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java	2006-05-04 21:39:10 UTC (rev 7136)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java	2006-05-04 22:00:18 UTC (rev 7137)
@@ -88,7 +88,7 @@
     /*
      * The "generated-by" trait, as defined in Section 6.1.1.
      */
-    protected FObjProxy generatedBy;
+    protected FOrayFONodeProxy generatedBy;
 
     /**
      * Constructor.
@@ -130,7 +130,7 @@
         this.children.remove(areaNode);
     }
 
-    protected FObjProxy getFObjProxy(FONode fobj) {
+    protected FOrayFONodeProxy getFObjProxy(FONode fobj) {
         return getAreaTree().lookupFObjProxy(fobj);
     }
 

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java	2006-05-04 21:39:10 UTC (rev 7136)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AreaTree.java	2006-05-04 22:00:18 UTC (rev 7137)
@@ -168,11 +168,11 @@
         return this;
     }
 
-    public FObjProxy lookupFObjProxy(FONode fobj) {
+    public FOrayFONodeProxy lookupFObjProxy(FONode fobj) {
         if (fobj == null) {
             return null;
         }
-        FObjProxy proxy = (FObjProxy) proxyMap.get(fobj);
+        FOrayFONodeProxy proxy = (FOrayFONodeProxy) proxyMap.get(fobj);
         if (proxy == null) {
             proxy = control.getLayoutStrategy().makeFObjProxy(fobj);
             proxyMap.put(fobj, proxy);
@@ -200,7 +200,7 @@
      */
     public Area firstNormalAreaReturned(String id) {
         FObj fobj = retrieveId(id);
-        FObjProxy proxy = lookupFObjProxy(fobj);
+        FOrayFONodeProxy proxy = lookupFObjProxy(fobj);
         if (proxy == null) {
             return null;
         }

Deleted: trunk/foray/foray-areatree/src/java/org/foray/area/FObjProxy.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/FObjProxy.java	2006-05-04 21:39:10 UTC (rev 7136)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/FObjProxy.java	2006-05-04 22:00:18 UTC (rev 7137)
@@ -1,209 +0,0 @@
-/*
- * Copyright 2004 The FOray Project.
- *      http://www.foray.org
- * 
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * 
- * This work is in part derived from the following work(s), used with the
- * permission of the licensor:
- *      Apache FOP, licensed by the Apache Software Foundation
- *
- */
-
-/* $Id$ */
-
-package org.foray.area;
-
-import org.axsl.fotree.FONode;
-
-import java.util.ArrayList;
-
-/**
- * <p>FObjProxy is a class whose instances serve as proxies for FObj instances.
- * One of its main purposes is to cross-reference generator FObj instances with
- * generated Area instances so that "generated-by" and "returned-by" traits
- * are handled properly. However, it can also be subclassed by layout
- * systems to maintain state information for FObj instances as they are being
- * laid out.</p>
- * 
- * <p>The information stored in this class could theoretically be stored
- * directly in the FObj instance. However, the FOray designers wish to keep
- * all layout and AreaTree data out of the FOTree so that it can be reused.
- * In addition, it is considered probable that most layout systems will wish
- * to store state information about FObj instances anyway.</p>
- * 
- * <p>More information about the <em>proxy</em> design pattern can be found
- * in the Gang of Four literature. This specific implementation shares some
- * characteristics of the Protection Proxy and of the Smart Reference.</p>
- */
-public class FObjProxy implements org.axsl.fotree.FONodeProxy {
-
-    /** The real FObj which this proxy represents. */
-    protected FONode realFObj;
-
-    /**
-     * The ordered list of Area instances generated by realFObj. Index 0
-     * "is-first" and Index size() - 1 "is-last". This is currently set up to
-     * only store the root node of any subtree that was generated by
-     * realFObj.
-     */
-    private ArrayList generatedAreas;
-
-    public FObjProxy(FONode realFObj) {
-        this.realFObj = realFObj;
-    }
-
-    public FONode getFONode() {
-        return this.realFObj;
-    }
-
-    public void registerGeneratedArea(AreaNode areaNode) {
-        AreaNode parent = areaNode.getAreaNodeParent();
-        if (parent != null) {
-            /*
-             * If the parent was generated by the same FObj, then we shouldn't
-             * register this one also.
-             */
-            if (areaNode.generatedBy == parent.generatedBy) {
-                return;
-            }
-        }
-        if (generatedAreas == null) {
-            generatedAreas = new ArrayList();
-        }
-        generatedAreas.add(areaNode);
-    }
-
-    public void unregisterGeneratedArea(AreaNode areaNode) {
-        generatedAreas.remove(areaNode);
-    }
-
-    public AreaNode getFirstGeneratedBy() {
-        if (generatedAreas == null || generatedAreas.size() < 1) {
-            return null;
-        }
-        return (AreaNode) generatedAreas.get(0);
-    }
-
-    public AreaNode getPreviousGeneratedBy(AreaNode area) {
-        if (generatedAreas == null) {
-            return null;
-        }
-        int index = generatedAreas.indexOf(area);
-        if (index > 0) {
-            return (AreaNode) generatedAreas.get(index - 1);
-        }
-        return null;
-    }
-
-    public AreaNode getNextGeneratedBy(AreaNode area) {
-        if (generatedAreas == null) {
-            return null;
-        }
-        int index = generatedAreas.indexOf(area);
-        if (index > 0 && index < generatedAreas.size() - 1) {
-            return (AreaNode) generatedAreas.get(index + 1);
-        }
-        return null;
-    }
-
-    /**
-     * @param area An Area instance.
-     * @return True iff area is the first Area generated by this.
-     */
-    public boolean isFirstGeneratedBy(AreaNode area) {
-        if (generatedAreas.indexOf(area) == 0) {
-            return true;
-        }
-        return false;
-    }
-
-    /**
-     * @param area An Area instance.
-     * @return True iff area is the first Area generated by this.
-     */
-    public boolean isLastGeneratedBy(AreaNode area) {
-        if (generatedAreas.indexOf(area) == (generatedAreas.size() - 1)) {
-            return true;
-        }
-        return false;
-    }
-
-    /**
-     * @return The current count of areas that have been generated by the FObj.
-     */
-    public int qtyAreasGenerated() {
-        return this.generatedAreas.size();
-    }
-
-    /**
-     * @return The last AreaNode generated by the parent FObj.
-     */
-    public AreaNode getLastGeneratedBy() {
-        if (generatedAreas == null || generatedAreas.size() < 1) {
-            return null;
-        }
-        return (AreaNode) generatedAreas.get(generatedAreas.size() - 1);
-    }
-
-    /**
-     * @return The last Area generated by the parent FObj.
-     */
-    public Area getLastAreaGeneratedBy() {
-        if (generatedAreas == null || generatedAreas.size() < 1) {
-            return null;
-        }
-        for (int i = generatedAreas.size() - 1; i >= 0; i--) {
-            Object object = generatedAreas.get(i);
-            if (object instanceof Area) {
-                return (Area) object;
-            }
-        }
-        return null;
-    }
-
-    public Area firstNormalAreaReturned() {
-        /*
-         * TODO: This is not right, but will do for now. It is not considering
-         * areas that are returned by the FO but not generated by it.
-         */
-        if (generatedAreas == null) {
-            return null;
-        }
-        for (int i = 0; i < generatedAreas.size(); i ++) {
-            Object object = generatedAreas.get(i);
-            if (object instanceof Area) {
-                return (Area) object;
-            }
-        }
-        return null;
-    }
-
-    public Area lastNormalAreaReturned() {
-        /*
-         * TODO: This is not right, but will do for now. It is not considering
-         * areas that are returned by the FO but not generated by it.
-         */
-        if (generatedAreas == null) {
-            return null;
-        }
-        for (int i = generatedAreas.size() - 1; i >= 0; i --) {
-            Object object = generatedAreas.get(i);
-            if (object instanceof Area) {
-                return (Area) object;
-            }
-        }
-        return null;
-    }
-
-}

Added: trunk/foray/foray-areatree/src/java/org/foray/area/FOrayFONodeProxy.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/FOrayFONodeProxy.java	                        (rev 0)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/FOrayFONodeProxy.java	2006-05-04 22:00:18 UTC (rev 7137)
@@ -0,0 +1,195 @@
+/*
+ * Copyright 2004 The FOray Project.
+ *      http://www.foray.org
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * 
+ * This work is in part derived from the following work(s), used with the
+ * permission of the licensor:
+ *      Apache FOP, licensed by the Apache Software Foundation
+ *
+ */
+
+/* $Id$ */
+
+package org.foray.area;
+
+import org.axsl.fotree.FONode;
+
+import java.util.ArrayList;
+
+/**
+ * <p>An implementation of {@link org.axsl.fotree.FONodeProxy} suitable for use
+ * with FOray.</p>
+ */
+public class FOrayFONodeProxy implements org.axsl.fotree.FONodeProxy {
+
+    /** The real FObj which this proxy represents. */
+    protected FONode realFObj;
+
+    /**
+     * The ordered list of Area instances generated by realFObj. Index 0
+     * "is-first" and Index size() - 1 "is-last". This is currently set up to
+     * only store the root node of any subtree that was generated by
+     * realFObj.
+     */
+    private ArrayList generatedAreas;
+
+    public FOrayFONodeProxy(FONode realFObj) {
+        this.realFObj = realFObj;
+    }
+
+    public FONode getFONode() {
+        return this.realFObj;
+    }
+
+    public void registerGeneratedArea(AreaNode areaNode) {
+        AreaNode parent = areaNode.getAreaNodeParent();
+        if (parent != null) {
+            /*
+             * If the parent was generated by the same FObj, then we shouldn't
+             * register this one also.
+             */
+            if (areaNode.generatedBy == parent.generatedBy) {
+                return;
+            }
+        }
+        if (generatedAreas == null) {
+            generatedAreas = new ArrayList();
+        }
+        generatedAreas.add(areaNode);
+    }
+
+    public void unregisterGeneratedArea(AreaNode areaNode) {
+        generatedAreas.remove(areaNode);
+    }
+
+    public AreaNode getFirstGeneratedBy() {
+        if (generatedAreas == null || generatedAreas.size() < 1) {
+            return null;
+        }
+        return (AreaNode) generatedAreas.get(0);
+    }
+
+    public AreaNode getPreviousGeneratedBy(AreaNode area) {
+        if (generatedAreas == null) {
+            return null;
+        }
+        int index = generatedAreas.indexOf(area);
+        if (index > 0) {
+            return (AreaNode) generatedAreas.get(index - 1);
+        }
+        return null;
+    }
+
+    public AreaNode getNextGeneratedBy(AreaNode area) {
+        if (generatedAreas == null) {
+            return null;
+        }
+        int index = generatedAreas.indexOf(area);
+        if (index > 0 && index < generatedAreas.size() - 1) {
+            return (AreaNode) generatedAreas.get(index + 1);
+        }
+        return null;
+    }
+
+    /**
+     * @param area An Area instance.
+     * @return True iff area is the first Area generated by this.
+     */
+    public boolean isFirstGeneratedBy(AreaNode area) {
+        if (generatedAreas.indexOf(area) == 0) {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * @param area An Area instance.
+     * @return True iff area is the first Area generated by this.
+     */
+    public boolean isLastGeneratedBy(AreaNode area) {
+        if (generatedAreas.indexOf(area) == (generatedAreas.size() - 1)) {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * @return The current count of areas that have been generated by the FObj.
+     */
+    public int qtyAreasGenerated() {
+        return this.generatedAreas.size();
+    }
+
+    /**
+     * @return The last AreaNode generated by the parent FObj.
+     */
+    public AreaNode getLastGeneratedBy() {
+        if (generatedAreas == null || generatedAreas.size() < 1) {
+            return null;
+        }
+        return (AreaNode) generatedAreas.get(generatedAreas.size() - 1);
+    }
+
+    /**
+     * @return The last Area generated by the parent FObj.
+     */
+    public Area getLastAreaGeneratedBy() {
+        if (generatedAreas == null || generatedAreas.size() < 1) {
+            return null;
+        }
+        for (int i = generatedAreas.size() - 1; i >= 0; i--) {
+            Object object = generatedAreas.get(i);
+            if (object instanceof Area) {
+                return (Area) object;
+            }
+        }
+        return null;
+    }
+
+    public Area firstNormalAreaReturned() {
+        /*
+         * TODO: This is not right, but will do for now. It is not considering
+         * areas that are returned by the FO but not generated by it.
+         */
+        if (generatedAreas == null) {
+            return null;
+        }
+        for (int i = 0; i < generatedAreas.size(); i ++) {
+            Object object = generatedAreas.get(i);
+            if (object instanceof Area) {
+                return (Area) object;
+            }
+        }
+        return null;
+    }
+
+    public Area lastNormalAreaReturned() {
+        /*
+         * TODO: This is not right, but will do for now. It is not considering
+         * areas that are returned by the FO but not generated by it.
+         */
+        if (generatedAreas == null) {
+            return null;
+        }
+        for (int i = generatedAreas.size() - 1; i >= 0; i --) {
+            Object object = generatedAreas.get(i);
+            if (object instanceof Area) {
+                return (Area) object;
+            }
+        }
+        return null;
+    }
+
+}


Property changes on: trunk/foray/foray-areatree/src/java/org/foray/area/FOrayFONodeProxy.java
___________________________________________________________________
Name: svn:keywords
   + "Author Id Rev Date URL"
Name: svn:eol-style
   + native

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/LayoutStrategy.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/LayoutStrategy.java	2006-05-04 21:39:10 UTC (rev 7136)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/LayoutStrategy.java	2006-05-04 22:00:18 UTC (rev 7137)
@@ -104,7 +104,7 @@
      * retrieved or manufactured.
      * @return The FObjProxy instance to which fobj is attached.
      */
-    public FObjProxy getFObjProxy(FONode fobj) {
+    public FOrayFONodeProxy getFObjProxy(FONode fobj) {
         return areaTree.getFObjProxy(fobj);
     }
 
@@ -130,8 +130,8 @@
      * @param node
      * @return A new FObjProxy which proxies node.
      */
-    public FObjProxy makeFObjProxy(FONode node) {
-        return new FObjProxy(node);
+    public FOrayFONodeProxy makeFObjProxy(FONode node) {
+        return new FOrayFONodeProxy(node);
     }
 
     public void handleLineBreakText(LineOutput lineOutput, LineText text,

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java	2006-05-04 21:39:10 UTC (rev 7136)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java	2006-05-04 22:00:18 UTC (rev 7137)
@@ -531,7 +531,7 @@
      */
     private boolean startsHere(Marker marker)  {
         FObj parent = marker.parentFO();
-        FObjProxy proxy = getFObjProxy(parent);
+        FOrayFONodeProxy proxy = getFObjProxy(parent);
         Area firstArea = proxy.firstNormalAreaReturned();
         if (firstArea == null) {
             return false;
@@ -548,7 +548,7 @@
      */
     private boolean endsHere(Marker marker)  {
         FObj parent = marker.parentFO();
-        FObjProxy proxy = getFObjProxy(parent);
+        FOrayFONodeProxy proxy = getFObjProxy(parent);
         Area lastArea = proxy.lastNormalAreaReturned();
         if (lastArea == null) {
             return false;

Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java	2006-05-04 21:39:10 UTC (rev 7136)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java	2006-05-04 22:00:18 UTC (rev 7137)
@@ -25,7 +25,7 @@
 package org.foray.pioneer;
 
 import org.foray.area.Area;
-import org.foray.area.FObjProxy;
+import org.foray.area.FOrayFONodeProxy;
 import org.foray.area.LineArea;
 import org.foray.area.NormalBlockArea;
 import org.foray.common.FOrayException;
@@ -44,7 +44,7 @@
 /**
  *
  */
-public abstract class FONodePL extends FObjProxy {
+public abstract class FONodePL extends FOrayFONodeProxy {
 
     /** value of progress before layout begins. */
     public static final int START = -1000;

Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java	2006-05-04 21:39:10 UTC (rev 7136)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java	2006-05-04 22:00:18 UTC (rev 7137)
@@ -25,7 +25,7 @@
 package org.foray.pioneer;
 
 import org.foray.area.Area;
-import org.foray.area.FObjProxy;
+import org.foray.area.FOrayFONodeProxy;
 import org.foray.area.LayoutStrategy;
 import org.foray.area.LineArea;
 import org.foray.area.NormalBlockArea;
@@ -255,7 +255,7 @@
         }
     }
 
-    public FObjProxy makeFObjProxy(FONode node) {
+    public FOrayFONodeProxy makeFObjProxy(FONode node) {
         switch (node.getNodeType()) {
         case FONode.NODE_ABSTRACT_FLOW: {
             return null;


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





Thread: [FOray-commit] SF.net SVN: foray: [7137] trunk/foray/foray-areatree/src/java/org/foray/area

Modular XSL-FO Implementation for Java.

foray-commit