org.mapfish.print.config

Class PDFConfig

java.lang.Object

org.mapfish.print.config.PDFConfig

All Implemented Interfaces:

ConfigurationObject

public class PDFConfig
extends java.lang.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 Summary

Constructors

Constructor and Description
PDFConfig()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAuthor()
java.lang.String	getCreator()
java.lang.String	getKeywordsAsString()
java.lang.String	getSubject()
java.lang.String	getTitle()
boolean	isCompressed()
void	setAuthor(java.lang.String author) Set the author of the PDF.
void	setCompressed(boolean compressed) If this property is set to true then the resulting PDF will be a compressed PDF.
void	setCreator(java.lang.String creator) Set the creator of the PDF.
void	setKeywords(java.util.List<java.lang.String> keywords) The keywords to include in the PDF metadata.
void	setSubject(java.lang.String subject) Set the subject of the PDF.
void	setTitle(java.lang.String title) Set the title of the PDF.
void	validate(java.util.List<java.lang.Throwable> validationErrors, Configuration configuration) validate that the configuration was correct.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PDFConfig

public PDFConfig()

Method Detail

validate

public void validate(java.util.List<java.lang.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 java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String title)

Set the title of the PDF.

Parameters:

title - the title of the PDF.

getAuthor

public java.lang.String getAuthor()

setAuthor

public void setAuthor(java.lang.String author)

Set the author of the PDF.

Parameters:

author - the author of the PDF.

getSubject

public java.lang.String getSubject()

setSubject

public void setSubject(java.lang.String subject)

Set the subject of the PDF.

Parameters:

subject - the subject of the PDF.

getKeywordsAsString

public java.lang.String getKeywordsAsString()

setKeywords

public void setKeywords(java.util.List<java.lang.String> keywords)

The keywords to include in the PDF metadata.

Parameters:

keywords - the keywords of the PDF.

getCreator

public java.lang.String getCreator()

setCreator

public void setCreator(java.lang.String creator)

Set the creator of the PDF.

Parameters:

creator - the creator of the PDF.