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
|
/*
* 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.fo.pagination;
// Java
import java.awt.Rectangle;
import org.apache.fop.apps.FOPException;
import org.apache.fop.datatypes.FODimension;
import org.apache.fop.datatypes.Length;
import org.apache.fop.datatypes.LengthBase;
import org.apache.fop.datatypes.Numeric;
import org.apache.fop.datatypes.PercentBaseContext;
import org.apache.fop.fo.FONode;
import org.apache.fop.fo.PropertyList;
import org.apache.fop.fo.properties.CommonMarginBlock;
/**
* Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_region-body">
* <code>fo:region-body</code></a> object.
*/
public class RegionBody extends Region {
// The value of properties relevant for fo:region-body.
private CommonMarginBlock commonMarginBlock;
private Numeric columnCount;
private Length columnGap;
// End of property values
/**
* Create a RegionBody instance that is a child of the
* given parent {@link FONode}.
* @param parent the {@link FONode} that is to be the parent
*/
public RegionBody(FONode parent) {
super(parent);
}
/** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
commonMarginBlock = pList.getMarginBlockProps();
columnCount = pList.get(PR_COLUMN_COUNT).getNumeric();
columnGap = pList.get(PR_COLUMN_GAP).getLength();
if ((getColumnCount() > 1) && (getOverflow() == EN_SCROLL)) {
/* This is an error (See XSL Rec, fo:region-body description).
* The Rec allows for acting as if "1" is chosen in
* these cases, but we will need to be able to change Numeric
* values in order to do this.
*/
getFOValidationEventProducer().columnCountErrorOnRegionBodyOverflowScroll(this,
getName(), getLocator());
}
}
/**
* Return the {@link CommonMarginBlock} instance attached to
* this instance.
* @return the {@link CommonMarginBlock} instance
*/
public CommonMarginBlock getCommonMarginBlock() {
return commonMarginBlock;
}
/**
* Return the value of the <code>column-count<code> property.
* @return the "column-count" property.
*/
public int getColumnCount() {
return columnCount.getValue();
}
/**
* Return the value of the <code>column-gap</code> property.
* @return the "column-gap" property.
*/
public int getColumnGap() {
return columnGap.getValue();
}
/** {@inheritDoc} */
public Rectangle getViewportRectangle (FODimension reldims, SimplePageMaster spm) {
/* Special rules apply to resolving margins in the page context.
* Contrary to normal margins in this case top and bottom margin
* are resolved relative to the height. In the property subsystem
* all margin properties are configured to using BLOCK_WIDTH.
* That's why we 'cheat' here and setup a context for the height but
* use the LengthBase.BLOCK_WIDTH.
* Also the values are resolved relative to the page size
* and reference orientation.
*/
PercentBaseContext pageWidthContext = getPageWidthContext(LengthBase.CONTAINING_BLOCK_WIDTH);
PercentBaseContext pageHeightContext = getPageHeightContext(LengthBase.CONTAINING_BLOCK_WIDTH);
int start;
int end;
if (spm.getWritingMode() == EN_LR_TB) { // Left-to-right
start = commonMarginBlock.marginLeft.getValue(pageWidthContext);
end = commonMarginBlock.marginRight.getValue(pageWidthContext);
} else { // all other supported modes are right-to-left
start = commonMarginBlock.marginRight.getValue(pageWidthContext);
end = commonMarginBlock.marginLeft.getValue(pageWidthContext);
}
int before = commonMarginBlock.spaceBefore.getOptimum(pageHeightContext)
.getLength().getValue(pageHeightContext);
int after = commonMarginBlock.spaceAfter.getOptimum(pageHeightContext)
.getLength().getValue(pageHeightContext);
return new Rectangle(start, before,
reldims.ipd - start - end,
reldims.bpd - before - after);
}
/** {@inheritDoc} */
protected String getDefaultRegionName() {
return "xsl-region-body";
}
/** {@inheritDoc} */
public String getLocalName() {
return "region-body";
}
/**
* {@inheritDoc}
* @return {@link org.apache.fop.fo.Constants#FO_REGION_BODY}
*/
public int getNameId() {
return FO_REGION_BODY;
}
}
|
