KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: RepeatablePageMasterAlternatives.java,v 1.7.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 import org.apache.fop.fo.*;
54 import org.apache.fop.apps.FOPException;
55
56 // Java
57
import java.util.ArrayList JavaDoc;
58
59 /**
60  * Class modeling the fo:repeatable-page-master-alternatives object.
61  *
62  * @see <a HREF="@XSLFO-STD@#fo_repeatable-page-master-alternatives"
63  * target="_xslfostd">@XSLFO-STDID@
64  * &para;6.4.10</a>
65  */

66 public class RepeatablePageMasterAlternatives extends FObj
67     implements SubSequenceSpecifier {
68
69     private static final int INFINITE = -1;
70
71
72     public static class Maker extends FObj.Maker {
73         public FObj make(FObj parent, PropertyList propertyList,
74                         String JavaDoc systemId, int line, int column)
75             throws FOPException {
76             return new RepeatablePageMasterAlternatives(parent, propertyList,
77                                                         systemId, line, column);
78         }
79
80     }
81
82     public static FObj.Maker maker() {
83         return new RepeatablePageMasterAlternatives.Maker();
84     }
85
86     private PageSequenceMaster pageSequenceMaster;
87
88     /**
89      * Max times this page master can be repeated.
90      * INFINITE is used for the unbounded case
91      */

92     private int maximumRepeats;
93     private int numberConsumed = 0;
94
95     private ArrayList JavaDoc conditionalPageMasterRefs;
96
97     public RepeatablePageMasterAlternatives(FObj parent, PropertyList propertyList,
98                                             String JavaDoc systemId, int line, int column)
99         throws FOPException {
100         super(parent, propertyList, systemId, line, column);
101
102         if (parent.getName().equals("fo:page-sequence-master")) {
103             this.pageSequenceMaster = (PageSequenceMaster)parent;
104             this.pageSequenceMaster.addSubsequenceSpecifier(this);
105         } else {
106             throw new FOPException("A fo:repeatable-page-master-alternatives"
107                                    + "must be child of fo:page-sequence-master, not "
108                                    + parent.getName(), systemId, line, column);
109         }
110
111         String JavaDoc mr = getProperty("maximum-repeats").getString();
112         if (mr.equals("no-limit")) {
113             this.maximumRepeats=INFINITE;
114         } else {
115             try {
116                 this.maximumRepeats = Integer.parseInt(mr);
117                 if (this.maximumRepeats < 0) {
118                     log.debug("negative maximum-repeats: "+this.maximumRepeats);
119                     this.maximumRepeats = 0;
120                 }
121             } catch (NumberFormatException JavaDoc nfe) {
122                 throw new FOPException("Invalid number for "
123                                        + "'maximum-repeats' property", systemId, line, column);
124             }
125         }
126         conditionalPageMasterRefs = new ArrayList JavaDoc();
127     }
128
129     public String JavaDoc getName() {
130         return "fo:repeatable-page-master-alternatives";
131     }
132
133     public void addConditionalPageMasterReference(ConditionalPageMasterReference cpmr) {
134         this.conditionalPageMasterRefs.add(cpmr);
135     }
136
137     public String JavaDoc getNextPageMasterName(boolean isOddPage,
138                                         boolean isFirstPage,
139                                         boolean isEmptyPage) {
140         if (maximumRepeats != -1) {
141             if (numberConsumed < maximumRepeats) {
142                 numberConsumed++;
143             } else {
144                 return null;
145             }
146         }
147
148         for (int i = 0; i < conditionalPageMasterRefs.size(); i++) {
149             ConditionalPageMasterReference cpmr =
150                 (ConditionalPageMasterReference)conditionalPageMasterRefs.get(i);
151             if (cpmr.isValid(isOddPage, isFirstPage, isEmptyPage)) {
152                 return cpmr.getMasterName();
153             }
154         }
155         return null;
156     }
157
158     public void reset() {
159         this.numberConsumed = 0;
160     }
161
162 }
163
Popular Tags