/*
* 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.pdmodel.interactive.form;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSString;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDResources;
import org.apache.pdfbox.pdmodel.common.COSArrayList;
import org.apache.pdfbox.pdmodel.common.COSObjectable;
import org.apache.pdfbox.pdmodel.fdf.FDFDictionary;
import org.apache.pdfbox.pdmodel.fdf.FDFDocument;
import org.apache.pdfbox.pdmodel.fdf.FDFCatalog;
import org.apache.pdfbox.pdmodel.fdf.FDFField;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
/**
* This class represents the acroform of a PDF document.
*
* @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
* @version $Revision: 1.14 $
*/
public class PDAcroForm implements COSObjectable
{
private COSDictionary acroForm;
private PDDocument document;
private Map fieldCache;
/**
* Constructor.
*
* @param doc The document that this form is part of.
*/
public PDAcroForm( PDDocument doc )
{
document = doc;
acroForm = new COSDictionary();
COSArray fields = new COSArray();
acroForm.setItem( COSName.getPDFName( "Fields" ), fields );
}
/**
* Constructor.
*
* @param doc The document that this form is part of.
* @param form The existing acroForm.
*/
public PDAcroForm( PDDocument doc, COSDictionary form )
{
document = doc;
acroForm = form;
}
/**
* This will get the document associated with this form.
*
* @return The PDF document.
*/
public PDDocument getDocument()
{
return document;
}
/**
* This will get the dictionary that this form wraps.
*
* @return The dictionary for this form.
*/
public COSDictionary getDictionary()
{
return acroForm;
}
/**
* This method will import an entire FDF document into the PDF document
* that this acroform is part of.
*
* @param fdf The FDF document to import.
*
* @throws IOException If there is an error doing the import.
*/
public void importFDF( FDFDocument fdf ) throws IOException
{
List fields = fdf.getCatalog().getFDF().getFields();
if( fields != null )
{
for( int i=0; i<fields.size(); i++ )
{
FDFField fdfField = (FDFField)fields.get( i );
PDField docField = getField( fdfField.getPartialFieldName() );
if( docField != null )
{
docField.importFDF( fdfField );
}
}
}
}
/**
* This will export all FDF form data.
*
* @return An FDF document used to export the document.
* @throws IOException If there is an error when exporting the document.
*/
public FDFDocument exportFDF() throws IOException
{
FDFDocument fdf = new FDFDocument();
FDFCatalog catalog = fdf.getCatalog();
FDFDictionary fdfDict = new FDFDictionary();
catalog.setFDF( fdfDict );
List fdfFields = new ArrayList();
List fields = getFields();
Iterator fieldIter = fields.iterator();
while( fieldIter.hasNext() )
{
PDField docField = (PDField)fieldIter.next();
addFieldAndChildren( docField, fdfFields );
}
fdfDict.setID( document.getDocument().getDocumentID() );
if( fdfFields.size() > 0 )
{
fdfDict.setFields( fdfFields );
}
return fdf;
}
private void addFieldAndChildren( PDField docField, List fdfFields ) throws IOException
{
Object fieldValue = docField.getValue();
FDFField fdfField = new FDFField();
fdfField.setPartialFieldName( docField.getPartialName() );
fdfField.setValue( fieldValue );
List kids = docField.getKids();
List childFDFFields = new ArrayList();
if( kids != null )
{
for( int i=0; i<kids.size(); i++ )
{
addFieldAndChildren( (PDField)kids.get( i ), childFDFFields );
}
if( childFDFFields.size() > 0 )
{
fdfField.setKids( childFDFFields );
}
}
if( fieldValue != null || childFDFFields.size() > 0 )
{
fdfFields.add( fdfField );
}
}
/**
* This will return all of the fields in the document. The type
* will be a org.apache.pdfbox.pdmodel.field.PDField.
*
* @return A list of all the fields.
* @throws IOException If there is an error while getting the list of fields.
*/
public List getFields() throws IOException
{
List retval = null;
COSArray fields =
(COSArray) acroForm.getDictionaryObject(
COSName.getPDFName("Fields"));
if( fields != null )
{
List actuals = new ArrayList();
for (int i = 0; i < fields.size(); i++)
{
COSDictionary element = (COSDictionary) fields.getObject(i);
if (element != null)
{
PDField field = PDFieldFactory.createField( this, element );
if( field != null )
{
actuals.add(field);
}
}
}
retval = new COSArrayList( actuals, fields );
}
return retval;
}
/**
* Set the fields that are part of this AcroForm.
*
* @param fields The fields that are part of this form.
*/
public void setFields( List fields )
{
acroForm.setItem( "Fields", COSArrayList.converterToCOSArray( fields ));
}
/**
* This will tell this form to cache the fields into a Map structure
* for fast access via the getField method. The default is false. You would
* want this to be false if you were changing the COSDictionary behind the scenes,
* otherwise setting this to true is acceptable.
*
* @param cache A boolean telling if we should cache the fields.
* @throws IOException If there is an error while caching the fields.
*/
public void setCacheFields( boolean cache ) throws IOException
{
if( cache )
{
fieldCache = new HashMap();
List fields = getFields();
Iterator fieldIter = fields.iterator();
while( fieldIter.hasNext() )
{
PDField next = (PDField)fieldIter.next();
fieldCache.put( next.getFullyQualifiedName(), next );
}
}
else
{
fieldCache = null;
}
}
/**
* This will tell if this acro form is caching the fields.
*
* @return true if the fields are being cached.
*/
public boolean isCachingFields()
{
return fieldCache != null;
}
/**
* This will get a field by name, possibly using the cache if setCache is true.
*
* @param name The name of the field to get.
*
* @return The field with that name of null if one was not found.
*
* @throws IOException If there is an error getting the field type.
*/
public PDField getField( String name ) throws IOException
{
PDField retval = null;
if( fieldCache != null )
{
retval = (PDField)fieldCache.get( name );
}
else
{
String[] nameSubSection = name.split( "\\." );
COSArray fields =
(COSArray) acroForm.getDictionaryObject(
COSName.getPDFName("Fields"));
for (int i = 0; i < fields.size() && retval == null; i++)
{
COSDictionary element = (COSDictionary) fields.getObject(i);
if( element != null )
{
COSString fieldName =
(COSString)element.getDictionaryObject( COSName.getPDFName( "T" ) );
if( fieldName.getString().equals( name ) ||
fieldName.getString().equals( nameSubSection[0] ) )
{
PDField root = PDFieldFactory.createField( this, element );
if( nameSubSection.length > 1 )
{
PDField kid = root.findKid( nameSubSection, 1 );
if( kid != null )
{
retval = kid;
}
else
{
retval = root;
}
}
else
{
retval = root;
}
}
}
}
}
return retval;
}
/**
* This will get the default resources for the acro form.
*
* @return The default resources.
*/
public PDResources getDefaultResources()
{
PDResources retval = null;
COSDictionary dr = (COSDictionary)acroForm.getDictionaryObject( COSName.getPDFName( "DR" ) );
if( dr != null )
{
retval = new PDResources( dr );
}
return retval;
}
/**
* This will set the default resources for the acroform.
*
* @param dr The new default resources.
*/
public void setDefaultResources( PDResources dr )
{
COSDictionary drDict = null;
if( dr != null )
{
drDict = dr.getCOSDictionary();
}
acroForm.setItem( COSName.getPDFName( "DR" ), drDict );
}
/**
* {@inheritDoc}
*/
public COSBase getCOSObject()
{
return acroForm;
}
/**
* Get the XFA resource, the XFA resource is only used for PDF 1.5+ forms.
*
* @return The xfa resource or null if it does not exist.
*/
public PDXFA getXFA()
{
PDXFA xfa = null;
COSBase base = acroForm.getDictionaryObject( "XFA" );
if( base != null )
{
xfa = new PDXFA( base );
}
return xfa;
}
/**
* Set the XFA resource, this is only used for PDF 1.5+ forms.
*
* @param xfa The xfa resource.
*/
public void setXFA( PDXFA xfa )
{
acroForm.setItem( "XFA", xfa );
}
}