DrawParams Class Documentation

classDrawParams

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()

Construct default DrawParams. Initializes with DeviceRGB color space, relative colorimetric render intent, no smoothing, no draw flags, and no cancel or progress callbacks.

DrawParams

DrawParams(DrawParamsrhs)

Parameters

rhs: DrawParams

The DrawParams to copy from.

Copy constructor.

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

finalize

voidfinalize()

Returns:

void

getBypassCopyPerm

booleangetBypassCopyPerm()

Returns:

boolean

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

getCancelProc

CancelProcgetCancelProc()

Returns:

The current cancel callback, or null if none is set.

Get the cancel callback for rendering operations.

getColorSpace

ColorSpacegetColorSpace()

Returns:

ColorSpace

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

getDestRect

RectgetDestRect()

Returns:

Rect

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

getEnableBlackPointCompensation

booleangetEnableBlackPointCompensation()

Returns:

boolean

Enable/disable black point compensation.

getEnableThinLineHeuristics

booleangetEnableThinLineHeuristics()

Returns:

boolean

Enable/disable thin line adjustments when drawing rectangles

getFlags

java.util.EnumSet< DrawFlags >getFlags()

Returns:

java.util.EnumSet< DrawFlags >

Drawing flags.

getICCProfile

ColorProfilegetICCProfile()

Returns:

ColorProfile

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

StringgetICCProfileCustomPath()

Returns:

String

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

MatrixgetMatrix()

Returns:

Matrix

The matrix to concatenate onto the default page matrix. Useful for converting from page to window coordinates and for scaling.

getOptionalContentContext

OptionalContentContextgetOptionalContentContext()

Returns:

The optional content context, or NULL if using the document's default.

Get the optional-content context used for visibility state information.

getProgressProc

RenderProgressProcgetProgressProc()

Returns:

The current progress callback, or null if none is set.

Get the progress callback for rendering operations.

getRenderIntent

RenderIntentgetRenderIntent()

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

RectgetUpdateRect()

Returns:

Rect

The rectangle specifying the area to draw. A rectangle represented by the coordinates of its four sides. If unset (degenerate), the page's CropBox is used instead.

setBypassCopyPerm

voidsetBypassCopyPerm(booleanvalue)

Parameters

value: boolean

Returns:

void

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

setCancelProc

voidsetCancelProc(CancelProccancelProc)

Parameters

cancelProc: CancelProc

The cancel callback to set, or null to clear.

Returns:

void

The cancel callback for rendering operations. A CancelProc can return true to cancel the operation. May be null.

setColorSpace

voidsetColorSpace(ColorSpacecolorSpace)

Parameters

colorSpace: ColorSpace

Returns:

void

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

setDestRect

voidsetDestRect(Rectrect)

Parameters

rect: Rect

Returns:

void

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

setEnableBlackPointCompensation

voidsetEnableBlackPointCompensation(booleanvalue)

Parameters

value: boolean

Returns:

void

Enable/disable black point compensation.

setEnableThinLineHeuristics

voidsetEnableThinLineHeuristics(booleanvalue)

Parameters

value: boolean

Returns:

void

Enable/disable thin line adjustments when drawing rectangles

setFlags

voidsetFlags(java.util.EnumSet< DrawFlags >value)

Parameters

value: java.util.EnumSet< DrawFlags >

Returns:

void

Drawing flags.

setICCProfile

voidsetICCProfile(ColorProfilecolorProfile)

Parameters

colorProfile: ColorProfile

Returns:

void

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.

setICCProfileCustomPath

voidsetICCProfileCustomPath(StringcolorProfilePath)

Parameters

colorProfilePath: String

Returns:

void

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

voidsetMatrix(Matrixmatrix)

Parameters

matrix: Matrix

Returns:

void

The matrix to concatenate onto the default page matrix. Useful for converting from page to window coordinates and for scaling.

setOptionalContentContext

voidsetOptionalContentContext(OptionalContentContextcontext)

Parameters

context: OptionalContentContext

The optional content context, or NULL for the default.

Returns:

void

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

setProgressProc

voidsetProgressProc(RenderProgressProcprogressProc)

Parameters

progressProc: RenderProgressProc

The progress callback to set, or null to clear.

Returns:

void

The progress callback for rendering operations. A RenderProgressProc receives updates regarding rendering progress. May be null.

setRenderIntent

voidsetRenderIntent(RenderIntentvalue)

Parameters

value: RenderIntent

Returns:

void

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

setSmoothFlags

voidsetSmoothFlags(java.util.EnumSet< SmoothFlags >value)

Parameters

value: java.util.EnumSet< SmoothFlags >

Returns:

void

Smoothing flags. Only used when drawing to a bitmap.

setUpdateRect

voidsetUpdateRect(Rectrect)

Parameters

rect: Rect

Returns:

void

The rectangle specifying the area to draw. A rectangle represented by the coordinates of its four sides. If unset (degenerate), the page's CropBox is used instead.