From 79b6690593ef89e6549a9803eea478ab8134802b Mon Sep 17 00:00:00 2001 From: Peter Hancock Date: Mon, 20 Jun 2011 09:51:42 +0000 Subject: [PATCH] Added an IFDocumentHandler filter for triggering rendering events. Created an Event that captures an end page event with the page number. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@1137566 13f79535-47bb-0310-9956-ffa450edef68 --- .../fop/render/RendererEventProducer.java | 7 +++ .../fop/render/RendererEventProducer.xml | 1 + .../apache/fop/render/RendererFactory.java | 3 +- .../intermediate/EventProducingFilter.java | 54 +++++++++++++++++++ status.xml | 5 ++ 5 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 src/java/org/apache/fop/render/intermediate/EventProducingFilter.java diff --git a/src/java/org/apache/fop/render/RendererEventProducer.java b/src/java/org/apache/fop/render/RendererEventProducer.java index 87b01b1cc..1f4be8e7e 100644 --- a/src/java/org/apache/fop/render/RendererEventProducer.java +++ b/src/java/org/apache/fop/render/RendererEventProducer.java @@ -53,4 +53,11 @@ public interface RendererEventProducer extends EventProducer { * @event.severity ERROR */ void ioError(Object source, IOException ioe); + + /** + * Triggered at the end of page rendering. + * @param source the event source + * @param number the page number + */ + void endPage(Object source, int number); } diff --git a/src/java/org/apache/fop/render/RendererEventProducer.xml b/src/java/org/apache/fop/render/RendererEventProducer.xml index abb15a89a..abc45eb6f 100644 --- a/src/java/org/apache/fop/render/RendererEventProducer.xml +++ b/src/java/org/apache/fop/render/RendererEventProducer.xml @@ -18,4 +18,5 @@ I/O error while writing to target file.[ Reason: {ioe}] + Rendered page #{number}. diff --git a/src/java/org/apache/fop/render/RendererFactory.java b/src/java/org/apache/fop/render/RendererFactory.java index febe5a9ea..bc598450f 100644 --- a/src/java/org/apache/fop/render/RendererFactory.java +++ b/src/java/org/apache/fop/render/RendererFactory.java @@ -35,6 +35,7 @@ import org.apache.fop.apps.FOUserAgent; import org.apache.fop.area.AreaTreeHandler; import org.apache.fop.fo.FOEventHandler; import org.apache.fop.render.intermediate.AbstractIFDocumentHandlerMaker; +import org.apache.fop.render.intermediate.EventProducingFilter; import org.apache.fop.render.intermediate.IFDocumentHandler; import org.apache.fop.render.intermediate.IFDocumentHandlerConfigurator; import org.apache.fop.render.intermediate.IFRenderer; @@ -389,7 +390,7 @@ public class RendererFactory { if (configurator != null) { configurator.configure(documentHandler); } - return documentHandler; + return new EventProducingFilter(documentHandler, userAgent); } /** diff --git a/src/java/org/apache/fop/render/intermediate/EventProducingFilter.java b/src/java/org/apache/fop/render/intermediate/EventProducingFilter.java new file mode 100644 index 000000000..8ebc2fc46 --- /dev/null +++ b/src/java/org/apache/fop/render/intermediate/EventProducingFilter.java @@ -0,0 +1,54 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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:$ */ + +package org.apache.fop.render.intermediate; + +import org.apache.fop.apps.FOUserAgent; +import org.apache.fop.render.RendererEventProducer; +import org.apache.fop.render.intermediate.util.IFDocumentHandlerProxy; + +/** + * A filter that uses the Event Notification System to broadcast IF events. + * + */ +public class EventProducingFilter extends IFDocumentHandlerProxy { + + private int pageNumberEnded; + + private FOUserAgent userAgent; + + /** + * Constructor + * @param ifDocumentHandler the IFDocumentHandler to filter + * @param userAgent the FOUerAgent + */ + public EventProducingFilter(IFDocumentHandler ifDocumentHandler, FOUserAgent userAgent) { + super(ifDocumentHandler); + this.userAgent = userAgent; + } + + @Override + public void endPage() throws IFException { + super.endPage(); + pageNumberEnded++; + RendererEventProducer.Provider.get(userAgent.getEventBroadcaster()) + .endPage(this, pageNumberEnded); + } + +} \ No newline at end of file diff --git a/status.xml b/status.xml index f1b5de7b7..ec3f9b6ff 100644 --- a/status.xml +++ b/status.xml @@ -30,6 +30,7 @@