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
|
/*
* 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.ArrayList;
import java.util.List;
import org.apache.fop.fo.pagination.Region;
/**
* This is a region reference area for a page regions.
* This area is the direct child of a region-viewport-area. It is cloneable
* so the page master can make copies from the original page and regions.
*/
public class RegionReference extends Area implements Cloneable {
/** Reference to the region FO. */
//protected Region regionFO;
private int regionClass;
private String regionName;
private CTM ctm;
// the list of block areas from the static flow
private ArrayList blocks = new ArrayList();
/** the parent RegionViewport for this object */
protected RegionViewport regionViewport;
/**
* Create a new region reference area.
*
* @param regionFO the region.
* @param parent the viewport for this region.
*/
public RegionReference(Region regionFO, RegionViewport parent) {
this(regionFO.getNameId(), regionFO.getRegionName(), parent);
}
/**
* Create a new region reference area.
*
* @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 viewport for this region.
*/
public RegionReference(int regionClass, String regionName, RegionViewport parent) {
this.regionClass = regionClass;
this.regionName = regionName;
addTrait(Trait.IS_REFERENCE_AREA, Boolean.TRUE);
regionViewport = parent;
}
/** {@inheritDoc} */
public void addChildArea(Area child) {
blocks.add(child);
}
/** {@inheritDoc} */
public int getBPD() {
// subtract bpd of borders and padding before / after
return super.getBPD() - getBorderAndPaddingWidthBefore() - getBorderAndPaddingWidthAfter();
}
/** {@inheritDoc} */
public int getIPD() {
// subtract ipd of borders and padding start / end
return super.getIPD() - getBorderAndPaddingWidthStart() - getBorderAndPaddingWidthEnd();
}
/**
* Set the Coordinate Transformation Matrix which transforms content
* coordinates in this region reference area which are specified in
* terms of "start" and "before" into coordinates in a system which
* is positioned in "absolute" directions (with origin at lower left of
* the region reference area.
*
* @param ctm the current transform to position this region
*/
public void setCTM(CTM ctm) {
this.ctm = ctm;
}
/**
* @return Returns the parent RegionViewport.
*/
public RegionViewport getRegionViewport() {
return regionViewport;
}
/**
* Get the current transform of this region.
*
* @return ctm the current transform to position this region
*/
public CTM getCTM() {
return this.ctm;
}
/**
* Get the block in this region.
*
* @return the list of blocks in this region
*/
public List getBlocks() {
return blocks;
}
/**
* Get the region class of this region.
*
* @return the region class
*/
public int getRegionClass() {
return this.regionClass;
}
/** @return the region name */
public String getRegionName() {
return this.regionName;
}
/**
* Add a block area to this region reference area.
*
* @param block the block area to add
*/
public void addBlock(Block block) {
addChildArea(block);
}
/**
* Clone this region.
* This is used when cloning the page by the page master.
*
* @return a copy of this region reference area
*/
public Object clone() {
RegionReference rr = new RegionReference(regionClass, regionName, regionViewport);
rr.ctm = ctm;
rr.setIPD(getIPD());
rr.blocks = (ArrayList)blocks.clone();
return rr;
}
}
|
