getAnnotations
public List getAnnotations()
This will get the list of FDF Annotations. This will return a list of FDFAnnotation objects
or null if the entry is not set.
- A list of FDF annotations.
getCOSDictionary
public COSDictionary getCOSDictionary()
Convert this standard java object to a COS object.
- The cos object that matches this Java object.
getCOSObject
public COSBase getCOSObject()
Convert this standard java object to a COS object.
- getCOSObject in interface COSObjectable
- The cos object that matches this Java object.
getDifferences
public COSStream getDifferences()
This will get the incremental updates since the PDF was last opened.
- The differences entry of the FDF dictionary.
getEmbeddedFDFs
public List getEmbeddedFDFs()
throws IOException
This will get the list of embedded FDF entries, or null if the entry is null.
This will return a list of PDFileSpecification objects.
- A list of embedded FDF files.
getEncoding
public String getEncoding()
The encoding to be used for a FDF field. The default is PDFDocEncoding
and this method will never return null.
getFields
public List getFields()
This will get the list of FDF Fields. This will return a list of FDFField
objects.
getFile
public PDFileSpecification getFile()
throws IOException
The source file or target file: the PDF document file that
this FDF file was exported from or is intended to be imported into.
- The F entry of the FDF dictionary.
getID
public COSArray getID()
This is the FDF id.
getJavaScript
public FDFJavaScript getJavaScript()
This will get the java script entry.
- The java script entry describing javascript commands.
getPages
public List getPages()
This will get the list of FDF Pages. This will return a list of FDFPage objects.
getStatus
public String getStatus()
This will get the status string to be displayed as the result of an
action.
getTarget
public String getTarget()
This will get the target frame in the browser to open this document.
setAnnotations
public void setAnnotations(List annots)
This will set the list of annotations. This should be a list of FDFAnnotation objects.
annots
- The list of annotations.
setDifferences
public void setDifferences(COSStream diff)
This will set the differences stream.
diff
- The new differences stream.
setEmbeddedFDFs
public void setEmbeddedFDFs(List embedded)
This will set the list of embedded FDFs. This should be a list of
PDFileSpecification objects.
embedded
- The list of embedded FDFs.
setEncoding
public void setEncoding(String encoding)
This will set the encoding.
encoding
- The new encoding.
setFields
public void setFields(List fields)
This will set the list of fields. This should be a list of FDFField objects.
fields
- The list of fields.
setFile
public void setFile(PDFileSpecification fs)
This will set the file specification.
fs
- The file specification.
setID
public void setID(COSArray id)
This will set the FDF id.
id
- The new id for the FDF.
setJavaScript
public void setJavaScript(FDFJavaScript js)
This will set the JavaScript entry.
js
- The javascript entries.
setPages
public void setPages(List pages)
This will set the list of pages. This should be a list of FDFPage objects.
pages
- The list of pages.
setStatus
public void setStatus(String status)
This will set the status string.
status
- The new status string.
setTarget
public void setTarget(String target)
This will set the target frame in the browser to open this document.
target
- The new target frame.
writeXML
public void writeXML(Writer output)
throws IOException
This will write this element as an XML document.
output
- The stream to write the xml to.