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
|
/*
* 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.render.pdf;
import java.awt.Rectangle;
import java.awt.geom.Point2D;
import java.awt.geom.Rectangle2D;
import java.util.Iterator;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.fop.pdf.PDFAction;
import org.apache.fop.pdf.PDFDocument;
import org.apache.fop.pdf.PDFFactory;
import org.apache.fop.pdf.PDFGoTo;
import org.apache.fop.pdf.PDFLink;
import org.apache.fop.pdf.PDFOutline;
import org.apache.fop.render.intermediate.IFDocumentNavigationHandler;
import org.apache.fop.render.intermediate.IFException;
import org.apache.fop.render.intermediate.extensions.AbstractAction;
import org.apache.fop.render.intermediate.extensions.Bookmark;
import org.apache.fop.render.intermediate.extensions.BookmarkTree;
import org.apache.fop.render.intermediate.extensions.GoToXYAction;
import org.apache.fop.render.intermediate.extensions.Link;
import org.apache.fop.render.intermediate.extensions.NamedDestination;
import org.apache.fop.render.intermediate.extensions.URIAction;
import org.apache.fop.render.pdf.PDFDocumentHandler.PageReference;
/**
* Implementation of the {@link IFDocumentNavigationHandler} interface for PDF output.
*/
public class PDFDocumentNavigationHandler implements IFDocumentNavigationHandler {
private static Log log = LogFactory.getLog(PDFDocumentHandler.class);
private final PDFDocumentHandler documentHandler;
private final Map incompleteActions = new java.util.HashMap();
private final Map completeActions = new java.util.HashMap();
/**
* Default constructor.
* @param documentHandler the parent document handler
*/
public PDFDocumentNavigationHandler(PDFDocumentHandler documentHandler) {
super();
this.documentHandler = documentHandler;
}
PDFDocument getPDFDoc() {
return this.documentHandler.pdfDoc;
}
/** {@inheritDoc} */
public void renderNamedDestination(NamedDestination destination) throws IFException {
PDFAction action = getAction(destination.getAction());
getPDFDoc().getFactory().makeDestination(
destination.getName(), action.makeReference());
}
/** {@inheritDoc} */
public void renderBookmarkTree(BookmarkTree tree) throws IFException {
Iterator iter = tree.getBookmarks().iterator();
while (iter.hasNext()) {
Bookmark b = (Bookmark)iter.next();
renderBookmark(b, null);
}
}
private void renderBookmark(Bookmark bookmark, PDFOutline parent) {
if (parent == null) {
parent = getPDFDoc().getOutlineRoot();
}
PDFAction action = getAction(bookmark.getAction());
String actionRef = (action != null ? action.makeReference().toString() : null);
PDFOutline pdfOutline = getPDFDoc().getFactory().makeOutline(parent,
bookmark.getTitle(), actionRef, bookmark.isShown());
Iterator iter = bookmark.getChildBookmarks().iterator();
while (iter.hasNext()) {
Bookmark b = (Bookmark)iter.next();
renderBookmark(b, pdfOutline);
}
}
/** {@inheritDoc} */
public void renderLink(Link link) throws IFException {
Rectangle targetRect = link.getTargetRect();
int pageHeight = documentHandler.currentPageRef.getPageDimension().height;
Rectangle2D targetRect2D = new Rectangle2D.Double(
targetRect.getMinX() / 1000.0,
(pageHeight - targetRect.getMinY() - targetRect.getHeight()) / 1000.0,
targetRect.getWidth() / 1000.0,
targetRect.getHeight() / 1000.0);
PDFAction pdfAction = getAction(link.getAction());
//makeLink() currently needs a PDFAction and not a reference
//TODO Revisit when PDFLink is converted to a PDFDictionary
PDFLink pdfLink = getPDFDoc().getFactory().makeLink(
targetRect2D, pdfAction);
if (pdfLink != null) {
//accessibility: ptr has a value
String ptr = link.getAction().getPtr();
if (ptr != null && ptr.length() > 0) {
documentHandler.getLogicalStructureHandler().addLinkContentItem(pdfLink, ptr);
}
documentHandler.currentPage.addAnnotation(pdfLink);
}
}
/**
* Commits all pending elements to the PDF document.
*/
public void commit() {
}
/** {@inheritDoc} */
public void addResolvedAction(AbstractAction action) throws IFException {
assert action.isComplete();
PDFAction pdfAction = (PDFAction)this.incompleteActions.remove(action.getID());
if (pdfAction == null) {
getAction(action);
} else if (pdfAction instanceof PDFGoTo) {
PDFGoTo pdfGoTo = (PDFGoTo)pdfAction;
updateTargetLocation(pdfGoTo, (GoToXYAction)action);
} else {
throw new UnsupportedOperationException(
"Action type not supported: " + pdfAction.getClass().getName());
}
}
private PDFAction getAction(AbstractAction action) {
if (action == null) {
return null;
}
PDFAction pdfAction = (PDFAction)this.completeActions.get(action.getID());
if (pdfAction != null) {
return pdfAction;
} else if (action instanceof GoToXYAction) {
pdfAction = (PDFAction) incompleteActions.get(action.getID());
if (pdfAction != null) {
return pdfAction;
} else {
GoToXYAction a = (GoToXYAction)action;
PDFGoTo pdfGoTo = new PDFGoTo(null);
getPDFDoc().assignObjectNumber(pdfGoTo);
if (action.isComplete()) {
updateTargetLocation(pdfGoTo, a);
} else {
this.incompleteActions.put(action.getID(), pdfGoTo);
}
return pdfGoTo;
}
} else if (action instanceof URIAction) {
URIAction u = (URIAction)action;
assert u.isComplete();
PDFFactory factory = getPDFDoc().getFactory();
pdfAction = factory.getExternalAction(u.getURI(), u.isNewWindow());
if (!pdfAction.hasObjectNumber()) {
//Some PDF actions a pooled
getPDFDoc().registerObject(pdfAction);
}
this.completeActions.put(action.getID(), pdfAction);
return pdfAction;
} else {
throw new UnsupportedOperationException("Unsupported action type: "
+ action + " (" + action.getClass().getName() + ")");
}
}
private void updateTargetLocation(PDFGoTo pdfGoTo, GoToXYAction action) {
PageReference pageRef = this.documentHandler.getPageReference(action.getPageIndex());
//Convert target location from millipoints to points and adjust for different
//page origin
Point2D p2d = null;
p2d = new Point2D.Double(
action.getTargetLocation().x / 1000.0,
(pageRef.getPageDimension().height - action.getTargetLocation().y) / 1000.0);
String pdfPageRef = pageRef.getPageRef().toString();
pdfGoTo.setPageReference(pdfPageRef);
pdfGoTo.setPosition(p2d);
//Queue this object now that it's complete
getPDFDoc().addObject(pdfGoTo);
this.completeActions.put(action.getID(), pdfGoTo);
}
}
|
