KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > fo > pagination > PageSequenceMaster


1 /*
2  * $Id: PageSequenceMaster.java,v 1.6.2.7 2003/04/11 00:24:41 pietsch Exp $
3  * ============================================================================
4  * The Apache Software License, Version 1.1
5  * ============================================================================
6  *
7  * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without modifica-
10  * tion, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if any, must
20  * include the following acknowledgment: "This product includes software
21  * developed by the Apache Software Foundation (http://www.apache.org/)."
22  * Alternately, this acknowledgment may appear in the software itself, if
23  * and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. The names "FOP" and "Apache Software Foundation" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * apache@apache.org.
29  *
30  * 5. Products derived from this software may not be called "Apache", nor may
31  * "Apache" appear in their name, without prior written permission of the
32  * Apache Software Foundation.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  * ============================================================================
45  *
46  * This software consists of voluntary contributions made by many individuals
47  * on behalf of the Apache Software Foundation and was originally created by
48  * James Tauber <jtauber@jtauber.com>. For more information on the Apache
49  * Software Foundation, please see <http://www.apache.org/>.
50  */

51 package org.apache.fop.fo.pagination;
52
53 // FOP
54
import org.apache.fop.fo.*;
55 import org.apache.fop.apps.FOPException;
56
57 // Java
58
import java.util.ArrayList JavaDoc;
59
60 /**
61  * Class modeling the fo:page-sequence-master object.
62  *
63  * @see <a HREF="@XSLFO-STD@#fo_page-sequence-master"
64        target="_xslfostd">@XSLFO-STDID@
65  * &para;6.4.7</a>
66  */

67 public class PageSequenceMaster extends FObj {
68
69     public static class Maker extends FObj.Maker {
70         public FObj make(FObj parent, PropertyList propertyList,
71                         String JavaDoc systemId, int line, int column)
72             throws FOPException {
73             return new PageSequenceMaster(parent, propertyList,
74                                           systemId, line, column);
75         }
76
77     }
78
79     public static FObj.Maker maker() {
80         return new PageSequenceMaster.Maker();
81     }
82
83     private LayoutMasterSet layoutMasterSet;
84     private ArrayList JavaDoc subSequenceSpecifiers;
85     private SubSequenceSpecifier currentSubSequence;
86     private int currentSubSequenceNumber;
87     private String JavaDoc masterName;
88
89     // The terminology may be confusing. A 'page-sequence-master' consists
90
// of a sequence of what the XSL spec refers to as
91
// 'sub-sequence-specifiers'. These are, in fact, simple or complex
92
// references to page-masters. So the methods use the former
93
// terminology ('sub-sequence-specifiers', or SSS),
94
// but the actual FO's are MasterReferences.
95
protected PageSequenceMaster(FObj parent, PropertyList propertyList,
96                                  String JavaDoc systemId, int line, int column)
97             throws FOPException {
98         super(parent, propertyList, systemId, line, column);
99
100         if (parent.getName().equals("fo:layout-master-set")) {
101             this.layoutMasterSet = (LayoutMasterSet)parent;
102             this.masterName = this.properties.get("master-name").getString();
103             if (this.masterName == null) {
104                 log.warn("page-sequence-master does not have "
105                          + "a page-master-name and so is being ignored");
106             } else {
107                 this.layoutMasterSet.addPageSequenceMaster(masterName, this);
108             }
109         } else {
110             throw new FOPException("fo:page-sequence-master must be child "
111                                    + "of fo:layout-master-set, not "
112                                    + parent.getName(), systemId, line, column);
113         }
114         subSequenceSpecifiers = new ArrayList JavaDoc();
115         currentSubSequenceNumber = -1;
116         currentSubSequence = null;
117     }
118
119     protected void addSubsequenceSpecifier(SubSequenceSpecifier pageMasterReference) {
120         subSequenceSpecifiers.add(pageMasterReference);
121     }
122
123     protected SubSequenceSpecifier getNextSubSequence() {
124         currentSubSequenceNumber++;
125         if (currentSubSequenceNumber >= 0
126             && currentSubSequenceNumber < subSequenceSpecifiers.size()) {
127             return (SubSequenceSpecifier)subSequenceSpecifiers
128               .get(currentSubSequenceNumber);
129         }
130         return null;
131     }
132
133     public void reset() {
134         currentSubSequenceNumber = -1;
135         currentSubSequence = null;
136         for (int i = 0; i< subSequenceSpecifiers.size(); i++ ) {
137             ((SubSequenceSpecifier)subSequenceSpecifiers.get(i)).reset();
138         }
139     }
140
141     public SimplePageMaster getNextSimplePageMaster(boolean oddPage,
142                                                     boolean blankPage)
143       throws FOPException {
144         boolean firstPage = false;
145         if (currentSubSequence==null) {
146             currentSubSequence = getNextSubSequence();
147             if (currentSubSequence==null) {
148                 throw new FOPException("no subsequences in page-sequence-master '"
149                                        + masterName + "'", systemId, line, column);
150             }
151             firstPage = true;
152         }
153         String JavaDoc pageMasterName = currentSubSequence
154           .getNextPageMasterName(oddPage, firstPage, blankPage);
155         boolean canRecover = true;
156         while (pageMasterName==null) {
157             SubSequenceSpecifier nextSubSequence = getNextSubSequence();
158             firstPage = true;
159             if (nextSubSequence==null) {
160                 if (!canRecover) {
161                     throw new FOPException("subsequences exhausted in page-sequence-master '"
162                                            + masterName
163                                            + "', cannot recover", systemId, line, column);
164                 }
165                 log.warn("subsequences exhausted in page-sequence-master '"
166                          + masterName
167                          + "', use previous subsequence");
168                 currentSubSequence.reset();
169                 canRecover = false;
170             } else {
171                 currentSubSequence = nextSubSequence;
172             }
173             pageMasterName = currentSubSequence
174               .getNextPageMasterName(oddPage, firstPage, blankPage);
175         }
176         SimplePageMaster pageMaster=this.layoutMasterSet
177           .getSimplePageMaster(pageMasterName);
178         if (pageMaster==null) {
179             throw new FOPException("No simple-page-master matching '"
180                                    + pageMasterName + "' in page-sequence-master '"
181                                    + masterName +"'", systemId, line, column);
182         }
183         return pageMaster;
184     }
185
186     public String JavaDoc getName() {
187         return "fo:page-sequence-master";
188     }
189
190 }
191
Popular Tags