Class FDFCatalog

  • All Implemented Interfaces:
    COSObjectable

    public class FDFCatalog
    extends java.lang.Object
    implements COSObjectable
    This represents an FDF catalog that is part of the FDF document.
    • Constructor Summary

      Constructors 
      Constructor Description
      FDFCatalog()
      Default constructor.
      FDFCatalog​(COSDictionary cat)
      Constructor.
      FDFCatalog​(org.w3c.dom.Element element)
      This will create an FDF catalog from an XFDF XML document.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      COSDictionary getCOSObject()
      Convert this standard java object to a COS object.
      FDFDictionary getFDF()
      This will get the FDF dictionary.
      PDSignature getSignature()
      This will get the signature or null if there is none.
      java.lang.String getVersion()
      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​(java.lang.String version)
      This will set the version of the FDF 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

      • FDFCatalog

        public FDFCatalog()
        Default constructor.
      • FDFCatalog

        public FDFCatalog​(COSDictionary cat)
        Constructor.
        Parameters:
        cat - The FDF documents catalog.
      • FDFCatalog

        public FDFCatalog​(org.w3c.dom.Element element)
        This will create an FDF catalog from an XFDF XML document.
        Parameters:
        element - 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.
      • getVersion

        public java.lang.String getVersion()
        This will get the version that was specified in the catalog dictionary.
        Returns:
        The FDF version.
      • setVersion

        public void setVersion​(java.lang.String version)
        This will set the version of the FDF document.
        Parameters:
        version - The new version for the FDF document.
      • getFDF

        public FDFDictionary getFDF()
        This will get the FDF dictionary.
        Returns:
        The FDF dictionary.
      • setFDF

        public void setFDF​(FDFDictionary fdf)
        This will set the FDF document.
        Parameters:
        fdf - The new FDF dictionary.
      • getSignature

        public PDSignature getSignature()
        This will get the signature or null if there is none.
        Returns:
        The signature.
      • setSignature

        public void setSignature​(PDSignature sig)
        This will set the signature that is associated with this catalog.
        Parameters:
        sig - The new signature.