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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* $Id$ */
package org.apache.fop.area;
import java.util.List;
import org.apache.fop.fo.pagination.RegionBody;
/**
* This class is a container for the areas that may be generated by
* an fo:region-body. It extends the RegionReference that is used
* directly by the other region classes.
* See fo:region-body definition in the XSL Rec for more information.
*/
public class BodyRegion extends RegionReference {
private static final long serialVersionUID = -1848872997724078080L;
private BeforeFloat beforeFloat; // optional
private MainReference mainReference; // mandatory
private Footnote footnote; // optional
private int columnGap;
private int columnCount;
/**
* Constructor which can read traits directly
* from an fo:region-body formatting object.
* @param rb the region-body FO node
* @param parent the parent region viewport
*/
public BodyRegion(RegionBody rb, RegionViewport parent) {
this(rb.getNameId(), rb.getRegionName(), parent, rb.getColumnCount(), rb.getColumnGap());
}
/**
* Constructor which can read traits directly
* from an fo:region-body formatting object.
* @param regionClass the region class (as returned by Region.getNameId())
* @param regionName the name of the region (as returned by Region.getRegionName())
* @param parent the parent region viewport
* @param columnCount the number of columns
* @param columnGap the gap between columns
*/
public BodyRegion(int regionClass, String regionName, RegionViewport parent,
int columnCount, int columnGap) {
super(regionClass, regionName, parent);
this.columnCount = columnCount;
this.columnGap = columnGap;
mainReference = new MainReference(this);
}
/**
* Get the number of columns when not spanning
*
* @return the number of columns
*/
public int getColumnCount() {
return this.columnCount;
}
/** @return the column-gap value */
public int getColumnGap() {
return this.columnGap;
}
/**
* Get the main reference area.
*
* @return the main reference area
*/
public MainReference getMainReference() {
return mainReference;
}
/**
* indicates whether the main reference area has any child areas added to it
*
* @return whether the main reference area has any child areas added to it
*/
public boolean isEmpty() {
return (mainReference == null || mainReference.isEmpty())
&& (footnote == null || footnote.isEmpty())
&& (beforeFloat == null || beforeFloat.isEmpty());
}
/**
* Get the before float area.
*
* @return the before float area
*/
public BeforeFloat getBeforeFloat() {
if (beforeFloat == null) {
beforeFloat = new BeforeFloat();
}
return beforeFloat;
}
/**
* Get the footnote area.
*
* @return the footnote area
*/
public Footnote getFootnote() {
if (footnote == null) {
footnote = new Footnote();
}
return footnote;
}
/**
* @return the available BPD in the main reference area after the previous span reference
* areas are subtracted.
*/
public int getRemainingBPD() {
int usedBPD = 0;
List spans = getMainReference().getSpans();
int previousSpanCount = spans.size() - 1;
for (int i = 0; i < previousSpanCount; i++) {
usedBPD += ((Span)spans.get(i)).getHeight();
}
return getBPD() - usedBPD;
}
/**
* Clone this object.
*
* @return a shallow copy of this object
*/
public Object clone() {
BodyRegion br = new BodyRegion(getRegionClass(), getRegionName(), regionViewport,
getColumnCount(), getColumnGap());
br.setCTM(getCTM());
br.setIPD(getIPD());
br.beforeFloat = beforeFloat;
br.mainReference = mainReference;
br.footnote = footnote;
return br;
}
}
|
