com.itextpdf.pdfrender

Class RenderingProperties

java.lang.Object

com.itextpdf.pdfrender.RenderingProperties

public class RenderingProperties
extends Object

Properties that will be used by the pdfRender.

Constructor Summary

Constructors

Constructor and Description
RenderingProperties()

Method Summary

Modifier and Type	Method and Description
static PdfRenderImageType	getDefaultImageType() Gets the default image type of the resultant images.
static float	getDefaultScaling() Gets the page scaling multiplier value, which will be by default applied on page sizes to calculate the dimensions of the resultant image.
PdfRenderImageType	getImageType() Gets the image type in which the resultant images will be generated.
static float	getMaxScaling() Gets the maximum page scaling value, which can be applied to page sizes to calculate the dimensions of the resultant image.
String	getPassword() Gets the password which will be used if the document is encrypted with standard encryption.
float	getScaling() Gets the page scaling value, which will be applied to page sizes to calculate the dimensions of the resultant image.
RenderingProperties	setEventMetaInfo(com.itextpdf.commons.actions.contexts.IMetaInfo metaInfo) Sets pdfRender's meta info.
RenderingProperties	setImageType(PdfRenderImageType imageType) Sets the image type in which the resultant images will be generated.
RenderingProperties	setPassword(String password) Defines the password which will be used if the document is encrypted with standard encryption.
RenderingProperties	setScaling(float pageScaling) Sets the page scaling value, which will be applied to page sizes to calculate the dimensions of the resultant image.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderingProperties

public RenderingProperties()

Method Detail

getDefaultScaling

public static float getDefaultScaling()

Gets the page scaling multiplier value, which will be by default applied on page sizes to calculate the dimensions of the resultant image.

Returns:

the page scaling multiplier

getMaxScaling

public static float getMaxScaling()

Gets the maximum page scaling value, which can be applied to page sizes to calculate the dimensions of the resultant image.

Returns:

the maximum page scaling

getDefaultImageType

public static PdfRenderImageType getDefaultImageType()

Gets the default image type of the resultant images.

Returns:

the default image type

setEventMetaInfo

public RenderingProperties setEventMetaInfo(com.itextpdf.commons.actions.contexts.IMetaInfo metaInfo)

Sets pdfRender's meta info. This meta info will be used to determine event origin.

Parameters:

metaInfo - meta info to set

Returns:

this

getImageType

public PdfRenderImageType getImageType()

Gets the image type in which the resultant images will be generated.

Returns:

the image type of the resultant images

setImageType

public RenderingProperties setImageType(PdfRenderImageType imageType)

Sets the image type in which the resultant images will be generated.

Parameters:

imageType - the image type to be used fro image generation. Note that for overloads of PdfToImageRenderer which accept PdfToImageRenderer.BufferedImageReadyListener this property is not taken into account.

Returns:

this

getPassword

public String getPassword()

Gets the password which will be used if the document is encrypted with standard encryption. This could be either user or owner password.

Returns:

password the password to use in order to open the document.

setPassword

public RenderingProperties setPassword(String password)

Defines the password which will be used if the document is encrypted with standard encryption. This could be either user or owner password.

Parameters:

password - the password to use in order to open the document.

Returns:

this

getScaling

public float getScaling()

Gets the page scaling value, which will be applied to page sizes to calculate the dimensions of the resultant image.

Returns:

the page scaling

setScaling

public RenderingProperties setScaling(float pageScaling)

Sets the page scaling value, which will be applied to page sizes to calculate the dimensions of the resultant image. Please be aware that the time and the amount of memory to process your PDF grow very fast with the scaling being increased. For example, it is suggested that the value for an A4 page should be single-digit.

Parameters:

pageScaling - the page scaling to be applied

Returns:

this