DrawParams Class Documentation

class DrawParams

Namespace:com::datalogics::PDFL

Detailed Description

Settings for rendering PDF pages as images. This is used for rendering PDF pages to images, such as PNG or JPG files, to export to separate files or to send to a printer.

Referenced by

DrawParamsPage

Constructor & Destructor Documentation

DrawParams

DrawParams()

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

getBypassCopyPerm

boolean getBypassCopyPerm()

Returns:

boolean

Bypass copy permissions. Only used when drawing to a bitmap.

getColorSpace

ColorSpace getColorSpace()

Returns:

ColorSpace

The color space in which the bitmap data is represented. It must be one of DeviceGray, DeviceRGB, DeviceRGBA, DeviceCMYK, Lab, or LabA. Only used when drawing to a bitmap.

getDestRect

Rect getDestRect()

Returns:

Rect

The rectangle of the bitmap. It is defined in device space coordinates. Only used when drawing to a bitmap.

getEnableBlackPointCompensation

boolean getEnableBlackPointCompensation()

Returns:

boolean

Enable/disable black point compensation.

getEnableThinLineHeuristics

boolean getEnableThinLineHeuristics()

Returns:

boolean

Enable/disable thin line adjustments when drawing rectangles

getFlags

java.util.EnumSet< DrawFlags > getFlags()

Returns:

java.util.EnumSet< DrawFlags >

Drawing flags.

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.

getMatrix

Matrix getMatrix()

Returns:

Matrix

A pointer to the matrix to concatenate onto the default page matrix. It is useful for converting from page to window coordinates and for scaling.

getOptionalContentContext

OptionalContentContext getOptionalContentContext()

Returns:

OptionalContentContext

The optional-content context to use for visibility state information, or NULL to use the document's current states in the default context.

getRenderIntent

RenderIntent getRenderIntent()

Returns:

RenderIntent

Default rendering intent is RelColorimetric (relative colorimetric). Only used when drawing to a bitmap.

getSmoothFlags

java.util.EnumSet< SmoothFlags > getSmoothFlags()

Returns:

java.util.EnumSet< SmoothFlags >

Smoothing flags. Only used when drawing to a bitmap.

getUpdateRect

Rect getUpdateRect()

Returns:

Rect

A rectangle represented by the coordinates of its four sides, which specifies the area to draw.

setBypassCopyPerm

void setBypassCopyPerm(boolean value)

Parameters

value: boolean

Returns:

void

Bypass copy permissions. Only used when drawing to a bitmap.

setCancelProc

void setCancelProc(CancelProc cancelProc)

Parameters

cancelProc: CancelProc

a CancelProc, which can return true to cancel the operation, may be null.

Returns:

void

Set the cancel callback.

setColorSpace

void setColorSpace(ColorSpace colorSpace)

Parameters

colorSpace: ColorSpace

Returns:

void

The color space in which the bitmap data is represented. It must be one of DeviceGray, DeviceRGB, DeviceRGBA, DeviceCMYK, Lab, or LabA. Only used when drawing to a bitmap.

setDestRect

void setDestRect(Rect rect)

Parameters

rect: Rect

Returns:

void

The rectangle of the bitmap. It is defined in device space coordinates. Only used when drawing to a bitmap.

setEnableBlackPointCompensation

void setEnableBlackPointCompensation(boolean value)

Parameters

value: boolean

Returns:

void

Enable/disable black point compensation.

setEnableThinLineHeuristics

void setEnableThinLineHeuristics(boolean value)

Parameters

value: boolean

Returns:

void

Enable/disable thin line adjustments when drawing rectangles

setFlags

void setFlags(java.util.EnumSet< DrawFlags > value)

Parameters

value: java.util.EnumSet< DrawFlags >

Returns:

void

Drawing flags.

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.

setMatrix

void setMatrix(Matrix matrix)

Parameters

matrix: Matrix

Returns:

void

A pointer to the matrix to concatenate onto the default page matrix. It is useful for converting from page to window coordinates and for scaling.

setOptionalContentContext

void setOptionalContentContext(OptionalContentContext context)

Parameters

context: OptionalContentContext

Returns:

void

The optional-content context to use for visibility state information, or NULL to use the document's current states in the default context.

setProgressProc

void setProgressProc(RenderProgressProc progressProc)

Parameters

progressProc: RenderProgressProc

a RenderProgressProc, that can receive updates regarding rendering progress, may be null.

Returns:

void

Set the progress callback.

setRenderIntent

void setRenderIntent(RenderIntent value)

Parameters

value: RenderIntent

Returns:

void

Default rendering intent is RelColorimetric (relative colorimetric). Only used when drawing to a bitmap.

setSmoothFlags

void setSmoothFlags(java.util.EnumSet< SmoothFlags > value)

Parameters

value: java.util.EnumSet< SmoothFlags >

Returns:

void

Smoothing flags. Only used when drawing to a bitmap.

setUpdateRect

void setUpdateRect(Rect rect)

Parameters

rect: Rect

Returns:

void

A rectangle represented by the coordinates of its four sides, which specifies the area to draw.