Class PdfVersionImp

java.lang.Object
com.lowagie.text.pdf.internal.PdfVersionImp
All Implemented Interfaces:
PdfVersion

public class PdfVersionImp extends Object implements PdfVersion
Stores the PDF version information, knows how to write a PDF Header, and how to add the version to the catalog (if necessary).
  • Field Details

    • headerWasWritten

      protected boolean headerWasWritten
      Indicates if the header was already written.
    • appendmode

      protected boolean appendmode
      Indicates if we are working in append mode.
    • header_version

      protected char header_version
      The version that was or will be written to the header.
    • catalog_version

      protected PdfName catalog_version
      The version that will be written to the catalog.
    • extensions

      protected PdfDictionary extensions
      The extensions dictionary.
      Since:
      2.1.6
  • Constructor Details

    • PdfVersionImp

      public PdfVersionImp()
  • Method Details

    • setPdfVersion

      public void setPdfVersion(char version)
      Description copied from interface: PdfVersion
      If the PDF Header hasn't been written yet, this changes the version as it will appear in the PDF Header. If the PDF header was already written to the OutputStream, this changes the version as it will appear in the Catalog.
      Specified by:
      setPdfVersion in interface PdfVersion
      Parameters:
      version - a character representing the PDF version
      See Also:
    • setAtLeastPdfVersion

      public void setAtLeastPdfVersion(char version)
      Description copied from interface: PdfVersion
      If the PDF Header hasn't been written yet, this changes the version as it will appear in the PDF Header, but only if the parameter refers to a higher version. If the PDF header was already written to the OutputStream, this changes the version as it will appear in the Catalog.
      Specified by:
      setAtLeastPdfVersion in interface PdfVersion
      Parameters:
      version - a character representing the PDF version
      See Also:
    • setPdfVersion

      public void setPdfVersion(PdfName version)
      Description copied from interface: PdfVersion
      Sets the PDF version as it will appear in the Catalog. Note that this only has effect if you use a later version than the one that appears in the header; this method ignores the parameter if you try to set a lower version.
      Specified by:
      setPdfVersion in interface PdfVersion
      Parameters:
      version - the PDF name that will be used for the Version key in the catalog
      See Also:
    • setAppendmode

      public void setAppendmode(boolean appendmode)
      Sets the append mode.
      Parameters:
      appendmode - Boolean that indicates if we are working in append mode.
    • writeHeader

      public void writeHeader(OutputStreamCounter os) throws IOException
      Writes the header to the OutputStreamCounter.
      Parameters:
      os - the OutputStreamCounter
      Throws:
      IOException - thrown when an I/O operation goes wrong
    • getVersionAsName

      public PdfName getVersionAsName(char version)
      Returns the PDF version as a name.
      Parameters:
      version - the version character.
      Returns:
      a PdfName that contains the version
    • getVersionAsByteArray

      public byte[] getVersionAsByteArray(char version)
      Returns the version as a byte[].
      Parameters:
      version - the version character
      Returns:
      a byte array containing the version according to the ISO-8859-1 codepage.
    • addToCatalog

      public void addToCatalog(PdfDictionary catalog)
      Adds the version to the Catalog dictionary.
      Parameters:
      catalog - The PdfDictionary to add the version to
    • addDeveloperExtension

      public void addDeveloperExtension(PdfDeveloperExtension de)
      Description copied from interface: PdfVersion
      Adds a developer extension to the Extensions dictionary in the Catalog.
      Specified by:
      addDeveloperExtension in interface PdfVersion
      Parameters:
      de - an object that contains the extensions prefix and dictionary
      Since:
      2.1.6
      See Also: