ImageSaveParams Class Documentation

class ImageSaveParams

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

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

finalize

void finalize()

Returns:

void

getCompression

CompressionCode getCompression()

Returns:

CompressionCode

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

getDisableAlphaChannelGeneration

boolean getDisableAlphaChannelGeneration()

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

boolean getHalftoneGrayImages()

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

int getJPEGQuality()

Returns:

int

The quality of a (JPEG) output image.

getMonochromeThreshold

short getMonochromeThreshold()

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

boolean getRaiseExceptionIfNotUsableColor()

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

boolean getReverseGray()

Returns:

boolean

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

getTIFFBlackIsOne

boolean getTIFFBlackIsOne()

Returns:

boolean

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

getTIFFByteOrder

TIFFByteOrder getTIFFByteOrder()

Returns:

TIFFByteOrder

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

getTIFFCMYKAlpha

boolean getTIFFCMYKAlpha()

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

boolean getWriteSeparationColorsToTIFF()

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

void setCompression(CompressionCode arg0)

Parameters

arg0: CompressionCode

Returns:

void

setDisableAlphaChannelGeneration

void setDisableAlphaChannelGeneration(boolean disableAlphaChannelGeneration)

Parameters

disableAlphaChannelGeneration: boolean

Returns:

void

setHalftoneGrayImages

void setHalftoneGrayImages(boolean arg0)

Parameters

arg0: boolean

Returns:

void

setJPEGQuality

void setJPEGQuality(int arg0)

Parameters

arg0: int

Returns:

void

setMonochromeThreshold

void setMonochromeThreshold(short monochromeThreshold)

Parameters

monochromeThreshold: short

Returns:

void

setRaiseExceptionIfNotUsableColor

void setRaiseExceptionIfNotUsableColor(boolean RaiseExceptionIfNotUsableColor)

Parameters

RaiseExceptionIfNotUsableColor: boolean

Returns:

void

setReverseGray

void setReverseGray(boolean arg0)

Parameters

arg0: boolean

Returns:

void

setTIFFBlackIsOne

void setTIFFBlackIsOne(boolean arg0)

Parameters

arg0: boolean

Returns:

void

setTIFFByteOrder

void setTIFFByteOrder(TIFFByteOrder tiffByteOrder)

Parameters

tiffByteOrder: TIFFByteOrder

Returns:

void

setTIFFCMYKAlpha

void setTIFFCMYKAlpha(boolean cmykAlpha)

Parameters

cmykAlpha: boolean

Returns:

void

setWriteSeparationColorsToTIFF

void setWriteSeparationColorsToTIFF(boolean WriteSeparationColorsToTIFF)

Parameters

WriteSeparationColorsToTIFF: boolean

Returns:

void