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 --- .../java/org/pdfbox/pdmodel/fdf/FDFTemplate.java | 167 +++++++++++++++++++++ 1 file changed, 167 insertions(+) create mode 100644 src/main/java/org/pdfbox/pdmodel/fdf/FDFTemplate.java (limited to 'src/main/java/org/pdfbox/pdmodel/fdf/FDFTemplate.java') diff --git a/src/main/java/org/pdfbox/pdmodel/fdf/FDFTemplate.java b/src/main/java/org/pdfbox/pdmodel/fdf/FDFTemplate.java new file mode 100644 index 0000000..217ca30 --- /dev/null +++ b/src/main/java/org/pdfbox/pdmodel/fdf/FDFTemplate.java @@ -0,0 +1,167 @@ +/** + * Copyright (c) 2004-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.fdf; + +import java.util.ArrayList; +import java.util.List; + +import org.pdfbox.cos.COSArray; +import org.pdfbox.cos.COSBase; +import org.pdfbox.cos.COSDictionary; + +import org.pdfbox.pdmodel.common.COSArrayList; +import org.pdfbox.pdmodel.common.COSObjectable; + +/** + * This represents an FDF template that is part of the FDF page. + * + * @author Ben Litchfield (ben@benlitchfield.com) + * @version $Revision: 1.2 $ + */ +public class FDFTemplate implements COSObjectable +{ + private COSDictionary template; + + /** + * Default constructor. + */ + public FDFTemplate() + { + template = new COSDictionary(); + } + + /** + * Constructor. + * + * @param t The FDF page template. + */ + public FDFTemplate( COSDictionary t ) + { + template = t; + } + + /** + * Convert this standard java object to a COS object. + * + * @return The cos object that matches this Java object. + */ + public COSBase getCOSObject() + { + return template; + } + + /** + * Convert this standard java object to a COS object. + * + * @return The cos object that matches this Java object. + */ + public COSDictionary getCOSDictionary() + { + return template; + } + + /** + * This is the template reference. + * + * @return The template reference. + */ + public FDFNamedPageReference getTemplateReference() + { + FDFNamedPageReference retval = null; + COSDictionary dict = (COSDictionary)template.getDictionaryObject( "TRef" ); + if( dict != null ) + { + retval = new FDFNamedPageReference( dict ); + } + return retval; + } + + /** + * This will set the template reference. + * + * @param tRef The template reference. + */ + public void setTemplateReference( FDFNamedPageReference tRef ) + { + template.setItem( "TRef", tRef ); + } + + /** + * This will get a list of fields that are part of this template. + * + * @return A list of fields. + */ + public List getFields() + { + List retval = null; + COSArray array = (COSArray)template.getDictionaryObject( "Fields" ); + if( array != null ) + { + List fields = new ArrayList(); + for( int i=0; i