org.pdfbox.pdmodel.fdf

Class FDFCatalog

Implemented Interfaces:
COSObjectable

public class FDFCatalog
extends java.lang.Object
implements COSObjectable

This represents an FDF catalog that is part of the FDF document.
Version:
$Revision: 1.3 $
Author:
Ben Litchfield

Constructor Summary

FDFCatalog()
Default constructor.
FDFCatalog(Element element)
This will create an FDF catalog from an XFDF XML document.
FDFCatalog(COSDictionary cat)
Constructor.

Method Summary

COSDictionary
getCOSDictionary()
Convert this standard java object to a COS object.
COSBase
getCOSObject()
Convert this standard java object to a COS object.
FDFDictionary
getFDF()
This will get the FDF dictionary.
PDSignature
getSignature()
This will get the signature or null if there is none.
String
getVersion()
This will get the version that was specified in the catalog dictionary.
void
setFDF(FDFDictionary fdf)
This will set the FDF document.
void
setSignature(PDSignature sig)
This will set the signature that is associated with this catalog.
void
setVersion(String version)
This will set the version of the FDF document.
void
writeXML(Writer output)
This will write this element as an XML document.

Constructor Details

FDFCatalog

public FDFCatalog()
Default constructor.

FDFCatalog

public FDFCatalog(Element element)
            throws IOException
This will create an FDF catalog from an XFDF XML document.
Parameters:
element - The XML document that contains the XFDF data.

FDFCatalog

public FDFCatalog(COSDictionary cat)
Constructor.
Parameters:
cat - The FDF documents catalog.

Method Details

getCOSDictionary

public COSDictionary getCOSDictionary()
Convert this standard java object to a COS object.
Returns:
The cos object that matches this Java object.

getCOSObject

public COSBase getCOSObject()
Convert this standard java object to a COS object.
Specified by:
getCOSObject in interface COSObjectable
Returns:
The cos object that matches this Java object.

getFDF

public FDFDictionary getFDF()
This will get the FDF dictionary.
Returns:
The FDF dictionary.

getSignature

public PDSignature getSignature()
This will get the signature or null if there is none.
Returns:
The signature.

getVersion

public String getVersion()
This will get the version that was specified in the catalog dictionary.
Returns:
The FDF version.

setFDF

public void setFDF(FDFDictionary fdf)
This will set the FDF document.
Parameters:
fdf - The new FDF dictionary.

setSignature

public void setSignature(PDSignature sig)
This will set the signature that is associated with this catalog.
Parameters:
sig - The new signature.

setVersion

public void setVersion(String version)
This will set the version of the FDF document.
Parameters:
version - The new version for the FDF document.

writeXML

public void writeXML(Writer output)
            throws IOException
This will write this element as an XML document.
Parameters:
output - The stream to write the xml to.