* The list structure is composed by a number of HashMap, keyed by strings, one HashMap * for each bookmark. * The element values are all strings with the exception of the key "Kids" that has * another list for the child bookmarks. *
* All the bookmarks have a "Title" with the * bookmark title and optionally a "Style" that can be "bold", "italic" or a * combination of both. They can also have a "Color" key with a value of three * floats separated by spaces. The key "Open" can have the values "true" or "false" and * signals the open status of the children. It's "true" by default. *
* The actions and the parameters can be: *
List with the bookmarks. It returns null if
* the document doesn't have any bookmarks.
* @param reader the document
* @return a List with the bookmarks or null if the
* document doesn't have any
*/
public static List getBookmark(PdfReader reader) {
PdfDictionary catalog = reader.getCatalog();
PdfObject obj = PdfReader.getPdfObjectRelease(catalog.get(PdfName.OUTLINES));
if (obj == null || !obj.isDictionary())
return null;
PdfDictionary outlines = (PdfDictionary)obj;
IntHashtable pages = new IntHashtable();
int numPages = reader.getNumberOfPages();
for (int k = 1; k <= numPages; ++k) {
pages.put(reader.getPageOrigRef(k).getNumber(), k);
reader.releasePage(k);
}
return bookmarkDepth(reader, (PdfDictionary)PdfReader.getPdfObjectRelease(outlines.get(PdfName.FIRST)), pages);
}
/**
* Removes the bookmark entries for a number of page ranges. The page ranges
* consists of a number of pairs with the start/end page range. The page numbers
* are inclusive.
* @param list the bookmarks
* @param pageRange the page ranges, always in pairs.
*/
public static void eliminatePages(List list, int pageRange[]) {
if (list == null)
return;
for (Iterator it = list.listIterator(); it.hasNext();) {
HashMap map = (HashMap)it.next();
boolean hit = false;
if ("GoTo".equals(map.get("Action"))) {
String page = (String)map.get("Page");
if (page != null) {
page = page.trim();
int idx = page.indexOf(' ');
int pageNum;
if (idx < 0)
pageNum = Integer.parseInt(page);
else
pageNum = Integer.parseInt(page.substring(0, idx));
int len = pageRange.length & 0xfffffffe;
for (int k = 0; k < len; k += 2) {
if (pageNum >= pageRange[k] && pageNum <= pageRange[k + 1]) {
hit = true;
break;
}
}
}
}
List kids = (List)map.get("Kids");
if (kids != null) {
eliminatePages(kids, pageRange);
if (kids.size() == 0) {
map.remove("Kids");
kids = null;
}
}
if (hit) {
if (kids == null)
it.remove();
else {
map.remove("Action");
map.remove("Page");
map.remove("Named");
}
}
}
}
/**
* For the pages in range add the pageShift to the page number.
* The page ranges
* consists of a number of pairs with the start/end page range. The page numbers
* are inclusive.
* @param list the bookmarks
* @param pageShift the number to add to the pages in range
* @param pageRange the page ranges, always in pairs. It can be null
* to include all the pages
*/
public static void shiftPageNumbers(List list, int pageShift, int pageRange[]) {
if (list == null)
return;
for (Iterator it = list.listIterator(); it.hasNext();) {
HashMap map = (HashMap)it.next();
if ("GoTo".equals(map.get("Action"))) {
String page = (String)map.get("Page");
if (page != null) {
page = page.trim();
int idx = page.indexOf(' ');
int pageNum;
if (idx < 0)
pageNum = Integer.parseInt(page);
else
pageNum = Integer.parseInt(page.substring(0, idx));
boolean hit = false;
if (pageRange == null)
hit = true;
else {
int len = pageRange.length & 0xfffffffe;
for (int k = 0; k < len; k += 2) {
if (pageNum >= pageRange[k] && pageNum <= pageRange[k + 1]) {
hit = true;
break;
}
}
}
if (hit) {
if (idx < 0)
page = (pageNum + pageShift) + "";
else
page = (pageNum + pageShift) + page.substring(idx);
}
map.put("Page", page);
}
}
List kids = (List)map.get("Kids");
if (kids != null)
shiftPageNumbers(kids, pageShift, pageRange);
}
}
static void createOutlineAction(PdfDictionary outline, HashMap map, PdfWriter writer, boolean namedAsNames) throws IOException {
try {
String action = (String)map.get("Action");
if ("GoTo".equals(action)) {
String p;
if ((p = (String)map.get("Named")) != null) {
if (namedAsNames)
outline.put(PdfName.DEST, new PdfName(p));
else
outline.put(PdfName.DEST, new PdfString(p, null));
}
else if ((p = (String)map.get("Page")) != null) {
PdfArray ar = new PdfArray();
StringTokenizer tk = new StringTokenizer(p);
int n = Integer.parseInt(tk.nextToken());
ar.add(writer.getPageReference(n));
if (!tk.hasMoreTokens()) {
ar.add(PdfName.XYZ);
ar.add(new float[]{0, 10000, 0});
}
else {
String fn = tk.nextToken();
if (fn.startsWith("/"))
fn = fn.substring(1);
ar.add(new PdfName(fn));
for (int k = 0; k < 4 && tk.hasMoreTokens(); ++k) {
fn = tk.nextToken();
if (fn.equals("null"))
ar.add(PdfNull.PDFNULL);
else
ar.add(new PdfNumber(fn));
}
}
outline.put(PdfName.DEST, ar);
}
}
else if ("GoToR".equals(action)) {
String p;
PdfDictionary dic = new PdfDictionary();
if ((p = (String)map.get("Named")) != null)
dic.put(PdfName.D, new PdfString(p, null));
else if ((p = (String)map.get("NamedN")) != null)
dic.put(PdfName.D, new PdfName(p));
else if ((p = (String)map.get("Page")) != null){
PdfArray ar = new PdfArray();
StringTokenizer tk = new StringTokenizer(p);
ar.add(new PdfNumber(tk.nextToken()));
if (!tk.hasMoreTokens()) {
ar.add(PdfName.XYZ);
ar.add(new float[]{0, 10000, 0});
}
else {
String fn = tk.nextToken();
if (fn.startsWith("/"))
fn = fn.substring(1);
ar.add(new PdfName(fn));
for (int k = 0; k < 4 && tk.hasMoreTokens(); ++k) {
fn = tk.nextToken();
if (fn.equals("null"))
ar.add(PdfNull.PDFNULL);
else
ar.add(new PdfNumber(fn));
}
}
dic.put(PdfName.D, ar);
}
String file = (String)map.get("File");
if (dic.size() > 0 && file != null) {
dic.put(PdfName.S, PdfName.GOTOR);
dic.put(PdfName.F, new PdfString(file));
String nw = (String)map.get("NewWindow");
if (nw != null) {
if (nw.equals("true"))
dic.put(PdfName.NEWWINDOW, PdfBoolean.PDFTRUE);
else if (nw.equals("false"))
dic.put(PdfName.NEWWINDOW, PdfBoolean.PDFFALSE);
}
outline.put(PdfName.A, dic);
}
}
else if ("URI".equals(action)) {
String uri = (String)map.get("URI");
if (uri != null) {
PdfDictionary dic = new PdfDictionary();
dic.put(PdfName.S, PdfName.URI);
dic.put(PdfName.URI, new PdfString(uri));
outline.put(PdfName.A, dic);
}
}
else if ("Launch".equals(action)) {
String file = (String)map.get("File");
if (file != null) {
PdfDictionary dic = new PdfDictionary();
dic.put(PdfName.S, PdfName.LAUNCH);
dic.put(PdfName.F, new PdfString(file));
outline.put(PdfName.A, dic);
}
}
}
catch (Exception e) {
// empty on purpose
}
}
public static Object[] iterateOutlines(PdfWriter writer, PdfIndirectReference parent, List kids, boolean namedAsNames) throws IOException {
PdfIndirectReference refs[] = new PdfIndirectReference[kids.size()];
for (int k = 0; k < refs.length; ++k)
refs[k] = writer.getPdfIndirectReference();
int ptr = 0;
int count = 0;
for (Iterator it = kids.listIterator(); it.hasNext(); ++ptr) {
HashMap map = (HashMap)it.next();
Object lower[] = null;
List subKid = (List)map.get("Kids");
if (subKid != null && subKid.size() > 0)
lower = iterateOutlines(writer, refs[ptr], subKid, namedAsNames);
PdfDictionary outline = new PdfDictionary();
++count;
if (lower != null) {
outline.put(PdfName.FIRST, (PdfIndirectReference)lower[0]);
outline.put(PdfName.LAST, (PdfIndirectReference)lower[1]);
int n = ((Integer)lower[2]).intValue();
if ("false".equals(map.get("Open"))) {
outline.put(PdfName.COUNT, new PdfNumber(-n));
}
else {
outline.put(PdfName.COUNT, new PdfNumber(n));
count += n;
}
}
outline.put(PdfName.PARENT, parent);
if (ptr > 0)
outline.put(PdfName.PREV, refs[ptr - 1]);
if (ptr < refs.length - 1)
outline.put(PdfName.NEXT, refs[ptr + 1]);
outline.put(PdfName.TITLE, new PdfString((String)map.get("Title"), PdfObject.TEXT_UNICODE));
String color = (String)map.get("Color");
if (color != null) {
try {
PdfArray arr = new PdfArray();
StringTokenizer tk = new StringTokenizer(color);
for (int k = 0; k < 3; ++k) {
float f = Float.valueOf(tk.nextToken()).intValue();
if (f < 0) f = 0;
if (f > 1) f = 1;
arr.add(new PdfNumber(f));
}
outline.put(PdfName.C, arr);
} catch(Exception e){} //in case it's malformed
}
String style = (String)map.get("Style");
if (style != null) {
style = style.toLowerCase();
int bits = 0;
if (style.indexOf("italic") >= 0)
bits |= 1;
if (style.indexOf("bold") >= 0)
bits |= 2;
if (bits != 0)
outline.put(PdfName.F, new PdfNumber(bits));
}
createOutlineAction(outline, map, writer, namedAsNames);
writer.addToBody(outline, refs[ptr]);
}
return new Object[]{refs[0], refs[refs.length - 1], new Integer(count)};
}
/**
* Exports the bookmarks to XML. Only of use if the generation is to be include in
* some other XML document.
* @param list the bookmarks
* @param out the export destination. The writer is not closed
* @param indent the indentation level. Pretty printing significant only
* @param onlyASCII codes above 127 will always be escaped with &#nn; if true,
* whatever the encoding
* @throws IOException on error
*/
public static void exportToXMLNode(List list, Writer out, int indent, boolean onlyASCII) throws IOException {
String dep = "";
for (int k = 0; k < indent; ++k)
dep += " ";
for (Iterator it = list.iterator(); it.hasNext();) {
HashMap map = (HashMap)it.next();
String title = null;
out.write(dep);
out.write("*
* <?xml version='1.0' encoding='UTF-8'?>
* <!ELEMENT Title (#PCDATA|Title)*>
* <!ATTLIST Title
* Action CDATA #IMPLIED
* Open CDATA #IMPLIED
* Page CDATA #IMPLIED
* URI CDATA #IMPLIED
* File CDATA #IMPLIED
* Named CDATA #IMPLIED
* NamedN CDATA #IMPLIED
* NewWindow CDATA #IMPLIED
* Style CDATA #IMPLIED
* Color CDATA #IMPLIED
* >
* <!ELEMENT Bookmark (Title)*>
*
* @param list the bookmarks
* @param out the export destination. The stream is not closed
* @param encoding the encoding according to IANA conventions
* @param onlyASCII codes above 127 will always be escaped with &#nn; if true,
* whatever the encoding
* @throws IOException on error
*/
public static void exportToXML(List list, OutputStream out, String encoding, boolean onlyASCII) throws IOException {
String jenc = SimpleXMLParser.getJavaEncoding(encoding);
Writer wrt = new BufferedWriter(new OutputStreamWriter(out, jenc));
exportToXML(list, wrt, encoding, onlyASCII);
}
/**
* Exports the bookmarks to XML.
* @param list the bookmarks
* @param wrt the export destination. The writer is not closed
* @param encoding the encoding according to IANA conventions
* @param onlyASCII codes above 127 will always be escaped with &#nn; if true,
* whatever the encoding
* @throws IOException on error
*/
public static void exportToXML(List list, Writer wrt, String encoding, boolean onlyASCII) throws IOException {
wrt.write("\n