PageImageParams Class Documentation

class PageImageParams

Namespace:com::datalogics::PDFL

Detailed Description

Used to manage converting a PDF page to an image. The Page Image Parameters are a set of parameters used to control converting a PDF page to an image, such as a PNG, JPG, or BMP. The parameters include pixel height & width, color space, resolution, so on.

Referenced by

Page

Uses types

ColorSpace

Constructor & Destructor Documentation

PageImageParams

PageImageParams()

PageImageParams

PageImageParams(ColorSpace ColorSpace, java.util.EnumSet< SmoothFlags > Smoothing, int PixelWidth, int PixelHeight, double HorizontalResolution, double VerticalResolution, java.util.EnumSet< DrawFlags > PageDrawFlags)

Parameters

ColorSpace: ColorSpace
Smoothing: java.util.EnumSet< SmoothFlags >

Indicates what parts of PDF Page (text, image, art, none) are to be smoothed in rendering to an image. Note these flags can be or'd together

PixelWidth: int

The desired witdth in pixels of the output image.

PixelHeight: int

The desired height in pixels of the output image.

HorizontalResolution: double

The desired horizontal resolution in pixels/inch of the output image. If you pass in 0.0, 300.0 dpi is used.

VerticalResolution: double

The desired vertical resolution in pixels/inch of the output image. If you pass in 0.0, 300.0 dpi is used.

PageDrawFlags: java.util.EnumSet< DrawFlags >

An OR of the flags from DrawFlags which control how the PDF page is to be drawn.

Set up the parameters for rendering a PDF page to an image. Horizontal and Vertical Resolution have to be either both zero or both non-zero.

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

finalize

void finalize()

Returns:

void

getBlackPointCompensation

boolean getBlackPointCompensation()

Returns:

boolean

The BlackPointCompensation desired (default is true if not explicitly set)

getBypassCopyPerm

boolean getBypassCopyPerm()

Returns:

boolean

true if this option is turned on.

The BypassCopyPerm allows to bypass copy permitions.

getCalibrateDeviceSpacesWhenPrinting

boolean getCalibrateDeviceSpacesWhenPrinting()

Returns:

boolean

true if this option is turned on.

Sets if Device spaces should be treated as calibrated to the associated working profile (when true), otherwise it treats them as uncalibrated (when false) when printing.

getHorizontalResolution

double getHorizontalResolution()

Returns:

double

The desired horizontal resolution in pixels/inch of the output image.

getICCProfile

ColorProfile getICCProfile()

Returns:

ColorProfile

Gets the ICC Profile of the colorspace to be used for rendering from a known value.

NOTE: The ICCProfileCustomPath must not be set for this property to be used. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.

getICCProfileCustomPath

String getICCProfileCustomPath()

Returns:

String

Gets the ICC Profile of the colorspace to be used for rendering from a custom file path.

NOTE: The ICCProfile is ignored when this property is a non-empty string. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.

getImageColorSpace

ColorSpace getImageColorSpace()

Returns:

ColorSpace

The ColorSpace used in exporting a PDF page to an image

getPageDrawFlags

java.util.EnumSet< DrawFlags > getPageDrawFlags()

Returns:

java.util.EnumSet< DrawFlags >

the DrawFlags used or rendering a PDF page to an image.

getPixelHeight

int getPixelHeight()

Returns:

int

The height in pixels of the image to be created from a PDF page.

getPixelWidth

int getPixelWidth()

Returns:

int

The width in pixels of the image to be created from a PDF page.

getRenderIntent

RenderIntent getRenderIntent()

Returns:

RenderIntent

The RenderIntent used to specify color translation for colors outside gamut of the color profile used.

getSmoothing

java.util.EnumSet< SmoothFlags > getSmoothing()

Returns:

java.util.EnumSet< SmoothFlags >

The SmoothFlags used in exporting a PDF page to an image

getThinLineHeuristics

boolean getThinLineHeuristics()

Returns:

boolean

The ThinLineHeuristics used to determine whether thin lines will be fattened non-linearly or the stroke adjust will be applied to thin rectangles. return true if thin line heuristics are applied, false otherwise.

getUseDeviceNForImageSeparations

boolean getUseDeviceNForImageSeparations()

Returns:

boolean

true if this option is turned on. NOTE: This member is only applicable when calling the GetImageSeparations() method, only when Colorants used are only Process.

Gets the UseDeviceNForImageSeparations setting, which indicates when the GetImageSeparations() method is called if a DeviceN colorspace will be used for rasterization.When false, if only Process colorants are provided to GetImageSeparations() then it's rendered using DeviceCMYK.When true, then it's rendered using DeviceN.

getVerticalResolution

double getVerticalResolution()

Returns:

double

The desired vertical resolution in pixels/inch of the output image.

setBlackPointCompensation

void setBlackPointCompensation(boolean arg0)

Parameters

arg0: boolean

Returns:

void

setBypassCopyPerm

void setBypassCopyPerm(boolean value)

Parameters

value: boolean

Returns:

void

setCalibrateDeviceSpacesWhenPrinting

void setCalibrateDeviceSpacesWhenPrinting(boolean value)

Parameters

value: boolean

Returns:

void

setHorizontalResolution

void setHorizontalResolution(double arg0)

Parameters

arg0: double

Returns:

void

setICCProfile

void setICCProfile(ColorProfile colorProfile)

Parameters

colorProfile: ColorProfile

Returns:

void

Sets the ICC Profile of the colorspace to be used for rendering to a known value.

NOTE: The ICCProfileCustomPath must not be set for this property to be used. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.

setICCProfileCustomPath

void setICCProfileCustomPath(String colorProfilePath)

Parameters

colorProfilePath: String

Returns:

void

Sets the ICC Profile of the colorspace to be used for rendering from a custom file path.

NOTE: The ICCProfile is ignored when this property is a non-empty string. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.

setPageDrawFlags

void setPageDrawFlags(java.util.EnumSet< DrawFlags > arg0)

Parameters

arg0: java.util.EnumSet< DrawFlags >

Returns:

void

setPixelHeight

void setPixelHeight(int arg0)

Parameters

arg0: int

Returns:

void

setPixelWidth

void setPixelWidth(int arg0)

Parameters

arg0: int

Returns:

void

setRenderIntent

void setRenderIntent(RenderIntent arg0)

Parameters

arg0: RenderIntent

Returns:

void

setSmoothing

void setSmoothing(java.util.EnumSet< SmoothFlags > smoothflag)

Parameters

smoothflag: java.util.EnumSet< SmoothFlags >

Returns:

void

setThinLineHeuristics

void setThinLineHeuristics(boolean arg0)

Parameters

arg0: boolean

Returns:

void

setUseDeviceNForImageSeparations

void setUseDeviceNForImageSeparations(boolean value)

Parameters

value: boolean

Returns:

void

Sets the UseDeviceNForImageSeparations setting, which indicates when GetImageSeparations() is called if a DeviceN colorspace will be used for rasterization.When false, if only Process colorants are provided to GetImageSeparations() then it's rendered using DeviceCMYK.When true, then it's rendered using DeviceN.NOTE: This member is only applicable when calling the GetImageSeparations() method, only when Colorants used are only Process.

setVerticalResolution

void setVerticalResolution(double arg0)

Parameters

arg0: double

Returns:

void