* The list structure is composed by a number of Hashtable, keyed by strings, one Hashtable * 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 ArrayList GetBookmark(PdfReader reader) {
PdfDictionary catalog = reader.Catalog;
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.NumberOfPages;
for (int k = 1; k <= numPages; ++k) {
pages[reader.GetPageOrigRef(k).Number] = 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(ArrayList list, int[] pageRange) {
if (list == null)
return;
for (ListIterator it = new ListIterator(list); it.HasNext();) {
Hashtable map = (Hashtable)it.Next();
bool hit = false;
if ("GoTo".Equals(map["Action"])) {
String page = (String)map["Page"];
if (page != null) {
page = page.Trim();
int idx = page.IndexOf(' ');
int pageNum;
if (idx < 0)
pageNum = int.Parse(page);
else
pageNum = int.Parse(page.Substring(0, idx));
int len = pageRange.Length & 0x7ffffffe;
for (int k = 0; k < len; k += 2) {
if (pageNum >= pageRange[k] && pageNum <= pageRange[k + 1]) {
hit = true;
break;
}
}
}
}
ArrayList kids = (ArrayList)map["Kids"];
if (kids != null) {
EliminatePages(kids, pageRange);
if (kids.Count == 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(ArrayList list, int pageShift, int[] pageRange) {
if (list == null)
return;
foreach (Hashtable map in list) {
if ("GoTo".Equals(map["Action"])) {
String page = (String)map["Page"];
if (page != null) {
page = page.Trim();
int idx = page.IndexOf(' ');
int pageNum;
if (idx < 0)
pageNum = int.Parse(page);
else
pageNum = int.Parse(page.Substring(0, idx));
bool hit = false;
if (pageRange == null)
hit = true;
else {
int len = pageRange.Length & 0x7ffffffe;
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["Page"] = page;
}
}
ArrayList kids = (ArrayList)map["Kids"];
if (kids != null)
ShiftPageNumbers(kids, pageShift, pageRange);
}
}
internal static void CreateOutlineAction(PdfDictionary outline, Hashtable map, PdfWriter writer, bool namedAsNames) {
try {
String action = (String)map["Action"];
if ("GoTo".Equals(action)) {
String p;
if ((p = (String)map["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["Page"]) != null) {
PdfArray ar = new PdfArray();
StringTokenizer tk = new StringTokenizer(p);
int n = int.Parse(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["Named"]) != null)
dic.Put(PdfName.D, new PdfString(p, null));
else if ((p = (String)map["NamedN"]) != null)
dic.Put(PdfName.D, new PdfName(p));
else if ((p = (String)map["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["File"];
if (dic.Size > 0 && file != null) {
dic.Put(PdfName.S, PdfName.GOTOR);
dic.Put(PdfName.F, new PdfString(file));
String nw = (String)map["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["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["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 {
// empty on purpose
}
}
public static Object[] IterateOutlines(PdfWriter writer, PdfIndirectReference parent, ArrayList kids, bool namedAsNames) {
PdfIndirectReference[] refs = new PdfIndirectReference[kids.Count];
for (int k = 0; k < refs.Length; ++k)
refs[k] = writer.PdfIndirectReference;
int ptr = 0;
int count = 0;
foreach (Hashtable map in kids) {
Object[] lower = null;
ArrayList subKid = (ArrayList)map["Kids"];
if (subKid != null && subKid.Count > 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 = (int)lower[2];
if ("false".Equals(map["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["Title"], PdfObject.TEXT_UNICODE));
String color = (String)map["Color"];
if (color != null) {
try {
PdfArray arr = new PdfArray();
StringTokenizer tk = new StringTokenizer(color);
for (int k = 0; k < 3; ++k) {
float f = float.Parse(tk.NextToken(), System.Globalization.NumberFormatInfo.InvariantInfo);
if (f < 0) f = 0;
if (f > 1) f = 1;
arr.Add(new PdfNumber(f));
}
outline.Put(PdfName.C, arr);
} catch {} //in case it's malformed
}
String style = (String)map["Style"];
if (style != null) {
style = style.ToLower(System.Globalization.CultureInfo.InvariantCulture);
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]);
++ptr;
}
return new Object[]{refs[0], refs[refs.Length - 1], 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(ArrayList list, TextWriter outp, int indent, bool onlyASCII) {
String dep = "";
for (int k = 0; k < indent; ++k)
dep += " ";
foreach (Hashtable map in list) {
String title = null;
outp.Write(dep);
outp.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(ArrayList list, Stream outp, String encoding, bool onlyASCII) {
StreamWriter wrt = new StreamWriter(outp, IanaEncodings.GetEncodingEncoding(encoding));
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(ArrayList list, TextWriter wrt, String encoding, bool onlyASCII) {
wrt.Write("\n