public final class SimpleBookmark extends Object implements SimpleXMLDocHandler
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:
Modifier and Type | Field and Description |
---|---|
private Stack<HashMap<String,Object>> |
attr |
private ArrayList<HashMap<String,Object>> |
topList |
Modifier | Constructor and Description |
---|---|
private |
SimpleBookmark()
Creates a new instance of SimpleBookmark
|
Modifier and Type | Method and Description |
---|---|
private static List<HashMap<String,Object>> |
bookmarkDepth(PdfReader reader,
PdfDictionary outline,
IntHashtable pages) |
(package private) static void |
createOutlineAction(PdfDictionary outline,
HashMap<String,Object> map,
PdfWriter writer,
boolean namedAsNames) |
static void |
eliminatePages(List<HashMap<String,Object>> list,
int[] pageRange)
Removes the bookmark entries for a number of page ranges.
|
void |
endDocument()
Called after the document is parsed.
|
void |
endElement(String tag)
Called when an end tag is found.
|
static void |
exportToXML(List<HashMap<String,Object>> list,
OutputStream out,
String encoding,
boolean onlyASCII)
Exports the bookmarks to XML.
|
static void |
exportToXML(List<HashMap<String,Object>> list,
Writer wrt,
String encoding,
boolean onlyASCII)
Exports the bookmarks to XML.
|
static void |
exportToXMLNode(List<HashMap<String,Object>> list,
Writer out,
int indent,
boolean onlyASCII)
Exports the bookmarks to XML.
|
static List<HashMap<String,Object>> |
getBookmark(PdfReader reader)
Gets a
List with the bookmarks. |
private static int |
getNumber(PdfIndirectReference indirect)
Gets number of indirect.
|
static List<HashMap<String,Object>> |
importFromXML(InputStream in)
Import the bookmarks from XML.
|
static List<HashMap<String,Object>> |
importFromXML(Reader in)
Import the bookmarks from XML.
|
static Object[] |
iterateOutlines(PdfWriter writer,
PdfIndirectReference parent,
List<HashMap<String,Object>> kids,
boolean namedAsNames) |
private static String |
makeBookmarkParam(PdfArray dest,
IntHashtable pages) |
private static void |
mapGotoBookmark(HashMap<String,Object> map,
PdfObject dest,
IntHashtable pages) |
static void |
shiftPageNumbers(List<HashMap<String,Object>> list,
int pageShift,
int[] pageRange)
For the pages in range add the
pageShift to the page number. |
void |
startDocument()
Called when the document starts to be parsed.
|
void |
startElement(String tag,
Map<String,String> h)
Called when a start tag is found.
|
void |
text(String str)
Called when a text element is found.
|
private SimpleBookmark()
private static List<HashMap<String,Object>> bookmarkDepth(PdfReader reader, PdfDictionary outline, IntHashtable pages)
private static void mapGotoBookmark(HashMap<String,Object> map, PdfObject dest, IntHashtable pages)
private static String makeBookmarkParam(PdfArray dest, IntHashtable pages)
private static int getNumber(PdfIndirectReference indirect)
indirect
- 2004-06-13public static List<HashMap<String,Object>> getBookmark(PdfReader reader)
List
with the bookmarks. It returns null
if
the document doesn't have any bookmarks.reader
- the documentList
with the bookmarks or null
if the
document doesn't have anypublic static void eliminatePages(List<HashMap<String,Object>> list, int[] pageRange)
list
- the bookmarkspageRange
- the page ranges, always in pairs.public static void shiftPageNumbers(List<HashMap<String,Object>> list, int pageShift, int[] pageRange)
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.list
- the bookmarkspageShift
- the number to add to the pages in rangepageRange
- the page ranges, always in pairs. It can be null
to include all the pagesstatic void createOutlineAction(PdfDictionary outline, HashMap<String,Object> map, PdfWriter writer, boolean namedAsNames)
public static Object[] iterateOutlines(PdfWriter writer, PdfIndirectReference parent, List<HashMap<String,Object>> kids, boolean namedAsNames) throws IOException
IOException
public static void exportToXMLNode(List<HashMap<String,Object>> list, Writer out, int indent, boolean onlyASCII) throws IOException
list
- the bookmarksout
- the export destination. The writer is not closedindent
- the indentation level. Pretty printing significant onlyonlyASCII
- codes above 127 will always be escaped with &#nn; if true
,
whatever the encodingIOException
- on errorpublic static void exportToXML(List<HashMap<String,Object>> list, OutputStream out, String encoding, boolean onlyASCII) throws IOException
<?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)*>
list
- the bookmarksout
- the export destination. The stream is not closedencoding
- the encoding according to IANA conventionsonlyASCII
- codes above 127 will always be escaped with &#nn; if true
,
whatever the encodingIOException
- on errorpublic static void exportToXML(List<HashMap<String,Object>> list, Writer wrt, String encoding, boolean onlyASCII) throws IOException
list
- the bookmarkswrt
- the export destination. The writer is not closedencoding
- the encoding according to IANA conventionsonlyASCII
- codes above 127 will always be escaped with &#nn; if true
,
whatever the encodingIOException
- on errorpublic static List<HashMap<String,Object>> importFromXML(InputStream in) throws IOException
in
- the XML source. The stream is not closedIOException
- on errorpublic static List<HashMap<String,Object>> importFromXML(Reader in) throws IOException
in
- the XML source. The reader is not closedIOException
- on errorpublic void endDocument()
SimpleXMLDocHandler
endDocument
in interface SimpleXMLDocHandler
public void endElement(String tag)
SimpleXMLDocHandler
endElement
in interface SimpleXMLDocHandler
tag
- the tag namepublic void startDocument()
SimpleXMLDocHandler
startDocument
in interface SimpleXMLDocHandler
public void startElement(String tag, Map<String,String> h)
SimpleXMLDocHandler
startElement
in interface SimpleXMLDocHandler
tag
- the tag nameh
- the tag's attributespublic void text(String str)
SimpleXMLDocHandler
text
in interface SimpleXMLDocHandler
str
- the text element, probably a fragment.WebARTS Library Licensed Under the GNU - General Public License. Other Libraries licensed under their respective Open Source Licenses