ImageSaveParams Class Documentation

classImageSaveParams

Namespace:com::datalogics::PDFL

Detailed Description

Class that defines parameters for saving an image to a graphics file. The parameters include the file type (such as PNG or JPG), compression, image quality, and gray scale.

Referenced by

Constructor & Destructor Documentation

ImageSaveParams

ImageSaveParams()

Default parameters for saving an image to a file.

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

getCompression

CompressionCodegetCompression()

Returns:

CompressionCode

Type of compression to be used in saving the image to a file.

getDisableAlphaChannelGeneration

booleangetDisableAlphaChannelGeneration()

Returns:

boolean

Is the RGB image data to be combined with the Mask image data in the output file. Note: This is only valid for image data which has a Mask and the output format supports alpha information (e.g. TIFF or PNG).

getHalftoneGrayImages

booleangetHalftoneGrayImages()

Returns:

boolean

Is this is a Half Tone Grayscale Image.. Note this can only be set to true for an image of ColorSpace of DeviceGray;

getJPEGQuality

intgetJPEGQuality()

Returns:

int

The quality of a (JPEG) output image.

getMonochromeThreshold

shortgetMonochromeThreshold()

Returns:

short

Threshold to use for determining which bits are white or black for Monochrome output (0-255, default is 128). Note: this is only valid for TIF Images using G3 or G4 compression and HalftoneGrayImages must be set to false.

getRaiseExceptionIfNotUsableColor

booleangetRaiseExceptionIfNotUsableColor()

Returns:

boolean

When an image is written that is not in a format native to the image type, shall we raise an exception. or automatically convert the image data.

getReverseGray

booleangetReverseGray()

Returns:

boolean

Is the GrayScale output reversed. Note this is only valid for an image with a DeviceGray Colorspace.

getTIFFBlackIsOne

booleangetTIFFBlackIsOne()

Returns:

boolean

Is a TIFF file photometrically reversed. Note this is only valid for a 1 bit TIFF image with a DeviceGRAY Colorspace.

getTIFFByteOrder

TIFFByteOrdergetTIFFByteOrder()

Returns:

TIFFByteOrder

Controls the byte order used within the TIFF file. NOTE: This is only valid for TIFF.

getTIFFCMYKAlpha

booleangetTIFFCMYKAlpha()

Returns:

boolean

Is the CMYK image data to be combined with the Soft Mask image data in the output TIF file. Note: This is only valid for CMYK image data which has a Soft Mask, the output will be 40-bit.

getWriteSeparationColorsToTIFF

booleangetWriteSeparationColorsToTIFF()

Returns:

boolean

When we write an image that is specified in a separation or deviceN color, we will Convert that image to sRGB, if WriteSeparationColorsToTIFF is false, or write it using the Photoshop Tag for separation colors, if WriteSeparationColorsToTIFF is true.

setCompression

voidsetCompression(CompressionCodearg0)

Parameters

arg0: CompressionCode

Returns:

void

setDisableAlphaChannelGeneration

voidsetDisableAlphaChannelGeneration(booleandisableAlphaChannelGeneration)

Parameters

disableAlphaChannelGeneration: boolean

Returns:

void

setHalftoneGrayImages

voidsetHalftoneGrayImages(booleanarg0)

Parameters

arg0: boolean

Returns:

void

setJPEGQuality

voidsetJPEGQuality(intarg0)

Parameters

arg0: int

Returns:

void

setMonochromeThreshold

voidsetMonochromeThreshold(shortmonochromeThreshold)

Parameters

monochromeThreshold: short

Returns:

void

setRaiseExceptionIfNotUsableColor

voidsetRaiseExceptionIfNotUsableColor(booleanRaiseExceptionIfNotUsableColor)

Parameters

RaiseExceptionIfNotUsableColor: boolean

Returns:

void

setReverseGray

voidsetReverseGray(booleanarg0)

Parameters

arg0: boolean

Returns:

void

setTIFFBlackIsOne

voidsetTIFFBlackIsOne(booleanarg0)

Parameters

arg0: boolean

Returns:

void

setTIFFByteOrder

voidsetTIFFByteOrder(TIFFByteOrdertiffByteOrder)

Parameters

tiffByteOrder: TIFFByteOrder

Returns:

void

setTIFFCMYKAlpha

voidsetTIFFCMYKAlpha(booleancmykAlpha)

Parameters

cmykAlpha: boolean

Returns:

void

setWriteSeparationColorsToTIFF

voidsetWriteSeparationColorsToTIFF(booleanWriteSeparationColorsToTIFF)

Parameters

WriteSeparationColorsToTIFF: boolean

Returns:

void