Package org.apache.pdfbox.pdmodel.fdf
Class FDFCatalog
java.lang.Object
org.apache.pdfbox.pdmodel.fdf.FDFCatalog
- All Implemented Interfaces:
COSObjectable
This represents an FDF catalog that is part of the FDF document.
- Author:
- Ben Litchfield
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.FDFCatalog
(COSDictionary cat) Constructor.FDFCatalog
(Element element) This will create an FDF catalog from an XFDF XML document. -
Method Summary
Modifier and TypeMethodDescriptionConvert this standard java object to a COS object.getFDF()
This will get the FDF dictionary.This will get the signature or null if there is none.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
This will write this element as an XML document.
-
Constructor Details
-
FDFCatalog
public FDFCatalog()Default constructor. -
FDFCatalog
Constructor.- Parameters:
cat
- The FDF documents catalog.
-
FDFCatalog
This will create an FDF catalog from an XFDF XML document.- Parameters:
element
- The XML document that contains the XFDF data.
-
-
Method Details
-
writeXML
This will write this element as an XML document.- Parameters:
output
- The stream to write the xml to.- Throws:
IOException
- If there is an error writing the XML.
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getVersion
This will get the version that was specified in the catalog dictionary.- Returns:
- The FDF version.
-
setVersion
This will set the version of the FDF document.- Parameters:
version
- The new version for the FDF document.
-
getFDF
This will get the FDF dictionary.- Returns:
- The FDF dictionary.
-
setFDF
This will set the FDF document.- Parameters:
fdf
- The new FDF dictionary.
-
getSignature
This will get the signature or null if there is none.- Returns:
- The signature.
-
setSignature
This will set the signature that is associated with this catalog.- Parameters:
sig
- The new signature.
-