From 6025b6016517c6d898d8957d1d7e03ba71431912 Mon Sep 17 00:00:00 2001 From: tknall Date: Fri, 1 Dec 2006 12:20:24 +0000 Subject: Initial import of release 2.2. git-svn-id: https://joinup.ec.europa.eu/svn/pdf-as/trunk@4 7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c --- .../pdfbox/pdmodel/PDDocumentNameDictionary.java | 164 +++++++++++++++++++++ 1 file changed, 164 insertions(+) create mode 100644 src/main/java/org/pdfbox/pdmodel/PDDocumentNameDictionary.java (limited to 'src/main/java/org/pdfbox/pdmodel/PDDocumentNameDictionary.java') diff --git a/src/main/java/org/pdfbox/pdmodel/PDDocumentNameDictionary.java b/src/main/java/org/pdfbox/pdmodel/PDDocumentNameDictionary.java new file mode 100644 index 0000000..f343d7a --- /dev/null +++ b/src/main/java/org/pdfbox/pdmodel/PDDocumentNameDictionary.java @@ -0,0 +1,164 @@ +/** + * Copyright (c) 2005, www.pdfbox.org + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. Neither the name of pdfbox; nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://www.pdfbox.org + * + */ +package org.pdfbox.pdmodel; + +import org.pdfbox.cos.COSBase; +import org.pdfbox.cos.COSDictionary; +import org.pdfbox.pdmodel.common.COSObjectable; + +/** + * This class holds all of the name trees that are available at the document level. + * + * @author Ben Litchfield (ben@benlitchfield.com) + * @version $Revision: 1.2 $ + */ +public class PDDocumentNameDictionary implements COSObjectable +{ + private COSDictionary nameDictionary; + private PDDocumentCatalog catalog; + + /** + * Constructor. + * + * @param cat The document catalog that this dictionary is part of. + */ + public PDDocumentNameDictionary( PDDocumentCatalog cat ) + { + nameDictionary = new COSDictionary(); + catalog = cat; + } + + /** + * Constructor. + * + * @param cat The document that this dictionary is part of. + * @param names The names dictionary. + */ + public PDDocumentNameDictionary( PDDocumentCatalog cat, COSDictionary names ) + { + catalog = cat; + nameDictionary = names; + } + + /** + * Convert this standard java object to a COS object. + * + * @return The cos object that matches this Java object. + */ + public COSBase getCOSObject() + { + return nameDictionary; + } + + /** + * Convert this standard java object to a COS object. + * + * @return The cos dictionary for this object. + */ + public COSDictionary getCOSDictionary() + { + return nameDictionary; + } + + /** + * Get the destination named tree node. The value in this name tree will be PDDestination + * objects. + * + * @return The destination name tree node. + */ + public PDDestinationNameTreeNode getDests() + { + PDDestinationNameTreeNode dests = null; + + COSDictionary dic = (COSDictionary)nameDictionary.getDictionaryObject( "Dests" ); + + //The document catalog also contains the Dests entry sometimes + //so check there as well. + if( dic == null ) + { + dic = (COSDictionary)catalog.getCOSDictionary().getDictionaryObject( "Dests" ); + } + + if( dic != null ) + { + dests = new PDDestinationNameTreeNode( dic ); + } + + + return dests; + } + + /** + * Set the named destinations that are associated with this document. + * + * @param dests The destination names. + */ + public void setDests( PDDestinationNameTreeNode dests ) + { + nameDictionary.setItem( "Dests", dests ); + //The dests can either be in the document catalog or in the + //names dictionary, PDFBox will just maintain the one in the + //names dictionary for now unless there is a reason to do + //something else. + //clear the potentially out of date Dests reference. + catalog.getCOSDictionary().setItem( "Dests", (COSObjectable)null); + } + + /** + * Get the embedded files named tree node. The value in this name tree will be PDComplexFileSpecification + * objects. + * + * @return The embedded files name tree node. + */ + public PDEmbeddedFilesNameTreeNode getEmbeddedFiles() + { + PDEmbeddedFilesNameTreeNode retval = null; + + COSDictionary dic = (COSDictionary)nameDictionary.getDictionaryObject( "EmbeddedFiles" ); + + if( dic != null ) + { + retval = new PDEmbeddedFilesNameTreeNode( dic ); + } + + return retval; + } + + /** + * Set the named embedded files that are associated with this document. + * + * @param ef The new embedded files + */ + public void setEmbeddedFiles( PDEmbeddedFilesNameTreeNode ef ) + { + nameDictionary.setItem( "EmbeddedFiles", ef ); + } +} \ No newline at end of file -- cgit v1.2.3