|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pdfbox.pdmodel.fdf.FDFDictionary
public class FDFDictionary
This represents an FDF dictionary that is part of the FDF document.
Constructor Summary | |
---|---|
FDFDictionary()
Default constructor. |
|
FDFDictionary(COSDictionary fdfDictionary)
Constructor. |
|
FDFDictionary(org.w3c.dom.Element fdfXML)
This will create an FDF dictionary from an XFDF XML document. |
Method Summary | |
---|---|
java.util.List |
getAnnotations()
This will get the list of FDF Annotations. |
COSDictionary |
getCOSDictionary()
Convert this standard java object to a COS object. |
COSBase |
getCOSObject()
Convert this standard java object to a COS object. |
COSStream |
getDifferences()
This will get the incremental updates since the PDF was last opened. |
java.util.List |
getEmbeddedFDFs()
This will get the list of embedded FDF entries, or null if the entry is null. |
java.lang.String |
getEncoding()
The encoding to be used for a FDF field. |
java.util.List |
getFields()
This will get the list of FDF Fields. |
PDFileSpecification |
getFile()
The source file or target file: the PDF document file that this FDF file was exported from or is intended to be imported into. |
COSArray |
getID()
This is the FDF id. |
FDFJavaScript |
getJavaScript()
This will get the java script entry. |
java.util.List |
getPages()
This will get the list of FDF Pages. |
java.lang.String |
getStatus()
This will get the status string to be displayed as the result of an action. |
java.lang.String |
getTarget()
This will get the target frame in the browser to open this document. |
void |
setAnnotations(java.util.List annots)
This will set the list of annotations. |
void |
setDifferences(COSStream diff)
This will set the differences stream. |
void |
setEmbeddedFDFs(java.util.List embedded)
This will set the list of embedded FDFs. |
void |
setEncoding(java.lang.String encoding)
This will set the encoding. |
void |
setFields(java.util.List fields)
This will set the list of fields. |
void |
setFile(PDFileSpecification fs)
This will set the file specification. |
void |
setID(COSArray id)
This will set the FDF id. |
void |
setJavaScript(FDFJavaScript js)
This will set the JavaScript entry. |
void |
setPages(java.util.List pages)
This will set the list of pages. |
void |
setStatus(java.lang.String status)
This will set the status string. |
void |
setTarget(java.lang.String target)
This will set the target frame in the browser to open this document. |
void |
writeXML(java.io.Writer output)
This will write this element as an XML document. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FDFDictionary()
public FDFDictionary(COSDictionary fdfDictionary)
fdfDictionary
- The FDF documents catalog.public FDFDictionary(org.w3c.dom.Element fdfXML) throws java.io.IOException
fdfXML
- The XML document that contains the XFDF data.
java.io.IOException
- If there is an error reading from the dom.Method Detail |
---|
public void writeXML(java.io.Writer output) throws java.io.IOException
output
- The stream to write the xml to.
java.io.IOException
- If there is an error writing the XML.public COSBase getCOSObject()
getCOSObject
in interface COSObjectable
public COSDictionary getCOSDictionary()
public PDFileSpecification getFile() throws java.io.IOException
java.io.IOException
- If there is an error creating the file spec.public void setFile(PDFileSpecification fs)
fs
- The file specification.public COSArray getID()
public void setID(COSArray id)
id
- The new id for the FDF.public java.util.List getFields()
public void setFields(java.util.List fields)
fields
- The list of fields.public java.lang.String getStatus()
public void setStatus(java.lang.String status)
status
- The new status string.public java.util.List getPages()
public void setPages(java.util.List pages)
pages
- The list of pages.public java.lang.String getEncoding()
public void setEncoding(java.lang.String encoding)
encoding
- The new encoding.public java.util.List getAnnotations()
public void setAnnotations(java.util.List annots)
annots
- The list of annotations.public COSStream getDifferences()
public void setDifferences(COSStream diff)
diff
- The new differences stream.public java.lang.String getTarget()
public void setTarget(java.lang.String target)
target
- The new target frame.public java.util.List getEmbeddedFDFs() throws java.io.IOException
java.io.IOException
- If there is an error creating the file spec.public void setEmbeddedFDFs(java.util.List embedded)
embedded
- The list of embedded FDFs.public FDFJavaScript getJavaScript()
public void setJavaScript(FDFJavaScript js)
js
- The javascript entries.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |