aboutsummaryrefslogtreecommitdiffstats
path: root/src/org/apache/fop/fo/flow/Flow.java
blob: 716e58f8ab92899908601cba066c4df44de2cc6b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
/*-- $Id$
 * Copyright (C) 2001 The Apache Software Foundation. All rights reserved.
 * For details on use and redistribution please refer to the
 * LICENSE file included with these sources.
 */

package org.apache.fop.fo.flow;

// FOP
import org.apache.fop.fo.*;
import org.apache.fop.fo.properties.*;
import org.apache.fop.fo.pagination.*;
import org.apache.fop.layout.Area;
import org.apache.fop.layout.BodyAreaContainer;
import org.apache.fop.apps.FOPException;
import org.apache.fop.messaging.MessageHandler;

// Java
import java.util.Hashtable;
import java.util.Enumeration;
import java.util.Vector;

public class Flow extends FObj {
	
    public static class Maker extends FObj.Maker {
	public FObj make(FObj parent, PropertyList propertyList)
	    throws FOPException {
	    return new Flow(parent, propertyList);
	}
    }

    public static FObj.Maker maker() {
	return new Flow.Maker();
    }

    /** PageSequence container */
    private PageSequence pageSequence;

    /**  Area in which we lay out our kids */
    private Area area; 

    /**  Vector to store snapshot */
    private Vector markerSnapshot; 

    /** flow-name attribute */
    private String _flowName;
    
    private Status _status = new Status(Status.AREA_FULL_NONE);
    

    protected Flow(FObj parent, PropertyList propertyList)
	throws FOPException {
	super(parent, propertyList);
	this.name =  getElementName();

	if (parent.getName().equals("fo:page-sequence")) {
	    this.pageSequence = (PageSequence) parent;
	} else {
	    throw new FOPException("flow must be child of "
				   + "page-sequence, not "
				   + parent.getName());
	} 
	setFlowName(getProperty("flow-name").getString());

	// according to communication from Paul Grosso (XSL-List,
	// 001228, Number 406), confusion in spec section 6.4.5 about
	// multiplicity of fo:flow in XSL 1.0 is cleared up - one (1)
	// fo:flow per fo:page-sequence only.
	
	if (pageSequence.isFlowSet()) {
	    if (this.name.equals("fo:flow")) {
		throw new FOPException("Only a single fo:flow permitted"
				       + " per fo:page-sequence");
	    }
	    else {
		throw new FOPException(this.name+" not allowed after fo:flow");
	    }
	}
	pageSequence.addFlow(this);
    }

    protected void setFlowName(String name)
	throws FOPException
    {
	if (name == null || name.equals("")) {
	    MessageHandler.errorln("WARNING: A 'flow-name' is required for "+getElementName()+". This constraint will be enforced in future versions of FOP");
	    _flowName = "xsl-region-body";
 	}
	else {
	    _flowName = name;
	}
	
    }
    
    public String getFlowName() 
    {
	return _flowName;
    }
    
    public Status layout(Area area) throws FOPException {
	return layout(area, null);
	
    }
    
    public Status layout(Area area, Region region) throws FOPException {
		if (this.marker == START) {
			this.marker = 0;
		}
	
		// flow is *always* laid out into a BodyAreaContainer
		BodyAreaContainer bac = (BodyAreaContainer)area;

		boolean prevChildMustKeepWithNext = false;
		Vector pageMarker = this.getMarkerSnapshot(new Vector());

		int numChildren = this.children.size();
		if (numChildren == 0)
		{
			throw new FOPException("fo:flow must contain block-level children");
		}
		for (int i = this.marker; i < numChildren; i++) {
			FObj fo = (FObj) children.elementAt(i);

			if (bac.isBalancingRequired(fo))
			{
				// reset the the just-done span area in preparation
				// for a backtrack for balancing
				bac.resetSpanArea();
				
				this.rollback(markerSnapshot);
				// one less because of the "continue"
				i = this.marker - 1;
				continue;
			}
			// current column area
			Area currentArea = bac.getNextArea(fo);
			// temporary hack for IDReferences
			currentArea.setIDReferences(bac.getIDReferences());
			if (bac.isNewSpanArea())
			{
				this.marker = i;
				markerSnapshot = this.getMarkerSnapshot(new Vector());
			}
			
			_status = fo.layout(currentArea);

/*		    if((_status.isPageBreak() || i == numChildren - 1) && bac.needsFootnoteAdjusting()) {
		        bac.adjustFootnoteArea();
		        this.rollback(pageMarker);
		        i = this.marker - 1;
		        Area mainReferenceArea = bac.getMainReferenceArea();
		        // remove areas
		        continue;
		    }*/
			if (_status.isIncomplete()) {
				if ((prevChildMustKeepWithNext) && (_status.laidOutNone())) {
					this.marker = i - 1;
					FObj prevChild = (FObj) children.elementAt(this.marker);
					prevChild.removeAreas();
					prevChild.resetMarker();
					prevChild.removeID(area.getIDReferences());
					_status = new Status(Status.AREA_FULL_SOME);
					return _status;
					// should probably return AREA_FULL_NONE if first
					// or perhaps an entirely new status code
				}
				if (bac.isLastColumn())
					if (_status.getCode() == Status.FORCE_COLUMN_BREAK) {
						this.marker = i;
						_status = new Status(Status.FORCE_PAGE_BREAK);	// same thing
						return _status;
					}
					else {
						this.marker = i;
						return _status;
					}
				else
				{
					// not the last column, but could be page breaks
					if (_status.isPageBreak())
					{
						this.marker = i;
						return _status;
					}
					// I don't much like exposing this. (AHS 001217)
					((org.apache.fop.layout.ColumnArea)currentArea).incrementSpanIndex();
					i--;
				}
			}
			if (_status.getCode() == Status.KEEP_WITH_NEXT) {
				prevChildMustKeepWithNext = true;
			}
			else {
				prevChildMustKeepWithNext = false;
			}
		}
		return _status;
    }

  /**
   * Return the content width of this flow (really of the region
   * in which it is flowing).
   */
  public int getContentWidth() {
    if (area != null)
      return area.getContentWidth(); //getAllocationWidth()??
    else return 0;  // not laid out yet
  }
    
    protected String getElementName() 
    {
	return "fo:flow";
    }
    
    public Status getStatus() 
    {
	return _status;
    }
    

  public boolean generatesReferenceAreas() {
	return true;
  }

}