/*
* 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.
*/
package org.apache.pdfbox.examples.pdmodel;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.encryption.InvalidPasswordException;
import org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline;
import org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem;
import org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode;
import java.io.IOException;
import org.apache.pdfbox.pdmodel.encryption.StandardDecryptionMaterial;
/**
* This is an example on how to access the bookmarks that are part of a pdf document.
*
* Usage: java org.apache.pdfbox.examples.pdmodel.PrintBookmarks <input-pdf>
*
* @author Ben Litchfield
*
*/
public class PrintBookmarks
{
/**
* This will print the documents data.
*
* @param args The command line arguments.
*
* @throws Exception If there is an error parsing the document.
*/
public static void main( String[] args ) throws Exception
{
if( args.length != 1 )
{
usage();
}
else
{
PDDocument document = null;
try
{
document = PDDocument.load( args[0] );
if( document.isEncrypted() )
{
try
{
StandardDecryptionMaterial sdm = new StandardDecryptionMaterial("");
document.openProtection(sdm);
}
catch( InvalidPasswordException e )
{
System.err.println( "Error: Document is encrypted with a password." );
System.exit( 1 );
}
}
PrintBookmarks meta = new PrintBookmarks();
PDDocumentOutline outline = document.getDocumentCatalog().getDocumentOutline();
if( outline != null )
{
meta.printBookmark( outline, "" );
}
else
{
System.out.println( "This document does not contain any bookmarks" );
}
}
finally
{
if( document != null )
{
document.close();
}
}
}
}
/**
* This will print the usage for this document.
*/
private static void usage()
{
System.err.println( "Usage: java org.apache.pdfbox.examples.pdmodel.PrintBookmarks <input-pdf>" );
}
/**
* This will print the documents bookmarks to System.out.
*
* @param bookmark The bookmark to print out.
* @param indentation A pretty printing parameter
*
* @throws IOException If there is an error getting the page count.
*/
public void printBookmark( PDOutlineNode bookmark, String indentation ) throws IOException
{
PDOutlineItem current = bookmark.getFirstChild();
while( current != null )
{
System.out.println( indentation + current.getTitle() );
printBookmark( current, indentation + " " );
current = current.getNextSibling();
}
}
}