java.lang.Object

com.pdftools.internal.NativeBase

com.pdftools.internal.NativeObject

com.pdftools.pdf2image.ImageOptions

com.pdftools.pdf2image.FaxImageOptions

public class FaxImageOptions extends ImageOptions

The settings for TIFF Fax output images

Create a black-and-white (bitonal) TIFF Fax output image. For the output file name, it is recommended to use the file extension ".tif".

Method Summary

Modifier and Type

Method

Description

TiffBitonalCompressionType

getCompression()

The Fax compression algorithm (Getter)

FaxVerticalResolution

getVerticalResolution()

The vertical image resolution (Getter)

void

setCompression(TiffBitonalCompressionType value)

The Fax compression algorithm (Setter)

void

setVerticalResolution(FaxVerticalResolution value)

The vertical image resolution (Setter)

Methods inherited from class com.pdftools.internal.NativeObject
equals, hashCode

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

Method Details
- getVerticalResolution
  
  public FaxVerticalResolution getVerticalResolution()
  
  The vertical image resolution (Getter)
  
  This property allows a choice of which vertical resolution to use. For details, see FaxVerticalResolution.
  
  Note that the horizontal resolution is fixed at 204 DPI by the Fax standard.
  
  Default: FaxVerticalResolution.STANDARD
- setVerticalResolution
  
  public void setVerticalResolution(FaxVerticalResolution value)
  
  The vertical image resolution (Setter)
  
  This property allows a choice of which vertical resolution to use. For details, see FaxVerticalResolution.
  
  Note that the horizontal resolution is fixed at 204 DPI by the Fax standard.
  
  Default: FaxVerticalResolution.STANDARD
  
  Throws:
  
  IllegalArgumentException - if value is null
- getCompression
  
  public TiffBitonalCompressionType getCompression()
  
  The Fax compression algorithm (Getter)
  
  This property allows a choice of which compression type to use. For details, see TiffBitonalCompressionType.
  
  Default: TiffBitonalCompressionType.G3
- setCompression
  
  public void setCompression(TiffBitonalCompressionType value)
  
  The Fax compression algorithm (Setter)
  
  This property allows a choice of which compression type to use. For details, see TiffBitonalCompressionType.
  
  Default: TiffBitonalCompressionType.G3
  
  Throws:
  
  IllegalArgumentException - if value is null