Class SimpleBookmark

  • All Implemented Interfaces:
    SimpleXMLDocHandler

    public final class SimpleBookmark
    extends Object
    implements SimpleXMLDocHandler
    Bookmark processing in a simple way. It has some limitations, mainly the only action types supported are GoTo, GoToR, URI and Launch.

    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 with values in the range 0.0 to 1.0 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:

    • "Action" = "GoTo" - "Page" | "Named"
      • "Page" = "3 XYZ 70 400 null" - page number followed by a destination (/XYZ is also accepted)
      • "Named" = "named_destination"
    • "Action" = "GoToR" - "Page" | "Named" | "NamedN", "File", ["NewWindow"]
      • "Page" = "3 XYZ 70 400 null" - page number followed by a destination (/XYZ is also accepted)
      • "Named" = "named_destination_as_a_string"
      • "NamedN" = "named_destination_as_a_name"
      • "File" - "the_file_to_open"
      • "NewWindow" - "true" or "false"
    • "Action" = "URI" - "URI"
      • "URI" = "http://sf.net" - URI to jump to
    • "Action" = "Launch" - "File"
      • "File" - "the_file_to_open_or_execute"
    Author:
    Paulo Soares
    • Method Detail

      • getBookmark

        public static List<HashMap<String,​Object>> getBookmark​(PdfReader reader)
        Gets a List with the bookmarks. It returns null if the document doesn't have any bookmarks.
        Parameters:
        reader - the document
        Returns:
        a List with the bookmarks or null if the document doesn't have any
      • getBookmark

        public static List<HashMap<String,​Object>> getBookmark​(PdfReader reader,
                                                                     PdfDictionary outline,
                                                                     boolean includeRoot)
        Gets a List with the bookmarks that are children of outline. It returns null if the document doesn't have any bookmarks.
        Parameters:
        reader - the document
        outline - the outline dictionary to get bookmarks from
        includeRoot - indicates if to include outline parameter itself into returned list of bookmarks
        Returns:
        a List with the bookmarks or null if the document doesn't have any
      • eliminatePages

        public static void eliminatePages​(List<HashMap<String,​Object>> list,
                                          int[] pageRange)
        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.
        Parameters:
        list - the bookmarks
        pageRange - the page ranges, always in pairs.
      • shiftPageNumbers

        public static void shiftPageNumbers​(List<HashMap<String,​Object>> list,
                                            int pageShift,
                                            int[] pageRange)
        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.
        Parameters:
        list - the bookmarks
        pageShift - the number to add to the pages in range
        pageRange - the page ranges, always in pairs. It can be null to include all the pages
      • exportToXMLNode

        public static void exportToXMLNode​(List<HashMap<String,​Object>> list,
                                           Writer out,
                                           int indent,
                                           boolean onlyASCII)
                                    throws IOException
        Exports the bookmarks to XML. Only of use if the generation is to be include in some other XML document.
        Parameters:
        list - the bookmarks
        out - the export destination. The writer is not closed
        indent - the indentation level. Pretty printing significant only. Use -1 for no indents.
        onlyASCII - codes above 127 will always be escaped with &#nn; if true, whatever the encoding
        Throws:
        IOException - on error
        Since:
        5.0.1 (generic type in signature)
      • exportToXML

        public static void exportToXML​(List<HashMap<String,​Object>> list,
                                       OutputStream out,
                                       String encoding,
                                       boolean onlyASCII)
                                throws IOException
        Exports the bookmarks to XML. The DTD for this XML is:

         <?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)*>
         
        Parameters:
        list - the bookmarks
        out - the export destination. The stream is not closed
        encoding - the encoding according to IANA conventions
        onlyASCII - codes above 127 will always be escaped with &#nn; if true, whatever the encoding
        Throws:
        IOException - on error
        Since:
        5.0.1 (generic type in signature)
      • exportToXML

        public static void exportToXML​(List<HashMap<String,​Object>> list,
                                       Writer wrt,
                                       String encoding,
                                       boolean onlyASCII)
                                throws IOException
        Exports the bookmarks to XML.
        Parameters:
        list - the bookmarks
        wrt - the export destination. The writer is not closed
        encoding - the encoding according to IANA conventions
        onlyASCII - codes above 127 will always be escaped with &#nn; if true, whatever the encoding
        Throws:
        IOException - on error
        Since:
        5.0.1 (generic type in signature)
      • text

        public void text​(String str)
        Description copied from interface: SimpleXMLDocHandler
        Called when a text element is found.
        Specified by:
        text in interface SimpleXMLDocHandler
        Parameters:
        str - the text element, probably a fragment.