blob: 5a089637e6839aab5360d3809f79118ff234b5a8 (
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
|
/*
* Copyright 1999-2004 The Apache Software Foundation.
*
* Licensed 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.fo.pagination;
// Java
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
// XML
import org.xml.sax.Attributes;
// FOP
import org.apache.fop.fo.FONode;
import org.apache.fop.fo.FObj;
import org.apache.fop.fo.FOTreeVisitor;
import org.apache.fop.apps.FOPException;
/**
* A simple-page-master formatting object.
* This creates a simple page from the specified regions
* and attributes.
*/
public class SimplePageMaster extends FObj {
/**
* Page regions (regionClass, Region)
*/
private Map regions;
private String masterName;
/**
* @see org.apache.fop.fo.FONode#FONode(FONode)
*/
public SimplePageMaster(FONode parent) {
super(parent);
}
/**
* @see org.apache.fop.fo.FObj#addProperties
*/
protected void addProperties(Attributes attlist) throws FOPException {
super.addProperties(attlist);
if (parent.getName().equals("fo:layout-master-set")) {
LayoutMasterSet layoutMasterSet = (LayoutMasterSet)parent;
masterName = this.propertyList.get(PR_MASTER_NAME).getString();
if (masterName == null) {
getLogger().warn("simple-page-master does not have "
+ "a master-name and so is being ignored");
} else {
layoutMasterSet.addSimplePageMaster(this);
}
} else {
throw new FOPException("fo:simple-page-master must be child "
+ "of fo:layout-master-set, not "
+ parent.getName());
}
//Well, there are only 5 regions so we can save a bit of memory here
regions = new HashMap(5);
}
/**
* @see org.apache.fop.fo.FObj#generatesReferenceAreas()
*/
public boolean generatesReferenceAreas() {
return true;
}
/**
* Returns the name of the simple-page-master.
* @return the page master name
*/
public String getMasterName() {
return masterName;
}
/**
* @see org.apache.fop.fo.FONode#addChildNode(FONode)
*/
protected void addChildNode(FONode child) {
if (child instanceof Region) {
addRegion((Region)child);
} else {
getLogger().error("SimplePageMaster cannot have child of type "
+ child.getName());
}
}
/**
* Adds a region to this simple-page-master.
* @param region region to add
*/
protected void addRegion(Region region) {
String key = String.valueOf(region.getRegionClassCode());
if (regions.containsKey(key)) {
getLogger().error("Only one region of class " + region.getRegionName()
+ " allowed within a simple-page-master. The duplicate"
+ " region (" + region.getName() + ") is ignored.");
} else {
regions.put(key, region);
}
}
/**
* Returns the region for a given region class.
* @param regionClass region class to lookup
* @return the region, null if it doesn't exist
*/
public Region getRegion(int regionId) {
return (Region) regions.get(String.valueOf(regionId));
}
/**
* Returns a Map of regions associated with this simple-page-master
* @return the regions
*/
public Map getRegions() {
return regions;
}
/**
* Indicates if a region with a given name exists in this
* simple-page-master.
* @param regionName name of the region to lookup
* @return True if a region with this name exists
*/
protected boolean regionNameExists(String regionName) {
for (Iterator regenum = regions.values().iterator();
regenum.hasNext();) {
Region r = (Region)regenum.next();
if (r.getRegionName().equals(regionName)) {
return true;
}
}
return false;
}
/**
* This is a hook for an FOTreeVisitor subclass to be able to access
* this object.
* @param fotv the FOTreeVisitor subclass that can access this object.
* @see org.apache.fop.fo.FOTreeVisitor
*/
public void acceptVisitor(FOTreeVisitor fotv) {
fotv.serveSimplePageMaster(this);
}
public String getName() {
return "fo:simple-page-master";
}
}
|
