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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
/*
* 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.pdf;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import org.apache.fop.accessibility.StructureTreeElement;
import org.apache.fop.pdf.StandardStructureAttributes.Table;
import org.apache.fop.util.LanguageTags;
/**
* Class representing a PDF Structure Element.
*/
public class PDFStructElem extends StructureHierarchyMember
implements StructureTreeElement, CompressedObject {
private StructureType structureType;
private PDFStructElem parentElement;
/**
* Elements to be added to the kids array.
*/
protected List<PDFObject> kids;
private List<PDFDictionary> attributes;
/**
* Creates a new structure element.
*
* @param parent parent of this element
* @param structureType the structure type of this element
*/
public PDFStructElem(PDFObject parent, StructureType structureType) {
this(parent);
this.structureType = structureType;
put("S", structureType.getName());
setParent(parent);
}
private PDFStructElem(PDFObject parent) {
if (parent instanceof PDFStructElem) {
parentElement = (PDFStructElem) parent;
}
}
/**
* Returns the parent of this structure element.
*
* @return the parent, <code>null</code> if the parent is not a structure
* element (i.e., is the structure tree root)
*/
public PDFStructElem getParentStructElem() {
return parentElement;
}
/** {@inheritDoc} */
public void setParent(PDFObject parent) {
if (parent != null && parent.hasObjectNumber()) {
put("P", new PDFReference(parent));
}
}
/**
* Adds a kid to this structure element.
*
* @param kid element to be added
*/
@Override
public void addKid(PDFObject kid) {
if (kids == null) {
kids = new ArrayList<PDFObject>();
}
kids.add(kid);
}
/**
* Sets the given mcid as the kid of this structure element. This element
* will then add itself to its parent structure element if it has not
* already, and so will the parent, and so on.
*
* @param mcid mcid of the marked-content sequence corresponding to this
* structure element's kid
*/
public void setMCIDKid(int mcid) {
put("K", mcid);
}
/**
* Sets the page reference of this structure element.
*
* @param page value for the Pg entry
*/
public void setPage(PDFPage page) {
put("Pg", page);
}
/**
* Returns the structure type of this structure element.
*
* @return the value of the S entry
*/
public StructureType getStructureType() {
return structureType;
}
/**
* Sets the language of this structure element.
* @param language the language (as defined in the section about
* "Natural Language Specification")
*/
private void setLanguage(String language) {
put("Lang", language);
}
/**
* Sets the language of this structure element.
*
* @param language a value for the Lang entry
*/
public void setLanguage(Locale language) {
setLanguage(LanguageTags.toLanguageTag(language));
}
/**
* Returns the language of this structure element.
*
* @return the value of the Lang entry (<code>null</code> if no language was specified)
*/
public String getLanguage() {
return (String) get("Lang");
}
@Override
protected void writeDictionary(OutputStream out, StringBuilder textBuffer) throws IOException {
attachKids();
attachAttributes();
super.writeDictionary(out, textBuffer);
}
private void attachAttributes() {
if (attributes != null) {
if (attributes.size() == 1) {
put("A", attributes.get(0));
} else {
PDFArray array = new PDFArray(attributes);
put("A", array);
}
}
}
/**
* Attaches all valid kids to the kids array.
*
* @return true iff 1+ kids were added to the kids array
*/
protected boolean attachKids() {
List<PDFObject> validKids = new ArrayList<PDFObject>();
if (kids != null) {
for (PDFObject kid : kids) {
if (kid instanceof Placeholder) {
if (((Placeholder) kid).attachKids()) {
validKids.add(kid);
}
} else {
validKids.add(kid);
}
}
}
boolean kidsAttached = !validKids.isEmpty();
if (kidsAttached) {
PDFArray array = new PDFArray();
for (PDFObject ob : validKids) {
array.add(ob);
}
put("K", array);
}
return kidsAttached;
}
public void setTableAttributeColSpan(int colSpan) {
setTableAttributeRowColumnSpan("ColSpan", colSpan);
}
public void setTableAttributeRowSpan(int rowSpan) {
setTableAttributeRowColumnSpan("RowSpan", rowSpan);
}
private void setTableAttributeRowColumnSpan(String typeSpan, int span) {
PDFDictionary attribute = new PDFDictionary();
attribute.put("O", Table.NAME);
attribute.put(typeSpan, span);
if (attributes == null) {
attributes = new ArrayList<PDFDictionary>(2);
}
attributes.add(attribute);
}
/**
* Class representing a placeholder for a PDF Structure Element.
*/
public static class Placeholder extends PDFStructElem {
@Override
public void outputInline(OutputStream out, StringBuilder textBuffer) throws IOException {
if (kids != null) {
assert kids.size() > 0;
for (int i = 0; i < kids.size(); i++) {
if (i > 0) {
textBuffer.append(' ');
}
Object obj = kids.get(i);
formatObject(obj, out, textBuffer);
}
}
}
public Placeholder(PDFObject parent) {
super(parent);
}
}
}
|