KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: RepeatablePageMasterReference.java,v 1.3.2.6 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 /**
57  * Class modeling the fo:repeatable-page-master-reference object.
58  *
59  * @see <a HREF="@XSLFO-STD@#fo_repeatable-page-master-reference"
60        target="_xslfostd">@XSLFO-STDID@
61  * &para;6.4.9</a>
62  */

63 public class RepeatablePageMasterReference extends PageMasterReference
64     implements SubSequenceSpecifier {
65
66     private static final int INFINITE = -1;
67
68     public static class Maker extends FObj.Maker {
69         public FObj make(FObj parent, PropertyList propertyList,
70                         String JavaDoc systemId, int line, int column)
71             throws FOPException {
72             return new RepeatablePageMasterReference(parent, propertyList,
73                                                      systemId, line, column);
74         }
75
76     }
77
78     public static FObj.Maker maker() {
79         return new RepeatablePageMasterReference.Maker();
80     }
81
82     private int maximumRepeats;
83     private int numberConsumed = 0;
84
85     public RepeatablePageMasterReference(FObj parent, PropertyList propertyList,
86                                          String JavaDoc systemId, int line, int column)
87         throws FOPException {
88         super(parent, propertyList, systemId, line, column);
89         if (getProperty("master-reference") != null) {
90             this.masterName = getProperty("master-reference").getString();
91             if (parent.getName().equals("fo:page-sequence-master")) {
92                 PageSequenceMaster pageSequenceMaster = (PageSequenceMaster)parent;
93                 pageSequenceMaster.addSubsequenceSpecifier(this);
94             } else {
95                 throw new FOPException("A fo:repeatable-page-master-reference must be child of fo:page-sequence-master, not "
96                                        + parent.getName(), systemId, line, column);
97             }
98         } else {
99           log.warn("A fo:repeatable-page-master-reference does not have a master-reference and so is being ignored");
100         }
101         String JavaDoc mr = getProperty("maximum-repeats").getString();
102         if (mr.equals("no-limit")) {
103             this.maximumRepeats = INFINITE;
104         } else {
105             try {
106                 this.maximumRepeats = Integer.parseInt(mr);
107                 if (this.maximumRepeats < 0) {
108                     log.debug("negative maximum-repeats: "+this.maximumRepeats);
109                     this.maximumRepeats = 0;
110                 }
111             } catch (NumberFormatException JavaDoc nfe) {
112                 throw new FOPException("Invalid number '" + mr
113                                        + "'for 'maximum-repeats' property",
114                                        systemId, line, column);
115             }
116         }
117     }
118
119     public String JavaDoc getName() {
120         return "fo:repeatable-page-master-reference";
121     }
122
123     public String JavaDoc getNextPageMasterName(boolean isOddPage,
124                                         boolean isFirstPage,
125                                         boolean isEmptyPage) {
126         if (maximumRepeats != INFINITE) {
127             if (numberConsumed < maximumRepeats) {
128                 numberConsumed++;
129             } else {
130                 return null;
131             }
132         }
133         return getMasterName();
134     }
135
136     public void reset() {
137         this.numberConsumed = 0;
138     }
139
140 }
141
Popular Tags