KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: Marker.java,v 1.6.2.8 2003/04/11 00:24:38 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.*;
55 import org.apache.fop.layout.*;
56 import org.apache.fop.apps.FOPException;
57
58 public class Marker extends FObjMixed {
59
60     private String JavaDoc markerClassName;
61     private Area registryArea;
62     private boolean isFirst;
63     private boolean isLast;
64
65     public static class Maker extends FObj.Maker {
66         public FObj make(FObj parent, PropertyList propertyList,
67                          String JavaDoc systemId, int line, int column)
68             throws FOPException {
69             return new Marker(parent, propertyList, systemId, line, column);
70         }
71
72     }
73
74     public static FObj.Maker maker() {
75         return new Marker.Maker();
76     }
77
78     public Marker(FObj parent, PropertyList propertyList,
79                   String JavaDoc systemId, int line, int column)
80         throws FOPException {
81         super(parent, propertyList, systemId, line, column);
82
83         // do check to see that 'this' is under fo:flow
84
85         this.markerClassName =
86             this.properties.get("marker-class-name").getString();
87
88         // check to ensure that no other marker with same parent
89 // has this 'marker-class-name' is in addMarker() method
90 parent.addMarker(this.markerClassName);
91     }
92
93     public String JavaDoc getName() {
94         return "fo:marker";
95     }
96
97     public int layout(Area area) throws FOPException {
98         // no layout action desired
99 this.registryArea = area;
100         area.getPage().registerMarker(this);
101         return Status.OK;
102     }
103
104     public int layoutMarker(Area area) throws FOPException {
105         if (this.marker == START)
106             this.marker = 0;
107
108         int numChildren = this.children.size();
109         for (int i = this.marker; i < numChildren; i++) {
110             FONode fo = (FONode)children.get(i);
111
112             int status;
113             if (Status.isIncomplete((status = fo.layout(area)))) {
114                 this.marker = i;
115                 return status;
116             }
117         }
118
119         return Status.OK;
120     }
121
122     public String JavaDoc getMarkerClassName() {
123         return markerClassName;
124     }
125
126     public Area getRegistryArea() {
127         return registryArea;
128     }
129
130     public boolean mayPrecedeMarker() {
131         return true;
132     }
133
134     // The page the marker was registered is put into the renderer
135 // queue. The marker is transferred to it's own marker list,
136 // release the area for GC. We also know now whether the area is
137 // first/last.
138 public void releaseRegistryArea() {
139         isFirst = registryArea.isFirst();
140         isLast = registryArea.isLast();
141         registryArea = null;
142     }
143     
144     // This has actually nothing to do with resseting this marker,
145 // but the 'marker' from FONode, marking layout status.
146 // Called in case layout is to be rolled back. Unregister this
147 // marker from the page, it isn't laid aout anyway.
148 public void resetMarker() {
149         if (registryArea != null ) {
150             Page page=registryArea.getPage();
151             if (page != null) {
152                 page.unregisterMarker(this);
153             }
154         }
155     }
156
157     // More hackery: reset layout status marker. Called before the
158 // content is laid out from RetrieveMarker.
159 public void resetMarkerContent() {
160         super.resetMarker();
161     }
162 }
163
Popular Tags