public static class

Convert.TiffOutputOptions

extends Object
java.lang.Object
   ↳ com.pdftron.pdf.Convert.TiffOutputOptions

Class Overview

A class containing options common to ToTiff functions

Summary

Constants
int e_art The Constant e_art.
int e_bleed The Constant e_bleed.
int e_crop The Constant e_crop.
int e_media The Constant e_media.
int e_op_off
int e_op_on
int e_op_pdfx_on
int e_trim The Constant e_trim.
Public Constructors
TiffOutputOptions()
Creates an TiffOutputOptions object with default settings
Public Methods
void setAnnots(boolean enable)
Enables or disables drawing of annotations.
void setBox(int type)
Specifies the page box/region to rasterize.
void setCMYK(boolean enable)
Render and export the image in CMYK mode.
void setDPI(double dpi)
The output resolution, from 1 to 1000, in Dots Per Inch (DPI).
void setDither(boolean enable)
Enables dithering when the image is exported in palletized or monochrome mode.
void setGamma(double gamma)
Sets the gamma factor used for anti-aliased rendering.
void setGray(boolean enable)
Render and export the image in grayscale mode.
void setHRes(int hres)
Sets the width of the output image, in pixels.
void setMono(boolean enable)
Export the rendered image as 1 bit per pixel (monochrome) image.
void setOverprint(int mode)
Enable or disable support for overprint and overprint simulation.
void setPages(String page_desc)
Specifies the list of pages to convert.
void setPalettized(boolean enable)
Enabled the output of palettized TIFFs.
void setPrintmode(boolean enable)
Renders annotations in the print mode.
void setRotate(double x1, double y1, double x2, double y2)
User definable clip box.
void setRotate(int rotate)
Rotates all pages by a given number of degrees counterclockwise.
void setSmooth(boolean enable)
Enables or disables image smoothing (default: enabled).
void setTransparentPage(boolean enable)
Sets the page color to transparent.
void setVRes(int vres)
Sets the height of the output image, in pixels.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int e_art

The Constant e_art.

Constant Value: 4 (0x00000004)

public static final int e_bleed

The Constant e_bleed.

Constant Value: 2 (0x00000002)

public static final int e_crop

The Constant e_crop.

Constant Value: 1 (0x00000001)

public static final int e_media

The Constant e_media.

Constant Value: 0 (0x00000000)

public static final int e_op_off

Constant Value: 0 (0x00000000)

public static final int e_op_on

Constant Value: 1 (0x00000001)

public static final int e_op_pdfx_on

Constant Value: 2 (0x00000002)

public static final int e_trim

The Constant e_trim.

Constant Value: 3 (0x00000003)

Public Constructors

public TiffOutputOptions ()

Creates an TiffOutputOptions object with default settings

Public Methods

public void setAnnots (boolean enable)

Enables or disables drawing of annotations. This option is enabled by default.

Parameters
enable if false then annotations will not be drawn
Throws
PDFNetException

public void setBox (int type)

Specifies the page box/region to rasterize. Possible values are media, crop, trim, bleed, and art. By default, page crop region will be rasterized.

Parameters
type The type cf box to use
Throws
PDFNetException

public void setCMYK (boolean enable)

Render and export the image in CMYK mode. By default, the image is rendered and exported in RGB color space.

Parameters
enable if true then cmyk will be enabled
Throws
PDFNetException

public void setDPI (double dpi)

The output resolution, from 1 to 1000, in Dots Per Inch (DPI). The higher the DPI, the larger the image. Resolutions larger than 1000 DPI can be achieved by rendering image in tiles or stripes. The default resolution is 92 DPI.

Parameters
dpi specifies the output DPI
Throws
PDFNetException

public void setDither (boolean enable)

Enables dithering when the image is exported in palletized or monochrome mode. This option is disabled by default.

Parameters
enable if true then dithering will be enabled
Throws
PDFNetException

public void setGamma (double gamma)

Sets the gamma factor used for anti-aliased rendering. Typical values are in the range from 0.1 to 3. Gamma correction can be used to improve the quality of anti-aliased image output and can (to some extent) decrease the appearance common anti-aliasing artifacts (such as pixel width lines between polygons). The default gamma is 0.

Parameters
gamma specifies the gamma factor
Throws
PDFNetException

public void setGray (boolean enable)

Render and export the image in grayscale mode. Sets pixel format to 8 bits per pixel grayscale. By default, the image is rendered and exported in RGB color space.

Parameters
enable if true then grayscale will be enabled
Throws
PDFNetException

public void setHRes (int hres)

Sets the width of the output image, in pixels.

Parameters
hres specifies the width
Throws
PDFNetException

public void setMono (boolean enable)

Export the rendered image as 1 bit per pixel (monochrome) image. The image will be compressed using G4 CCITT compression algorithm. By default, the image is not dithered. To enable dithering use 'SetDither' option. This option is disabled by default.

Parameters
enable if true then monochrome will be enabled
Throws
PDFNetException

public void setOverprint (int mode)

Enable or disable support for overprint and overprint simulation. Overprint is a device dependent feature and the results will vary depending on the output color space and supported colorants (i.e. CMYK, CMYK+spot, RGB, etc). Default is e_op_pdfx_on.

Parameters
mode e_op_on: always enabled; e_op_off: always disabled; e_op_pdfx_on: enabled for PDF/X files only.
Throws
PDFNetException

public void setPages (String page_desc)

Specifies the list of pages to convert. "1" for only the first page. "1-5" for pages 1 to 5. "1, 5, 7" for pages 1, 5, and 7. "odd" for all odd pages. "even" for all even pages. By default, all pages are converted.

Parameters
page_desc A description of the pages to be converted.
Throws
PDFNetException

public void setPalettized (boolean enable)

Enabled the output of palettized TIFFs. This option is disabled by default.

Parameters
enable if true then the TIFF will be palettized
Throws
PDFNetException

public void setPrintmode (boolean enable)

Renders annotations in the print mode. This option can be used to render 'Print Only' annotations and to hide 'Screen Only' annotations. This option is disabled by default.

Parameters
enable if true then print mode will be enabled
Throws
PDFNetException

public void setRotate (double x1, double y1, double x2, double y2)

User definable clip box. By default, the clip region is identical to current page 'box'.

Parameters
x1 The value of the x1 coordinate
y1 The value of the y1 coordinate
x2 The value of the x2 coordinate
y2 The value of the y2 coordinate
Throws
PDFNetException

public void setRotate (int rotate)

Rotates all pages by a given number of degrees counterclockwise. The allowed values are 0, 90, 180, and 270. The default value is 0.

Parameters
rotate The type cf box to use
Throws
PDFNetException

public void setSmooth (boolean enable)

Enables or disables image smoothing (default: enabled).

Parameters
enable if false then images will not be smoothed
Throws
PDFNetException

public void setTransparentPage (boolean enable)

Sets the page color to transparent. By default, Convert assumes that the page is drawn directly on an opaque white surface. Some applications may need to draw the page on a different backdrop. In this case any pixels that are not covered during rendering will be transparent. This option is disabled by default.

Parameters
enable if true then transparent page will be enabled
Throws
PDFNetException

public void setVRes (int vres)

Sets the height of the output image, in pixels.

Parameters
vres specifies the width
Throws
PDFNetException