diff options
Diffstat (limited to 'src/java/org/apache/fop/fo/pagination')
10 files changed, 222 insertions, 55 deletions
diff --git a/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java b/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java index 7953731f1..da92c7439 100644 --- a/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java +++ b/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java @@ -27,6 +27,7 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; +import org.apache.fop.layoutmgr.BlockLevelEventProducer; /** * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_conditional-page-master-reference"> @@ -41,6 +42,8 @@ import org.apache.fop.fo.ValidationException; public class ConditionalPageMasterReference extends FObj { // The value of properties relevant for fo:conditional-page-master-reference. private String masterReference; + // The simple page master referenced + private SimplePageMaster master; private int pagePosition; private int oddOrEven; private int blankOrNotBlank; @@ -127,8 +130,8 @@ public class ConditionalPageMasterReference extends FObj { * Get the value for the <code>master-reference</code> property. * @return the "master-reference" property */ - public String getMasterReference() { - return masterReference; + public SimplePageMaster getMaster() { + return master; } /** @@ -151,4 +154,19 @@ public class ConditionalPageMasterReference extends FObj { public int getNameId() { return FO_CONDITIONAL_PAGE_MASTER_REFERENCE; } + + /** + * called by the parent RepeatablePageMasterAlternatives to resolve object references + * from simple page master reference names + * @param layoutMasterSet the layout-master-set + * @throws ValidationException when a named reference cannot be resolved + * */ + public void resolveReferences(LayoutMasterSet layoutMasterSet) throws ValidationException { + master = layoutMasterSet.getSimplePageMaster(masterReference); + if (master == null) { + BlockLevelEventProducer.Provider.get( + getUserAgent().getEventBroadcaster()) + .noMatchingPageMaster(this, parent.getName(), masterReference, getLocator()); + } + } } diff --git a/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java b/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java index c4189d0c4..533b113d2 100644 --- a/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java +++ b/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java @@ -20,7 +20,6 @@ package org.apache.fop.fo.pagination; // Java -import java.util.Iterator; import java.util.Map; import org.xml.sax.Locator; @@ -75,6 +74,7 @@ public class LayoutMasterSet extends FObj { missingChildElementError("(simple-page-master|page-sequence-master)+"); } checkRegionNames(); + resolveSubSequenceReferences(); } /** @@ -104,7 +104,7 @@ public class LayoutMasterSet extends FObj { for (Region region : spmRegions.values()) { if (allRegions.containsKey(region.getRegionName())) { String defaultRegionName - = allRegions.get(region.getRegionName()); + = allRegions.get(region.getRegionName()); if (!defaultRegionName.equals(region.getDefaultRegionName())) { getFOValidationEventProducer().regionNameMappedToMultipleRegionClasses(this, region.getRegionName(), @@ -118,6 +118,14 @@ public class LayoutMasterSet extends FObj { } } + private void resolveSubSequenceReferences() throws ValidationException { + for (PageSequenceMaster psm : pageSequenceMasters.values()) { + for (SubSequenceSpecifier subSequenceSpecifier : psm.getSubSequenceSpecifier()) { + subSequenceSpecifier.resolveReferences(this); + } + } + } + /** * Add a simple page master. * The name is checked to throw an error if already added. @@ -150,7 +158,7 @@ public class LayoutMasterSet extends FObj { * @return the requested simple-page-master */ public SimplePageMaster getSimplePageMaster(String masterName) { - return this.simplePageMasters.get(masterName); + return simplePageMasters.get(masterName); } /** diff --git a/src/java/org/apache/fop/fo/pagination/PageProductionException.java b/src/java/org/apache/fop/fo/pagination/PageProductionException.java index 39060f3d4..c64bdada3 100644 --- a/src/java/org/apache/fop/fo/pagination/PageProductionException.java +++ b/src/java/org/apache/fop/fo/pagination/PageProductionException.java @@ -25,8 +25,8 @@ import org.xml.sax.Locator; import org.xml.sax.helpers.LocatorImpl; import org.apache.fop.events.Event; -import org.apache.fop.events.EventFormatter; import org.apache.fop.events.EventExceptionManager.ExceptionFactory; +import org.apache.fop.events.EventFormatter; /** * Exception thrown by FOP if there is a problem while producing new pages. @@ -38,6 +38,15 @@ public class PageProductionException extends RuntimeException { private String localizedMessage; private Locator locator; + + /** + * Creates a new PageProductionException. + * @param message the message + */ + public PageProductionException(String message) { + super(message); + } + /** * Creates a new PageProductionException. * @param message the message @@ -48,12 +57,13 @@ public class PageProductionException extends RuntimeException { setLocator(locator); } + /** * Set a location associated with the exception. * @param locator the locator holding the location. */ public void setLocator(Locator locator) { - this.locator = new LocatorImpl(locator); + this.locator = locator != null ? new LocatorImpl(locator) : null; } diff --git a/src/java/org/apache/fop/fo/pagination/PageSequence.java b/src/java/org/apache/fop/fo/pagination/PageSequence.java index ee78bb8ba..1c3b33fa7 100644 --- a/src/java/org/apache/fop/fo/pagination/PageSequence.java +++ b/src/java/org/apache/fop/fo/pagination/PageSequence.java @@ -48,7 +48,7 @@ public class PageSequence extends AbstractPageSequence { // the set of flows includes StaticContent flows also /** Map of flows to their flow name (flow-name, Flow) */ - private Map<String, Flow> flowMap; + private Map<String, FONode> flowMap; /** * The currentSimplePageMaster is either the page master for the @@ -96,7 +96,7 @@ public class PageSequence extends AbstractPageSequence { /** {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); - flowMap = new java.util.HashMap<String, Flow>(); + flowMap = new java.util.HashMap<String, FONode>(); this.simplePageMaster = getRoot().getLayoutMasterSet().getSimplePageMaster(masterReference); @@ -239,7 +239,7 @@ public class PageSequence extends AbstractPageSequence { } /** @return the flow map for this page-sequence */ - public Map<String, Flow> getFlowMap() { + public Map<String, FONode> getFlowMap() { return this.flowMap; } @@ -270,7 +270,7 @@ public class PageSequence extends AbstractPageSequence { + " isBlank=" + isBlank + ")"); } return pageSequenceMaster.getNextSimplePageMaster(isOddPage, - isFirstPage, isLastPage, isBlank); + isFirstPage, isLastPage, isBlank, getMainFlow().getFlowName()); } /** diff --git a/src/java/org/apache/fop/fo/pagination/PageSequenceMaster.java b/src/java/org/apache/fop/fo/pagination/PageSequenceMaster.java index 5b71525d3..5eb3d3259 100644 --- a/src/java/org/apache/fop/fo/pagination/PageSequenceMaster.java +++ b/src/java/org/apache/fop/fo/pagination/PageSequenceMaster.java @@ -20,6 +20,7 @@ package org.apache.fop.fo.pagination; // Java +import java.util.Collections; import java.util.List; import org.xml.sax.Locator; @@ -47,6 +48,7 @@ public class PageSequenceMaster extends FObj { private List<SubSequenceSpecifier> subSequenceSpecifiers; private SubSequenceSpecifier currentSubSequence; private int currentSubSequenceNumber = -1; + private BlockLevelEventProducer blockLevelEventProducer; // The terminology may be confusing. A 'page-sequence-master' consists // of a sequence of what the XSL spec refers to as @@ -60,9 +62,11 @@ public class PageSequenceMaster extends FObj { * given {@link FONode}. * * @param parent {@link FONode} that is the parent of this object + * @param blockLevelEventProducer event producer */ - public PageSequenceMaster(FONode parent) { + public PageSequenceMaster(FONode parent, BlockLevelEventProducer blockLevelEventProducer) { super(parent); + this.blockLevelEventProducer = blockLevelEventProducer; } /** {@inheritDoc} */ @@ -126,6 +130,10 @@ public class PageSequenceMaster extends FObj { return null; } + List<SubSequenceSpecifier> getSubSequenceSpecifier() { + return Collections.unmodifiableList(subSequenceSpecifiers); + } + /** * Resets the subsequence specifiers subsystem. */ @@ -177,52 +185,58 @@ public class PageSequenceMaster extends FObj { * @param isFirstPage True if the next page is the first * @param isLastPage True if the next page is the last * @param isBlankPage True if the next page is blank + * @param mainFlowName the name of the main flow of the page sequence * @return the requested page master * @throws PageProductionException if there's a problem determining the next page master */ public SimplePageMaster getNextSimplePageMaster(boolean isOddPage, boolean isFirstPage, boolean isLastPage, - boolean isBlankPage) + boolean isBlankPage, + String mainFlowName) throws PageProductionException { if (currentSubSequence == null) { currentSubSequence = getNextSubSequence(); if (currentSubSequence == null) { - BlockLevelEventProducer eventProducer = BlockLevelEventProducer.Provider.get( - getUserAgent().getEventBroadcaster()); - eventProducer.missingSubsequencesInPageSequenceMaster(this, + blockLevelEventProducer.missingSubsequencesInPageSequenceMaster(this, masterName, getLocator()); } + if (currentSubSequence.isInfinite() && !currentSubSequence.canProcess(mainFlowName)) { + throw new PageProductionException( + "The current sub-sequence will not terminate whilst processing then main flow"); + } } - String pageMasterName = currentSubSequence - .getNextPageMasterName(isOddPage, isFirstPage, isLastPage, isBlankPage); + + SimplePageMaster pageMaster = currentSubSequence + .getNextPageMaster(isOddPage, isFirstPage, isLastPage, isBlankPage); + boolean canRecover = true; - while (pageMasterName == null) { + + while (pageMaster == null) { SubSequenceSpecifier nextSubSequence = getNextSubSequence(); + if (nextSubSequence == null) { - BlockLevelEventProducer eventProducer = BlockLevelEventProducer.Provider.get( - getUserAgent().getEventBroadcaster()); - eventProducer.pageSequenceMasterExhausted(this, + //Sub-sequence exhausted so attempt to reuse it + blockLevelEventProducer.pageSequenceMasterExhausted(this, masterName, canRecover, getLocator()); currentSubSequence.reset(); + if (!currentSubSequence.canProcess(mainFlowName)) { + throw new PageProductionException( + "The last simple-page-master does not reference the main flow"); + } canRecover = false; } else { currentSubSequence = nextSubSequence; } - pageMasterName = currentSubSequence - .getNextPageMasterName(isOddPage, isFirstPage, isLastPage, isBlankPage); - } - SimplePageMaster pageMaster = this.layoutMasterSet - .getSimplePageMaster(pageMasterName); - if (pageMaster == null) { - BlockLevelEventProducer eventProducer = BlockLevelEventProducer.Provider.get( - getUserAgent().getEventBroadcaster()); - eventProducer.noMatchingPageMaster(this, - masterName, pageMasterName, getLocator()); + + pageMaster = currentSubSequence + .getNextPageMaster(isOddPage, isFirstPage, isLastPage, isBlankPage); } + return pageMaster; } + /** {@inheritDoc} */ public String getLocalName() { return "page-sequence-master"; @@ -235,5 +249,7 @@ public class PageSequenceMaster extends FObj { public int getNameId() { return FO_PAGE_SEQUENCE_MASTER; } + + } diff --git a/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterAlternatives.java b/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterAlternatives.java index 629d7d59d..2ad8a3cfc 100644 --- a/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterAlternatives.java +++ b/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterAlternatives.java @@ -20,6 +20,7 @@ package org.apache.fop.fo.pagination; // Java +import java.util.ArrayList; import java.util.List; import org.xml.sax.Locator; @@ -114,25 +115,24 @@ public class RepeatablePageMasterAlternatives extends FObj } /** {@inheritDoc} */ - public String getNextPageMasterName(boolean isOddPage, + public SimplePageMaster getNextPageMaster(boolean isOddPage, boolean isFirstPage, boolean isLastPage, boolean isBlankPage) { - if (getMaximumRepeats() != INFINITE) { - if (numberConsumed < getMaximumRepeats()) { - numberConsumed++; - } else { - return null; - } - } else { - numberConsumed++; + + if (!isInfinite() && numberConsumed >= getMaximumRepeats()) { + return null; } + numberConsumed++; + for (ConditionalPageMasterReference cpmr : conditionalPageMasterRefs) { if (cpmr.isValid(isOddPage, isFirstPage, isLastPage, isBlankPage)) { - return cpmr.getMasterReference(); + return cpmr.getMaster(); } } + + return null; } @@ -189,4 +189,50 @@ public class RepeatablePageMasterAlternatives extends FObj return FO_REPEATABLE_PAGE_MASTER_ALTERNATIVES; } + + + /** {@inheritDoc} */ + public void resolveReferences(LayoutMasterSet layoutMasterSet) throws ValidationException { + for (ConditionalPageMasterReference conditionalPageMasterReference + : conditionalPageMasterRefs) { + conditionalPageMasterReference.resolveReferences(layoutMasterSet); + } + + } + + /** {@inheritDoc} */ + public boolean canProcess(String flowName) { + + boolean willTerminate = true; + + + //Look for rest spm that cannot terminate + ArrayList<ConditionalPageMasterReference> rest + = new ArrayList<ConditionalPageMasterReference>(); + for (ConditionalPageMasterReference cpmr + : conditionalPageMasterRefs) { + if (cpmr.isValid(true, false, false, false) + || cpmr.isValid(false, false, false, false)) { + rest.add(cpmr); + } + } + if (!rest.isEmpty()) { + willTerminate = false; + for (ConditionalPageMasterReference cpmr : rest) { + willTerminate |= cpmr.getMaster().getRegion(FO_REGION_BODY).getRegionName() + .equals(flowName); + } + } + + + return willTerminate; + } + + /** {@inheritDoc} */ + public boolean isInfinite() { + return getMaximumRepeats() == INFINITE; + } + + + } diff --git a/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterReference.java b/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterReference.java index 9bbe55939..83207885a 100644 --- a/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterReference.java +++ b/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterReference.java @@ -28,6 +28,7 @@ import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; import org.apache.fop.fo.properties.Property; +import org.apache.fop.layoutmgr.BlockLevelEventProducer; /** * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_repeatable-page-master-reference"> @@ -40,6 +41,8 @@ public class RepeatablePageMasterReference extends FObj // The value of properties relevant for fo:repeatable-page-master-reference. private String masterReference; + // The simple page master referenced + private SimplePageMaster master; private Property maximumRepeats; // End of property values @@ -87,18 +90,15 @@ public class RepeatablePageMasterReference extends FObj } /** {@inheritDoc} */ - public String getNextPageMasterName(boolean isOddPage, + public SimplePageMaster getNextPageMaster(boolean isOddPage, boolean isFirstPage, boolean isLastPage, boolean isEmptyPage) { - if (getMaximumRepeats() != INFINITE) { - if (numberConsumed < getMaximumRepeats()) { - numberConsumed++; - } else { - return null; - } + if (getMaximumRepeats() != INFINITE && numberConsumed >= getMaximumRepeats()) { + return null; } - return masterReference; + numberConsumed++; + return master; } /** @@ -159,4 +159,27 @@ public class RepeatablePageMasterReference extends FObj } + /** {@inheritDoc} */ + public void resolveReferences(LayoutMasterSet layoutMasterSet) throws ValidationException { + master = layoutMasterSet.getSimplePageMaster(masterReference); + if (master == null) { + BlockLevelEventProducer.Provider.get( + getUserAgent().getEventBroadcaster()) + .noMatchingPageMaster(this, parent.getName(), masterReference, getLocator()); + } + + } + + /** {@inheritDoc} */ + public boolean canProcess(String flowName) { + return master.getRegion(FO_REGION_BODY).getRegionName().equals(flowName); + } + + /** {@inheritDoc} */ + public boolean isInfinite() { + return getMaximumRepeats() == INFINITE; + } + + + } diff --git a/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java b/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java index bd186db78..e38993487 100644 --- a/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java +++ b/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java @@ -21,7 +21,6 @@ package org.apache.fop.fo.pagination; // Java import java.util.HashMap; -import java.util.Iterator; import java.util.Map; import org.xml.sax.Locator; @@ -29,8 +28,8 @@ import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; import org.apache.fop.datatypes.Length; import org.apache.fop.datatypes.Numeric; -import org.apache.fop.datatypes.SimplePercentBaseContext; import org.apache.fop.datatypes.PercentBaseContext; +import org.apache.fop.datatypes.SimplePercentBaseContext; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; diff --git a/src/java/org/apache/fop/fo/pagination/SinglePageMasterReference.java b/src/java/org/apache/fop/fo/pagination/SinglePageMasterReference.java index be13455d7..a39949347 100644 --- a/src/java/org/apache/fop/fo/pagination/SinglePageMasterReference.java +++ b/src/java/org/apache/fop/fo/pagination/SinglePageMasterReference.java @@ -27,6 +27,7 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; +import org.apache.fop.layoutmgr.BlockLevelEventProducer; /** * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_single-page-master-reference"> @@ -39,6 +40,10 @@ public class SinglePageMasterReference extends FObj // The value of properties relevant for fo:single-page-master-reference. private String masterReference; + + // The simple page master referenced + private SimplePageMaster master; + // End of property values private static final int FIRST = 0; @@ -83,13 +88,13 @@ public class SinglePageMasterReference extends FObj } /** {@inheritDoc} */ - public String getNextPageMasterName(boolean isOddPage, + public SimplePageMaster getNextPageMaster(boolean isOddPage, boolean isFirstPage, boolean isLastPage, boolean isBlankPage) { if (this.state == FIRST) { this.state = DONE; - return masterReference; + return master; } else { return null; } @@ -133,5 +138,25 @@ public class SinglePageMasterReference extends FObj return FO_SINGLE_PAGE_MASTER_REFERENCE; } + /** {@inheritDoc} */ + public void resolveReferences(LayoutMasterSet layoutMasterSet) throws ValidationException { + master = layoutMasterSet.getSimplePageMaster(masterReference); + if (master == null) { + BlockLevelEventProducer.Provider.get( + getUserAgent().getEventBroadcaster()) + .noMatchingPageMaster(this, parent.getName(), masterReference, getLocator()); + } + } + + /** {@inheritDoc} */ + public boolean canProcess(String flowName) { + return master.getRegion(FO_REGION_BODY).getRegionName().equals(flowName); + } + + /** {@inheritDoc} */ + public boolean isInfinite() { + return false; + } + } diff --git a/src/java/org/apache/fop/fo/pagination/SubSequenceSpecifier.java b/src/java/org/apache/fop/fo/pagination/SubSequenceSpecifier.java index 2bb891cd9..330db3b94 100644 --- a/src/java/org/apache/fop/fo/pagination/SubSequenceSpecifier.java +++ b/src/java/org/apache/fop/fo/pagination/SubSequenceSpecifier.java @@ -19,6 +19,7 @@ package org.apache.fop.fo.pagination; +import org.apache.fop.fo.ValidationException; /** * Classes that implement this interface can be added to a {@link PageSequenceMaster}, @@ -36,7 +37,7 @@ public interface SubSequenceSpecifier { * @return the page master name * @throws PageProductionException if there's a problem determining the next page master */ - String getNextPageMasterName(boolean isOddPage, + SimplePageMaster getNextPageMaster(boolean isOddPage, boolean isFirstPage, boolean isLastPage, boolean isBlankPage) @@ -60,5 +61,26 @@ public interface SubSequenceSpecifier { /** @return true if the subsequence has a page master for page-position "only" */ boolean hasPagePositionOnly(); + /** + * called by the parent LayoutMasterSet to resolve object references + * from simple page master reference names + * @param layoutMasterSet the layout-master-set + * @throws ValidationException when a named reference cannot be resolved + * */ + void resolveReferences(LayoutMasterSet layoutMasterSet) throws ValidationException; + + /** + * + * @param flowName name of the main flow + * @return true iff page sequence is a finite sequence or can process the entire main flow + */ + boolean canProcess(String flowName); + + /** + * Test that this is a finite sequence + * @return true iff this is a finite sequence + */ + boolean isInfinite(); + } |