Package com.pdftools.pdf2image.profiles

Class Viewing

java.lang.Object

com.pdftools.internal.NativeBase

com.pdftools.internal.NativeObject

com.pdftools.pdf2image.profiles.Profile

com.pdftools.pdf2image.profiles.Viewing

public class Viewing
extends Profile

The profile to convert PDF documents to JPEG or PNG images for viewing

This profile is suitable for converting PDFs to rasterized images for using in web and desktop viewing applications or as thumbnails.

By default, getImageOptions() is set to pdftools.pdf2image.PngImageOptions which uses the output format PNG and lossless compression. If set to pdftools.pdf2image.JpegImageOptions, the output format is JPEG.

Constructor Summary

Constructors

Constructor	Description
Viewing()

Method Summary

Modifier and Type	Method	Description
ImageOptions	getImageOptions()	The settings for the output image (Getter)
ImageSectionMapping	getImageSectionMapping()	The image section mapping (Getter)
void	setImageOptions(ImageOptions value)	The settings for the output image (Setter)
void	setImageSectionMapping(ImageSectionMapping value)	The image section mapping (Setter)

Methods inherited from class com.pdftools.pdf2image.profiles.Profile

getContentOptions

Methods inherited from class com.pdftools.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Viewing

public Viewing()

Method Details

getImageOptions

public ImageOptions getImageOptions()

The settings for the output image (Getter)

Supported types are:

• pdftools.pdf2image.PngImageOptions to create PNG images
• pdftools.pdf2image.JpegImageOptions to create JPEG images

Default: pdftools.pdf2image.PngImageOptions

setImageOptions

public void setImageOptions(ImageOptions value)

The settings for the output image (Setter)

Supported types are:

• pdftools.pdf2image.PngImageOptions to create PNG images
• pdftools.pdf2image.JpegImageOptions to create JPEG images

Default: pdftools.pdf2image.PngImageOptions

Throws:

IllegalArgumentException - The given object has the wrong type.

IllegalArgumentException - if value is null

getImageSectionMapping

public ImageSectionMapping getImageSectionMapping()

The image section mapping (Getter)

This property specifies how a PDF page is placed onto the target image.

Supported types are:

• pdftools.pdf2image.RenderPageAtResolution to define the resolution of the output images.
• pdftools.pdf2image.RenderPageToMaxImageSize to define the maximum image size of the output images.

Default: pdftools.pdf2image.RenderPageAtResolution with 150 DPI.

setImageSectionMapping

public void setImageSectionMapping(ImageSectionMapping value)

The image section mapping (Setter)

This property specifies how a PDF page is placed onto the target image.

Supported types are:

• pdftools.pdf2image.RenderPageAtResolution to define the resolution of the output images.
• pdftools.pdf2image.RenderPageToMaxImageSize to define the maximum image size of the output images.

Default: pdftools.pdf2image.RenderPageAtResolution with 150 DPI.

Throws:

IllegalArgumentException - The given object has the wrong type.

IllegalArgumentException - if value is null