Package org.mapfish.print.config

Class PDFConfig

java.lang.Object
org.mapfish.print.config.PDFConfig
All Implemented Interfaces:
ConfigurationObject
public class PDFConfig extends Object implements ConfigurationObject
A Configuration object for containing metadata that will be embedded in the PDF and parameters to use when encoding the PDF.

Naturally this only applies to reports that are exported as PDFs. [[examples=config_aliases_defaults,verboseExample]]

  • Constructor Details

    • PDFConfig

      public PDFConfig()

  • Method Details

    • validate

      public void validate(List<Throwable> validationErrors, Configuration configuration)
      Description copied from interface: ConfigurationObject
      validate that the configuration was correct.
      Specified by:
      validate in interface ConfigurationObject
      Parameters:
      validationErrors - a list to add any detected errors to.
      configuration - the containing configuration

    • isCompressed

      public boolean isCompressed()

    • setCompressed

      public void setCompressed(boolean compressed)
      If this property is set to true then the resulting PDF will be a compressed PDF. By default the PDF is not compressed.
      Parameters:
      compressed - if the pdf should be compressed.

    • getTitle

      public String getTitle()

    • setTitle

      public void setTitle(String title)
      Set the title of the PDF.
      Parameters:
      title - the title of the PDF.

    • getAuthor

      public String getAuthor()

    • setAuthor

      public void setAuthor(String author)
      Set the author of the PDF.
      Parameters:
      author - the author of the PDF.

    • getSubject

      public String getSubject()

    • setSubject

      public void setSubject(String subject)
      Set the subject of the PDF.
      Parameters:
      subject - the subject of the PDF.

    • getKeywordsAsString

      public String getKeywordsAsString()

    • setKeywords

      public void setKeywords(List<String> keywords)
      The keywords to include in the PDF metadata.
      Parameters:
      keywords - the keywords of the PDF.

    • getCreator

      public String getCreator()

    • setCreator

      public void setCreator(String creator)
      Set the creator of the PDF.
      Parameters:
      creator - the creator of the PDF.