gmazza 2004/10/27 16:36:33
Modified: src/java/org/apache/fop/area AreaTreeHandler.java
AreaTreeModel.java RenderPagesModel.java
StorePagesModel.java
src/java/org/apache/fop/area/extensions BookmarkData.java
src/java/org/apache/fop/render AbstractRenderer.java
Renderer.java
src/java/org/apache/fop/render/pdf PDFRenderer.java
Added: src/java/org/apache/fop/area OffDocumentItem.java
Removed: src/java/org/apache/fop/area TreeExt.java
Log:
Rename of TreeExt interface to somewhat more intuitive OffDocumentItem.
Revision Changes Path
1.15 +7 -7 xml-fop/src/java/org/apache/fop/area/AreaTreeHandler.java
Index: AreaTreeHandler.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/area/AreaTreeHandler.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- AreaTreeHandler.java 24 Oct 2004 00:03:49 -0000 1.14
+++ AreaTreeHandler.java 27 Oct 2004 23:36:32 -0000 1.15
@@ -271,7 +271,7 @@
Outline out = (Outline)(bookmarks.getOutlines()).get(count);
data.addSubData(createBookmarkData(out));
}
- addTreeExtension(data);
+ addOffDocumentItem(data);
data.setAreaTreeModel(model);
}
@@ -295,12 +295,12 @@
}
/**
- * Add a tree extension.
- * This checks if the extension is resolvable and attempts
+ * Add a OffDocumentItem to the area tree model
+ * This checks if the OffDocumentItem is resolvable and attempts
* to resolve or add the resolvable ids for later resolution.
- * @param ext the tree extension to add.
+ * @param ext the OffDocumentItem to add.
*/
- private void addTreeExtension(TreeExt ext) {
+ private void addOffDocumentItem(OffDocumentItem ext) {
if (ext instanceof Resolvable) {
Resolvable res = (Resolvable)ext;
String[] ids = res.getIDs();
@@ -317,7 +317,7 @@
}
}
} else {
- model.handleExtension(ext, TreeExt.IMMEDIATELY);
+ model.handleOffDocumentItem(ext, OffDocumentItem.IMMEDIATELY);
}
}
}
1.9 +2 -2 xml-fop/src/java/org/apache/fop/area/AreaTreeModel.java
Index: AreaTreeModel.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/area/AreaTreeModel.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- AreaTreeModel.java 24 Oct 2004 00:03:49 -0000 1.8
+++ AreaTreeModel.java 27 Oct 2004 23:36:32 -0000 1.9
@@ -43,11 +43,11 @@
public abstract void addPage(PageViewport page);
/**
- * Handle an area tree extension
+ * Handle an OffDocumentItem
* @param ext the extension to handle
* @param when when the extension should be handled
*/
- public abstract void handleExtension(TreeExt ext, int when);
+ public abstract void handleOffDocumentItem(OffDocumentItem ext, int when);
/**
* Signal the end of the document for any processing.
1.8 +12 -12 xml-fop/src/java/org/apache/fop/area/RenderPagesModel.java
Index: RenderPagesModel.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/area/RenderPagesModel.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- RenderPagesModel.java 24 Oct 2004 00:03:49 -0000 1.7
+++ RenderPagesModel.java 27 Oct 2004 23:36:32 -0000 1.8
@@ -126,7 +126,7 @@
boolean cont = checkPreparedPages(page);
if (cont) {
- renderExtensions(pendingExt);
+ processOffDocumentItems(pendingExt);
pendingExt.clear();
}
}
@@ -175,26 +175,26 @@
}
/**
- * @see org.apache.fop.area.AreaTreeModel#handleExtension(TreeExt, int)
+ * @see
org.apache.fop.area.AreaTreeModel#handleOffDocumentItem(OffDocumentItem, int)
*/
- public void handleExtension(TreeExt ext, int when) {
+ public void handleOffDocumentItem(OffDocumentItem ext, int when) {
switch(when) {
- case TreeExt.IMMEDIATELY:
- renderer.renderExtension(ext);
+ case OffDocumentItem.IMMEDIATELY:
+ renderer.processOffDocumentItem(ext);
break;
- case TreeExt.AFTER_PAGE:
+ case OffDocumentItem.AFTER_PAGE:
pendingExt.add(ext);
break;
- case TreeExt.END_OF_DOC:
+ case OffDocumentItem.END_OF_DOC:
endDocExt.add(ext);
break;
}
}
- private void renderExtensions(List list) {
+ private void processOffDocumentItems(List list) {
for (int count = 0; count < list.size(); count++) {
- TreeExt ext = (TreeExt)list.get(count);
- renderer.renderExtension(ext);
+ OffDocumentItem ext = (OffDocumentItem)list.get(count);
+ renderer.processOffDocumentItem(ext);
}
}
@@ -206,10 +206,10 @@
// render any pages that had unresolved ids
checkPreparedPages(null);
- renderExtensions(pendingExt);
+ processOffDocumentItems(pendingExt);
pendingExt.clear();
- renderExtensions(endDocExt);
+ processOffDocumentItems(endDocExt);
try {
renderer.stopRenderer();
1.11 +5 -5 xml-fop/src/java/org/apache/fop/area/StorePagesModel.java
Index: StorePagesModel.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/area/StorePagesModel.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- StorePagesModel.java 24 Oct 2004 00:03:49 -0000 1.10
+++ StorePagesModel.java 27 Oct 2004 23:36:32 -0000 1.11
@@ -92,18 +92,18 @@
}
/**
- * @see org.apache.fop.area.AreaTreeModel#handleExtension(TreeExt, int)
+ * @see
org.apache.fop.area.AreaTreeModel#handleOffDocumentItem(OffDocumentItem, int)
*/
- public void handleExtension(TreeExt ext, int when) {
+ public void handleOffDocumentItem(OffDocumentItem ext, int when) {
int seq, page;
switch(when) {
- case TreeExt.IMMEDIATELY:
+ case OffDocumentItem.IMMEDIATELY:
seq = pageSequence == null ? 0 : pageSequence.size();
page = currSequence == null ? 0 : currSequence.size();
break;
- case TreeExt.AFTER_PAGE:
+ case OffDocumentItem.AFTER_PAGE:
break;
- case TreeExt.END_OF_DOC:
+ case OffDocumentItem.END_OF_DOC:
break;
}
extensions.add(ext);
1.1 xml-fop/src/java/org/apache/fop/area/OffDocumentItem.java
Index: OffDocumentItem.java
===================================================================
/*
* Copyright 1999-2004 The Apache Software Foundation.
*
* 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.
*/
/* $Id: OffDocumentItem.java,v 1.1 2004/10/27 23:36:32 gmazza Exp $ */
package org.apache.fop.area;
/**
* Interface for objects that are processed by the renderer outside
* of the actual document.
* This object can be handled by the renderer according to three
* possibilities, IMMEDIATELY, AFTER_PAGE, or END_OF_DOC.
*/
public interface OffDocumentItem {
/**
* Render this extension immediately when
* being handled by the area tree.
*/
public static final int IMMEDIATELY = 0;
/**
* Render this extension after the next page is rendered
* or prepared when being handled by the area tree.
*/
public static final int AFTER_PAGE = 1;
/**
* Render this extension at the end of the document once
* all pages have been fully rendered.
*/
public static final int END_OF_DOC = 2;
}
1.7 +4 -6
xml-fop/src/java/org/apache/fop/area/extensions/BookmarkData.java
Index: BookmarkData.java
===================================================================
RCS file:
/home/cvs/xml-fop/src/java/org/apache/fop/area/extensions/BookmarkData.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- BookmarkData.java 24 Oct 2004 00:03:49 -0000 1.6
+++ BookmarkData.java 27 Oct 2004 23:36:32 -0000 1.7
@@ -20,7 +20,7 @@
import org.apache.fop.area.PageViewport;
import org.apache.fop.area.Resolvable;
-import org.apache.fop.area.TreeExt;
+import org.apache.fop.area.OffDocumentItem;
import org.apache.fop.area.AreaTreeModel;
import java.util.ArrayList;
@@ -29,10 +29,8 @@
/**
* This class holds the PDF bookmark extension data.
- * This implements Resolvable and TreeExt so that it can be
- * added to the area tree as a resolvable tree extension.
*/
-public class BookmarkData implements Resolvable, TreeExt {
+public class BookmarkData implements Resolvable, OffDocumentItem {
private ArrayList subData = new ArrayList();
private HashMap idRefs = new HashMap();
@@ -203,7 +201,7 @@
if (idRefs.size() == 0) {
idRefs = null;
if (areaTreeModel != null) {
- areaTreeModel.handleExtension(this, TreeExt.AFTER_PAGE);
+ areaTreeModel.handleOffDocumentItem(this,
OffDocumentItem.AFTER_PAGE);
}
}
}
1.38 +3 -4 xml-fop/src/java/org/apache/fop/render/AbstractRenderer.java
Index: AbstractRenderer.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/render/AbstractRenderer.java,v
retrieving revision 1.37
retrieving revision 1.38
diff -u -r1.37 -r1.38
--- AbstractRenderer.java 25 Sep 2004 21:55:36 -0000 1.37
+++ AbstractRenderer.java 27 Oct 2004 23:36:33 -0000 1.38
@@ -47,7 +47,7 @@
import org.apache.fop.area.RegionViewport;
import org.apache.fop.area.RegionReference;
import org.apache.fop.area.Trait;
-import org.apache.fop.area.TreeExt;
+import org.apache.fop.area.OffDocumentItem;
import org.apache.fop.area.inline.Container;
import org.apache.fop.area.inline.ForeignObject;
import org.apache.fop.area.inline.Image;
@@ -156,10 +156,9 @@
}
/**
- * @param ext (todo) Description of the Parameter
- * @see org.apache.fop.render.Renderer
+ * @see org.apache.fop.render.Renderer
*/
- public void renderExtension(TreeExt ext) { }
+ public void processOffDocumentItem(OffDocumentItem oDI) { }
/**
* Prepare a page for rendering. This is called if the renderer supports
1.17 +5 -3 xml-fop/src/java/org/apache/fop/render/Renderer.java
Index: Renderer.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/render/Renderer.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- Renderer.java 10 Oct 2004 11:30:24 -0000 1.16
+++ Renderer.java 27 Oct 2004 23:36:33 -0000 1.17
@@ -26,7 +26,7 @@
import org.apache.fop.apps.FOPException;
import org.apache.fop.area.PageViewport;
import org.apache.fop.area.LineArea;
-import org.apache.fop.area.TreeExt;
+import org.apache.fop.area.OffDocumentItem;
import org.apache.fop.area.inline.Container;
import org.apache.fop.fonts.FontInfo;
import org.apache.fop.apps.FOUserAgent;
@@ -109,11 +109,13 @@
boolean supportsOutOfOrder();
/**
- * Tells the renderer to render an extension element.
+ * Tells the renderer to process an item not explicitly placed on the
+ * document (e.g., PDF bookmarks). Note - not all renderers will process
+ * all off-document items.
*
* @param ext The extension element to be rendered
*/
- void renderExtension(TreeExt ext);
+ public void processOffDocumentItem(OffDocumentItem ext);
/**
* This is called if the renderer supports out of order rendering. The
1.58 +3 -3 xml-fop/src/java/org/apache/fop/render/pdf/PDFRenderer.java
Index: PDFRenderer.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/render/pdf/PDFRenderer.java,v
retrieving revision 1.57
retrieving revision 1.58
diff -u -r1.57 -r1.58
--- PDFRenderer.java 19 Oct 2004 13:35:16 -0000 1.57
+++ PDFRenderer.java 27 Oct 2004 23:36:33 -0000 1.58
@@ -46,7 +46,7 @@
import org.apache.fop.area.PageViewport;
import org.apache.fop.area.RegionViewport;
import org.apache.fop.area.Trait;
-import org.apache.fop.area.TreeExt;
+import org.apache.fop.area.OffDocumentItem;
import org.apache.fop.area.extensions.BookmarkData;
import org.apache.fop.area.inline.Character;
import org.apache.fop.area.inline.TextArea;
@@ -279,9 +279,9 @@
}
/**
- * @see org.apache.fop.render.Renderer#renderExtension(TreeExt)
+ * @see org.apache.fop.render.Renderer#processOffDocumentItem(OffDocumentItem)
*/
- public void renderExtension(TreeExt ext) {
+ public void processOffDocumentItem(OffDocumentItem ext) {
// render bookmark extension
if (ext instanceof BookmarkData) {
renderRootExtensions((BookmarkData)ext);
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
