Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.fdf

public Class FDFCatalog

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
java.io.IOException, .Writer, org.apache.pdfbox.cos.COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.COSObjectable, org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature, org.w3c.dom.Element
This represents an FDF catalog that is part of the FDF document.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private final COSDictionary
catalog

Constructor Summary

AccessConstructor and Description
public
FDFCatalog()

Default constructor.

public
FDFCatalog(COSDictionary
The FDF documents catalog.
cat)

Constructor.

public
FDFCatalog(Element
The XML document that contains the XFDF data.
element)

This will create an FDF catalog from an XFDF XML document.

Method Summary

Modifier and TypeMethod and Description
public COSDictionary

Returns:

The cos object that matches this Java object.
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public FDFDictionary

Returns:

The FDF dictionary.
getFDF()

This will get the FDF dictionary.

public PDSignature

Returns:

The signature.
getSignature()

This will get the signature or null if there is none.

public String

Returns:

The FDF version.
getVersion()

This will get the version that was specified in the catalog dictionary.

public final void
setFDF(FDFDictionary
The new FDF dictionary.
fdf)

This will set the FDF document.

public void
setSignature(PDSignature
The new signature.
sig)

This will set the signature that is associated with this catalog.

public void
setVersion(String
The new version for the FDF document.
version)

This will set the version of the FDF document.

public void
writeXML(Writer
The stream to write the xml to.
output)

This will write this element as an XML document.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

catalogback to summary
private final COSDictionary catalog

Constructor Detail

FDFCatalogback to summary
public FDFCatalog()

Default constructor.

FDFCatalogback to summary
public FDFCatalog(COSDictionary cat)

Constructor.

Parameters
cat:COSDictionary

The FDF documents catalog.

FDFCatalogback to summary
public FDFCatalog(Element element)

This will create an FDF catalog from an XFDF XML document.

Parameters
element:Element

The XML document that contains the XFDF data.

Method Detail

getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations
@Override
getFDFback to summary
public FDFDictionary getFDF()

This will get the FDF dictionary.

Returns:FDFDictionary

The FDF dictionary.

getSignatureback to summary
public PDSignature getSignature()

This will get the signature or null if there is none.

Returns:PDSignature

The signature.

getVersionback to summary
public String getVersion()

This will get the version that was specified in the catalog dictionary.

Returns:String

The FDF version.

setFDFback to summary
public final void setFDF(FDFDictionary fdf)

This will set the FDF document.

Parameters
fdf:FDFDictionary

The new FDF dictionary.

setSignatureback to summary
public void setSignature(PDSignature sig)

This will set the signature that is associated with this catalog.

Parameters
sig:PDSignature

The new signature.

setVersionback to summary
public void setVersion(String version)

This will set the version of the FDF document.

Parameters
version:String

The new version for the FDF document.

writeXMLback to summary
public void writeXML(Writer output) throws IOException

This will write this element as an XML document.

Parameters
output:Writer

The stream to write the xml to.

Exceptions
IOException:
If there is an error writing the XML.