ImageSaveParams Class Documentation
classImageSaveParamsNamespace: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 voiddelete
synchronized voiddelete()Returns:
synchronized voidfinalize
voidfinalize()Returns:
voidgetCompression
CompressionCodegetCompression()Returns:
CompressionCodeType of compression to be used in saving the image to a file.
getDisableAlphaChannelGeneration
booleangetDisableAlphaChannelGeneration()Returns:
booleanIs 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:
booleanIs 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:
intThe quality of a (JPEG) output image.
getMonochromeThreshold
shortgetMonochromeThreshold()Returns:
shortThreshold 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:
booleanWhen 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:
booleanIs the GrayScale output reversed. Note this is only valid for an image with a DeviceGray Colorspace.
getTIFFBlackIsOne
booleangetTIFFBlackIsOne()Returns:
booleanIs a TIFF file photometrically reversed. Note this is only valid for a 1 bit TIFF image with a DeviceGRAY Colorspace.
getTIFFByteOrder
TIFFByteOrdergetTIFFByteOrder()Returns:
TIFFByteOrderControls the byte order used within the TIFF file. NOTE: This is only valid for TIFF.
getTIFFCMYKAlpha
booleangetTIFFCMYKAlpha()Returns:
booleanIs 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:
booleanWhen 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:
voidsetDisableAlphaChannelGeneration
voidsetDisableAlphaChannelGeneration(booleandisableAlphaChannelGeneration)Parameters
disableAlphaChannelGeneration: boolean
Returns:
voidsetHalftoneGrayImages
voidsetHalftoneGrayImages(booleanarg0)Parameters
arg0: boolean
Returns:
voidsetJPEGQuality
voidsetJPEGQuality(intarg0)Parameters
arg0: int
Returns:
voidsetMonochromeThreshold
voidsetMonochromeThreshold(shortmonochromeThreshold)Parameters
monochromeThreshold: short
Returns:
voidsetRaiseExceptionIfNotUsableColor
voidsetRaiseExceptionIfNotUsableColor(booleanRaiseExceptionIfNotUsableColor)Parameters
RaiseExceptionIfNotUsableColor: boolean
Returns:
voidsetReverseGray
voidsetReverseGray(booleanarg0)Parameters
arg0: boolean
Returns:
voidsetTIFFBlackIsOne
voidsetTIFFBlackIsOne(booleanarg0)Parameters
arg0: boolean
Returns:
voidsetTIFFByteOrder
voidsetTIFFByteOrder(TIFFByteOrdertiffByteOrder)Parameters
tiffByteOrder: TIFFByteOrder
Returns:
voidsetTIFFCMYKAlpha
voidsetTIFFCMYKAlpha(booleancmykAlpha)Parameters
cmykAlpha: boolean
Returns:
voidsetWriteSeparationColorsToTIFF
voidsetWriteSeparationColorsToTIFF(booleanWriteSeparationColorsToTIFF)Parameters
WriteSeparationColorsToTIFF: boolean
Returns:
void