/**
* Copyright (c) 2004, 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 page that is part of the FDF document.
*
* @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
* @version $Revision: 1.3 $
*/
public class FDFPage implements COSObjectable
{
private COSDictionary page;
/**
* Default constructor.
*/
public FDFPage()
{
page = new COSDictionary();
}
/**
* Constructor.
*
* @param p The FDF page.
*/
public FDFPage( COSDictionary p )
{
page = p;
}
/**
* Convert this standard java object to a COS object.
*
* @return The cos object that matches this Java object.
*/
public COSBase getCOSObject()
{
return page;
}
/**
* Convert this standard java object to a COS object.
*
* @return The cos object that matches this Java object.
*/
public COSDictionary getCOSDictionary()
{
return page;
}
/**
* This will get a list of FDFTemplage objects that describe the named pages
* that serve as templates.
*
* @return A list of templates.
*/
public List getTemplates()
{
List retval = null;
COSArray array = (COSArray)page.getDictionaryObject( "Templates" );
if( array != null )
{
List objects = new ArrayList();
for( int i=0; i<array.size(); i++ )
{
objects.add( new FDFTemplate( (COSDictionary)array.getObject( i ) ) );
}
retval = new COSArrayList( objects, array );
}
return retval;
}
/**
* A list of FDFTemplate objects.
*
* @param templates A list of templates for this Page.
*/
public void setTemplates( List templates )
{
page.setItem( "Templates", COSArrayList.converterToCOSArray( templates ) );
}
/**
* This will get the FDF page info object.
*
* @return The Page info.
*/
public FDFPageInfo getPageInfo()
{
FDFPageInfo retval = null;
COSDictionary dict = (COSDictionary)page.getDictionaryObject( "Info" );
if( dict != null )
{
retval = new FDFPageInfo( dict );
}
return retval;
}
/**
* This will set the page info.
*
* @param info The new page info dictionary.
*/
public void setPageInfo( FDFPageInfo info )
{
page.setItem( "Info", info );
}
}