KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: ConditionalPageMasterReference.java,v 1.5.2.8 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.fo.properties.*;
55 import org.apache.fop.apps.FOPException;
56
57 /**
58  * Class modeling the fo:conditional-page-master-reference object.
59  *
60  * @see <a HREF="@XSLFO-STD@#fo_conditional-page-master-reference"
61        target="_xslfostd">@XSLFO-STDID@
62  * &para;6.4.11</a>
63  */

64 public class ConditionalPageMasterReference extends FObj {
65
66     public static class Maker extends FObj.Maker {
67         public FObj make(FObj parent, PropertyList propertyList,
68                         String JavaDoc systemId, int line, int column)
69             throws FOPException {
70             return new ConditionalPageMasterReference(parent, propertyList,
71                                                       systemId, line, column);
72         }
73
74     }
75
76     public static FObj.Maker maker() {
77         return new ConditionalPageMasterReference.Maker();
78     }
79
80     private RepeatablePageMasterAlternatives repeatablePageMasterAlternatives;
81
82     private String JavaDoc masterName;
83
84     private int pagePosition;
85     private int oddOrEven;
86     private int blankOrNotBlank;
87
88     public ConditionalPageMasterReference(FObj parent, PropertyList propertyList,
89                                           String JavaDoc systemId, int line, int column)
90         throws FOPException {
91         super(parent, propertyList, systemId, line, column);
92
93         if (getProperty("master-reference") != null) {
94             this.masterName = getProperty("master-reference").getString();
95         }
96         if (parent.getName().equals("fo:repeatable-page-master-alternatives")) {
97             this.repeatablePageMasterAlternatives =
98                 (RepeatablePageMasterAlternatives)parent;
99             if (masterName == null) {
100                 log.warn("A fo:conditional-page-master-reference does not have a master-reference and so is being ignored");
101             } else {
102                 this.repeatablePageMasterAlternatives.addConditionalPageMasterReference(this);
103             }
104         } else {
105             throw new FOPException("fo:conditional-page-master-reference must be child "
106                                    + "of fo:repeatable-page-master-alternatives, not "
107                                    + parent.getName(), systemId, line, column);
108         }
109         this.pagePosition = this.properties.get("page-position").getEnum();
110         this.oddOrEven = this.properties.get("odd-or-even").getEnum();
111         this.blankOrNotBlank = this.properties.get("blank-or-not-blank").getEnum();
112     }
113
114     public String JavaDoc getName() {
115         return "fo:conditional-page-master-reference";
116     }
117
118     protected boolean isValid(boolean isOddPage, boolean isFirstPage,
119                               boolean isEmptyPage) {
120         // page-position
121
if( isFirstPage ) {
122             if (pagePosition==PagePosition.REST) {
123                 return false;
124             } else if (pagePosition==PagePosition.LAST) {
125                 // how the hell do you know at this point?
126
log.warn("conditional-page-master-reference: page-position='last' is not yet implemented (NYI)");
127                 return false;
128             }
129         } else {
130             if (pagePosition==PagePosition.FIRST) {
131                 return false;
132             } else if (pagePosition==PagePosition.LAST) {
133                 // how the hell do you know at this point?
134
log.warn("conditional-page-master-reference: page-position='last' is not yet implemented (NYI)");
135                 // potentially valid, don't return
136
}
137         }
138
139         // odd-or-even
140
if (isOddPage) {
141             if (oddOrEven==OddOrEven.EVEN) {
142               return false;
143             }
144         } else {
145             if (oddOrEven==OddOrEven.ODD) {
146               return false;
147             }
148         }
149
150         // blank-or-not-blank
151
if (isEmptyPage) {
152             if (blankOrNotBlank==BlankOrNotBlank.NOT_BLANK) {
153                 return false;
154             }
155         } else {
156             if (blankOrNotBlank==BlankOrNotBlank.BLANK) {
157                 return false;
158             }
159         }
160
161         return true;
162
163     }
164
165     protected int getPagePosition() {
166         return this.pagePosition;
167     }
168
169     protected int getOddOrEven() {
170         return this.oddOrEven;
171     }
172
173     protected int getBlankOrNotBlank() {
174         return this.blankOrNotBlank;
175     }
176
177     public String JavaDoc getMasterName() {
178         return masterName;
179     }
180 }
181
Popular Tags