Class FDFDictionary

  • All Implemented Interfaces:
    COSObjectable

    public class FDFDictionary
    extends java.lang.Object
    implements COSObjectable
    This represents an FDF dictionary that is part of the FDF document.
    • Field Detail

      • LOG

        private static final org.apache.commons.logging.Log LOG
    • Constructor Detail

      • FDFDictionary

        public FDFDictionary()
        Default constructor.
      • FDFDictionary

        public FDFDictionary​(COSDictionary fdfDictionary)
        Constructor.
        Parameters:
        fdfDictionary - The FDF documents catalog.
      • FDFDictionary

        public FDFDictionary​(org.w3c.dom.Element fdfXML)
        This will create an FDF dictionary from an XFDF XML document.
        Parameters:
        fdfXML - The XML document that contains the XFDF data.
    • Method Detail

      • writeXML

        public void writeXML​(java.io.Writer output)
                      throws java.io.IOException
        This will write this element as an XML document.
        Parameters:
        output - The stream to write the xml to.
        Throws:
        java.io.IOException - If there is an error writing the XML.
      • getCOSObject

        public COSDictionary 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.
      • getFile

        public PDFileSpecification getFile()
                                    throws java.io.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.
        Returns:
        The F entry of the FDF dictionary.
        Throws:
        java.io.IOException - If there is an error creating the file spec.
      • setFile

        public void setFile​(PDFileSpecification fs)
        This will set the file specification.
        Parameters:
        fs - The file specification.
      • getID

        public COSArray getID()
        This is the FDF id.
        Returns:
        The FDF ID.
      • setID

        public void setID​(COSArray id)
        This will set the FDF id.
        Parameters:
        id - The new id for the FDF.
      • getFields

        public java.util.List<FDFField> getFields()
        This will get the list of FDF Fields. This will return a list of FDFField objects.
        Returns:
        A list of FDF fields.
      • setFields

        public void setFields​(java.util.List<FDFField> fields)
        This will set the list of fields. This should be a list of FDFField objects.
        Parameters:
        fields - The list of fields.
      • getStatus

        public java.lang.String getStatus()
        This will get the status string to be displayed as the result of an action.
        Returns:
        The status.
      • setStatus

        public void setStatus​(java.lang.String status)
        This will set the status string.
        Parameters:
        status - The new status string.
      • getPages

        public java.util.List<FDFPage> getPages()
        This will get the list of FDF Pages. This will return a list of FDFPage objects.
        Returns:
        A list of FDF pages.
      • setPages

        public void setPages​(java.util.List<FDFPage> pages)
        This will set the list of pages. This should be a list of FDFPage objects.
        Parameters:
        pages - The list of pages.
      • getEncoding

        public java.lang.String getEncoding()
        The encoding to be used for a FDF field. The default is PDFDocEncoding and this method will never return null.
        Returns:
        The encoding value.
      • setEncoding

        public void setEncoding​(java.lang.String encoding)
        This will set the encoding.
        Parameters:
        encoding - The new encoding.
      • getAnnotations

        public java.util.List<FDFAnnotation> getAnnotations()
                                                     throws java.io.IOException
        This will get the list of FDF Annotations. This will return a list of FDFAnnotation objects or null if the entry is not set.
        Returns:
        A list of FDF annotations.
        Throws:
        java.io.IOException - If there is an error creating the annotation list.
      • setAnnotations

        public void setAnnotations​(java.util.List<FDFAnnotation> annots)
        This will set the list of annotations. This should be a list of FDFAnnotation objects.
        Parameters:
        annots - The list of annotations.
      • getDifferences

        public COSStream getDifferences()
        This will get the incremental updates since the PDF was last opened.
        Returns:
        The differences entry of the FDF dictionary.
      • setDifferences

        public void setDifferences​(COSStream diff)
        This will set the differences stream.
        Parameters:
        diff - The new differences stream.
      • getTarget

        public java.lang.String getTarget()
        This will get the target frame in the browser to open this document.
        Returns:
        The target frame.
      • setTarget

        public void setTarget​(java.lang.String target)
        This will set the target frame in the browser to open this document.
        Parameters:
        target - The new target frame.
      • getEmbeddedFDFs

        public java.util.List<PDFileSpecification> getEmbeddedFDFs()
                                                            throws java.io.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.
        Returns:
        A list of embedded FDF files.
        Throws:
        java.io.IOException - If there is an error creating the file spec.
      • setEmbeddedFDFs

        public void setEmbeddedFDFs​(java.util.List<PDFileSpecification> embedded)
        This will set the list of embedded FDFs. This should be a list of PDFileSpecification objects.
        Parameters:
        embedded - The list of embedded FDFs.
      • getJavaScript

        public FDFJavaScript getJavaScript()
        This will get the java script entry.
        Returns:
        The java script entry describing javascript commands.
      • setJavaScript

        public void setJavaScript​(FDFJavaScript js)
        This will set the JavaScript entry.
        Parameters:
        js - The javascript entries.