KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > fo > flow > RetrieveMarker


1 /*
2  * $Id: RetrieveMarker.java,v 1.6.2.10 2003/04/11 00:24:39 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.flow;
52
53 // FOP
54
import org.apache.fop.fo.FObj;
55 import org.apache.fop.fo.PropertyList;
56 import org.apache.fop.fo.Status;
57 import org.apache.fop.fo.pagination.PageSequence;
58 import org.apache.fop.fo.properties.RetrieveBoundary;
59 import org.apache.fop.fo.properties.RetrievePosition;
60 import org.apache.fop.layout.Area;
61 import org.apache.fop.layout.AreaTree;
62 import org.apache.fop.layout.Page;
63 import org.apache.fop.apps.FOPException;
64
65 // Java
66
import java.util.ArrayList JavaDoc;
67
68 public class RetrieveMarker extends FObj {
69
70     private String JavaDoc retrieveClassName;
71     private int retrievePosition;
72     private int retrieveBoundary;
73     private Marker bestMarker;
74
75     public static class Maker extends FObj.Maker {
76         public FObj make(FObj parent, PropertyList propertyList,
77                          String JavaDoc systemId, int line, int column)
78             throws FOPException {
79             return new RetrieveMarker(parent, propertyList,
80                                       systemId, line, column);
81         }
82
83     }
84
85     public static FObj.Maker maker() {
86         return new RetrieveMarker.Maker();
87     }
88
89     public RetrieveMarker(FObj parent, PropertyList propertyList,
90                           String JavaDoc systemId, int line, int column) {
91         super(parent, propertyList, systemId, line, column);
92
93         this.retrieveClassName =
94             this.properties.get("retrieve-class-name").getString();
95         this.retrievePosition =
96             this.properties.get("retrieve-position").getEnum();
97         this.retrieveBoundary =
98             this.properties.get("retrieve-boundary").getEnum();
99     }
100
101     public String JavaDoc getName() {
102         return "fo:retrieve-marker";
103     }
104
105     public int layout(Area area) throws FOPException {
106         if (marker == START) {
107             marker = 0;
108             // locate qualifying areas by 'marker-class-name' and
109
// 'retrieve-boundary'. Initially we will always check
110
// the containing page
111
Page containingPage = area.getPage();
112             bestMarker = searchPage(containingPage);
113
114             if (bestMarker != null) {
115                 bestMarker.resetMarkerContent();
116                 return bestMarker.layoutMarker(area);
117             }
118             // If marker not yet found, and 'retrieve-boundary' permits,
119
// search backward.
120
AreaTree areaTree = containingPage.getAreaTree();
121             if (retrieveBoundary == RetrieveBoundary.PAGE_SEQUENCE) {
122                 PageSequence pageSequence = areaTree.getCurrentPageSequence();
123                 if (pageSequence == containingPage.getPageSequence() ) {
124                     return layoutBestMarker(areaTree.getCurrentPageSequenceMarkers(),area);
125                 }
126             } else if (retrieveBoundary == RetrieveBoundary.DOCUMENT) {
127                 return layoutBestMarker(areaTree.getDocumentMarkers(),area);
128             } else if (retrieveBoundary != RetrieveBoundary.PAGE) {
129                 throw new FOPException("Illegal 'retrieve-boundary' value", systemId, line, column);
130             }
131         } else if (bestMarker != null) {
132             return bestMarker.layoutMarker(area);
133         }
134         return Status.OK;
135     }
136
137     private int layoutBestMarker(ArrayList JavaDoc markers, Area area)
138         throws FOPException {
139         if (markers!=null) {
140             for (int i = markers.size() - 1; i >= 0; i--) {
141                 Marker currentMarker = (Marker)markers.get(i);
142                 if (currentMarker.getMarkerClassName().equals(retrieveClassName)) {
143                     bestMarker = currentMarker;
144                     bestMarker.resetMarkerContent();
145                     return bestMarker.layoutMarker(area);
146                 }
147             }
148         }
149         return Status.OK;
150     }
151     
152     private Marker searchPage(Page page) throws FOPException {
153         ArrayList JavaDoc pageMarkers = page.getMarkers();
154         if (pageMarkers.isEmpty()) {
155             return null;
156         }
157
158         // search forward if 'first-starting-within-page' or
159
// 'first-including-carryover'
160
if (retrievePosition == RetrievePosition.FIC) {
161             for (int i = 0; i < pageMarkers.size(); i++) {
162                 Marker currentMarker = (Marker)pageMarkers.get(i);
163                 if (currentMarker.getMarkerClassName().equals(retrieveClassName)) {
164                     return currentMarker;
165                 }
166             }
167         } else if (retrievePosition == RetrievePosition.FSWP) {
168             for (int i = 0; i < pageMarkers.size(); i++) {
169                 Marker currentMarker = (Marker)pageMarkers.get(i);
170                 if (currentMarker.getMarkerClassName().equals(retrieveClassName)) {
171                     if (currentMarker.getRegistryArea().isFirst()) {
172                         return currentMarker;
173                     }
174                 }
175             }
176         } else if (retrievePosition == RetrievePosition.LSWP) {
177             for (int i = pageMarkers.size() - 1; i >= 0; i--) {
178                 Marker currentMarker = (Marker)pageMarkers.get(i);
179                 if (currentMarker.getMarkerClassName().equals(retrieveClassName)) {
180                     if (currentMarker.getRegistryArea().isFirst()) {
181                         return currentMarker;
182                     }
183                 }
184             }
185
186         } else if (retrievePosition == RetrievePosition.LEWP) {
187             for (int i = pageMarkers.size() - 1; i >= 0; i--) {
188                 Marker currentMarker = (Marker)pageMarkers.get(i);
189                 if (currentMarker.getMarkerClassName().equals(retrieveClassName)) {
190                     if (currentMarker.getRegistryArea().isLast()) {
191                         return currentMarker;
192                     }
193                 }
194             }
195
196         } else {
197             throw new FOPException("Illegal 'retrieve-position' value", systemId, line, column);
198         }
199         return null;
200     }
201
202 }
203
Popular Tags