com.datalogics.PDFL

Class ImageSaveParams

java.lang.Object

com.datalogics.PDFL.ImageSaveParams

public class ImageSaveParams
extends java.lang.Object

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.

Constructor Summary

Constructors

Constructor and Description
ImageSaveParams() Default parameters for saving an image to a file.

Method Summary

Modifier and Type	Method and Description
void	delete()
CompressionCode	getCompression() Type of compression to be used in saving the image to a file.
boolean	getDisableAlphaChannelGeneration() Is the RGB image data to be combined with the Mask image data in the output file.
boolean	getHalftoneGrayImages() Is this is a Half Tone Grayscale Image..
int	getJPEGQuality() The quality of a (JPEG) output image.
short	getMonochromeThreshold() Threshold to use for determining which bits are white or black for Monochrome output (0-255, default is 128).
boolean	getRaiseExceptionIfNotUsableColor() When an image is written that is not in a format native to the image type, shall we raise an exception.
boolean	getReverseGray() Is the GrayScale output reversed.
boolean	getTIFFBlackIsOne() Is a TIFF file photometrically reversed.
TIFFByteOrder	getTIFFByteOrder() Controls the byte order used within the TIFF file.
boolean	getTIFFCMYKAlpha() Is the CMYK image data to be combined with the Soft Mask image data in the output TIF file.
boolean	getWriteSeparationColorsToTIFF() 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.
void	setCompression(CompressionCode arg0)
void	setDisableAlphaChannelGeneration(boolean disableAlphaChannelGeneration)
void	setHalftoneGrayImages(boolean arg0)
void	setJPEGQuality(int arg0)
void	setMonochromeThreshold(short monochromeThreshold)
void	setRaiseExceptionIfNotUsableColor(boolean RaiseExceptionIfNotUsableColor)
void	setReverseGray(boolean arg0)
void	setTIFFBlackIsOne(boolean arg0)
void	setTIFFByteOrder(TIFFByteOrder tiffByteOrder)
void	setTIFFCMYKAlpha(boolean cmykAlpha)
void	setWriteSeparationColorsToTIFF(boolean WriteSeparationColorsToTIFF)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageSaveParams

public ImageSaveParams()

Default parameters for saving an image to a file.

Method Detail

delete

public void delete()

getReverseGray

public boolean getReverseGray()

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

setReverseGray

public void setReverseGray(boolean arg0)

getTIFFBlackIsOne

public boolean getTIFFBlackIsOne()

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

setTIFFBlackIsOne

public void setTIFFBlackIsOne(boolean arg0)

getCompression

public CompressionCode getCompression()

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

setCompression

public void setCompression(CompressionCode arg0)

getJPEGQuality

public int getJPEGQuality()

The quality of a (JPEG) output image.

setJPEGQuality

public void setJPEGQuality(int arg0)

getHalftoneGrayImages

public boolean getHalftoneGrayImages()

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

setHalftoneGrayImages

public void setHalftoneGrayImages(boolean arg0)

getMonochromeThreshold

public short getMonochromeThreshold()

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.

setMonochromeThreshold

public void setMonochromeThreshold(short monochromeThreshold)

getTIFFCMYKAlpha

public boolean getTIFFCMYKAlpha()

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.

setTIFFCMYKAlpha

public void setTIFFCMYKAlpha(boolean cmykAlpha)

getRaiseExceptionIfNotUsableColor

public boolean getRaiseExceptionIfNotUsableColor()

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.

setRaiseExceptionIfNotUsableColor

public void setRaiseExceptionIfNotUsableColor(boolean RaiseExceptionIfNotUsableColor)

getWriteSeparationColorsToTIFF

public boolean getWriteSeparationColorsToTIFF()

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.

setWriteSeparationColorsToTIFF

public void setWriteSeparationColorsToTIFF(boolean WriteSeparationColorsToTIFF)

getDisableAlphaChannelGeneration

public boolean getDisableAlphaChannelGeneration()

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

setDisableAlphaChannelGeneration

public void setDisableAlphaChannelGeneration(boolean disableAlphaChannelGeneration)

getTIFFByteOrder

public TIFFByteOrder getTIFFByteOrder()

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

setTIFFByteOrder

public void setTIFFByteOrder(TIFFByteOrder tiffByteOrder)