ToImageOptionsSpec (AEM Forms API)

java.lang.Object
- com.adobe.fd.cpdf.api.ToImageOptionsSpec

All Implemented Interfaces:

Serializable
```
public class ToImageOptionsSpec
extends Object
implements Serializable
```
Enables you to define run-time options that control how the Convert PDF service converts a PDF document to image files.To see this data type used in a code example, see the Converting a PDF document to JPEG files using the Java API quick start in Programming with LiveCycle ES.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected CMYKPolicy`	`cmykPolicy`
`protected ColorCompression`	`colorCompression`
`protected ColorSpace`	`colorSpace`
`protected PNGFilter`	`filter`
`protected JPEGFormat`	`format`
`protected GrayScaleCompression`	`grayScaleCompression`
`protected GrayScalePolicy`	`grayScalePolicy`
`protected ImageConvertFormat`	`imageConvertFormat`
`protected String`	`imageSizeHeight`
`protected String`	`imageSizeWidth`
`protected boolean`	`includeComments`
`protected Interlace`	`interlace`
`protected MonochromeCompression`	`monochrome`
`protected Boolean`	`multiPageTiff`
`protected String`	`pageRange`
`protected String`	`resolution`
`protected RGBPolicy`	`rgbPolicy`
`protected int`	`rowsPerStrip`
`protected int`	`tileSize`
`protected boolean`	`useLegacyImageSizeBehavior`

Constructor Summary

Constructors
Constructor and Description

ToImageOptionsSpec()

Constructors
Constructor and Description
`ToImageOptionsSpec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CMYKPolicy`	`getCmykPolicy()` Retrieves the CMYK policy.
`ColorCompression`	`getColorCompression()` Retrieves the color compression.
`ColorSpace`	`getColorSpace()` Retrieves the color space.
`PNGFilter`	`getFilter()` Retrieves the PNG filter value.
`JPEGFormat`	`getFormat()` Retrieves the JPEG format.
`GrayScaleCompression`	`getGrayScaleCompression()` Retrieves the grayscale compression.
`GrayScalePolicy`	`getGrayScalePolicy()` Retrieves the grayscale policy.
`ImageConvertFormat`	`getImageConvertFormat()` Retrieves the image conversion format.
`String`	`getImageSizeHeight()` Returns a string value that specifies the page height of the resulting image file.
`String`	`getImageSizeWidth()` Returns a string value that specifies the page width of the resulting image file.
`Interlace`	`getInterlace()` Retrieves the interlace.
`MonochromeCompression`	`getMonochrome()` Retrieves the monochrome compression.
`Boolean`	`getMultiPageTiff()` Specifies whether the output TIFF should be located on multiple pages.
`String`	`getPageRange()` Returns a string value that specifies the page range value.
`String`	`getResolution()` Retrieves the image resolution.
`RGBPolicy`	`getRgbPolicy()` Retrieves the RGB policy.
`int`	`getRowsPerStrip()` Gets the rows for each strip.
`int`	`getTileSize()` Retrieves the tile size.
`boolean`	`isIncludeComments()` Specifies whether comments are included when converting the PDF document.
`boolean`	`isUseLegacyImageSizeBehavior()` returns the option whether the legacy image size behavior needs to be used or not
`void`	`setCmykPolicy(CMYKPolicy cmykPolicy)` Sets the CMYK policy.
`void`	`setColorCompression(ColorCompression colorCompression)` Sets the color compression.
`void`	`setColorSpace(ColorSpace colorSpace)` Sets the color space.
`void`	`setFilter(PNGFilter filter)` Sets the filter.
`void`	`setFormat(JPEGFormat format)` Sets the JPEG format.
`void`	`setGrayScaleCompression(GrayScaleCompression grayScaleCompression)` Sets the grayscale compression.
`void`	`setGrayScalePolicy(GrayScalePolicy grayScalePolicy)` Sets the grayscale policy.
`void`	`setImageConvertFormat(ImageConvertFormat imageConvertFormat)` Sets the image conversion format.
`void`	`setImageSizeHeight(String imageSizeHeight)` Sets the image height of the resulting image file.
`void`	`setImageSizeWidth(String imageSizeWidth)` Sets the image width of the resulting image file.
`void`	`setIncludeComments(boolean includeComments)` Specifies that comments are included when converting the PDF document.
`void`	`setInterlace(Interlace interlace)` Sets the interlace.
`void`	`setMonochrome(MonochromeCompression monochrome)` Sets the monochrome compression.
`void`	`setMultiPageTiff(Boolean multiPageTiff)` Sets whether the output TIFF should be located on multiple pages.
`void`	`setPageRange(String pageRange)` Sets a string value that specifies the page range value.
`void`	`setResolution(String resolution)` Sets the image resolution.
`void`	`setRgbPolicy(RGBPolicy rgbPolicy)` Sets the RGB policy.
`void`	`setRowsPerStrip(int rowsPerStrip)` Sets the rows for each strip.
`void`	`setTileSize(int tileSize)` Sets the image tile size.
`void`	`setUseLegacyImageSizeBehavior(boolean useLegacyImageSizeBehavior)` sets the option to use legacy image size behavior or not

- Field Detail
  - imageConvertFormat
```
protected ImageConvertFormat imageConvertFormat
```
  - grayScaleCompression
```
protected GrayScaleCompression grayScaleCompression
```
  - colorCompression
```
protected ColorCompression colorCompression
```
  - format
```
protected JPEGFormat format
```
  - rgbPolicy
```
protected RGBPolicy rgbPolicy
```
  - cmykPolicy
```
protected CMYKPolicy cmykPolicy
```
  - grayScalePolicy
```
protected GrayScalePolicy grayScalePolicy
```
  - colorSpace
```
protected ColorSpace colorSpace
```
  - resolution
```
protected String resolution
```
  - tileSize
```
protected int tileSize
```
  - rowsPerStrip
```
protected int rowsPerStrip
```
  - interlace
```
protected Interlace interlace
```
  - filter
```
protected PNGFilter filter
```
  - monochrome
```
protected MonochromeCompression monochrome
```
  - multiPageTiff
```
protected Boolean multiPageTiff
```
  - includeComments
```
protected boolean includeComments
```
  - imageSizeWidth
```
protected String imageSizeWidth
```
  - imageSizeHeight
```
protected String imageSizeHeight
```
  - pageRange
```
protected String pageRange
```
  - useLegacyImageSizeBehavior
```
protected boolean useLegacyImageSizeBehavior
```
- Constructor Detail
  - ToImageOptionsSpec
```
public ToImageOptionsSpec()
```
- Method Detail
  - isUseLegacyImageSizeBehavior
```
public boolean isUseLegacyImageSizeBehavior()
```
    returns the option whether the legacy image size behavior needs to be used or not
    
    Returns:
    
    whether or not legacy image size behavior will be used
  - setUseLegacyImageSizeBehavior
```
public void setUseLegacyImageSizeBehavior(boolean useLegacyImageSizeBehavior)
```
    sets the option to use legacy image size behavior or not
    
    Parameters:
    
    useLegacyImageSizeBehavior -
  - getImageConvertFormat
```
public ImageConvertFormat getImageConvertFormat()
```
    Retrieves the image conversion format.
    
    Returns:
    
    An ImageConvertFormat enumeration value that specifies the image conversion format.
    
    See Also:
    
    ImageConvertFormat
  - setImageConvertFormat
```
public void setImageConvertFormat(ImageConvertFormat imageConvertFormat)
```
    Sets the image conversion format. This run-time option must be set.
    
    Parameters:
    
    imageConvertFormat - An ImageConvertFormat enumeration value that specifies the image conversion format.
    
    See Also:
    
    ImageConvertFormat
  - getCmykPolicy
```
public CMYKPolicy getCmykPolicy()
```
    Retrieves the CMYK policy.
    
    Returns:
    
    A CMYKPolicy enumeration value that specifies the CMYK policy.
    
    See Also:
    
    CMYKPolicy
  - setCmykPolicy
```
public void setCmykPolicy(CMYKPolicy cmykPolicy)
```
    Sets the CMYK policy. This option is valid for conversion to JPEG, JPEG2K, and TIFF formats.
    
    Parameters:
    
    cmykPolicy - A CMYKPolicy enumeration value that specifies the CMYK policy.
    
    See Also:
    
    CMYKPolicy
  - getColorCompression
```
public ColorCompression getColorCompression()
```
    Retrieves the color compression.
    
    Returns:
    
    A ColorCompression enumeration value that specifies the color compression option.
    
    See Also:
    
    ColorCompression
  - setColorCompression
```
public void setColorCompression(ColorCompression colorCompression)
```
    Sets the color compression. This option is valid for conversion to JPEG, JPEG2K, and TIFF formats.
    
    Parameters:
    
    colorCompression - A ColorCompression enumeration value that specifies the color compression option.
    
    See Also:
    
    ColorCompression
  - getColorSpace
```
public ColorSpace getColorSpace()
```
    Retrieves the color space.
    
    Returns:
    
    A ColorSpace enumeration value that specifies the color space option.
    
    See Also:
    
    ColorSpace
  - setColorSpace
```
public void setColorSpace(ColorSpace colorSpace)
```
    Sets the color space.
    
    Parameters:
    
    colorSpace - A ColorSpace enumeration value that specifies the color space option.
    
    See Also:
    
    ColorSpace
  - getFilter
```
public PNGFilter getFilter()
```
    Retrieves the PNG filter value.
    
    Returns:
    
    A PNGFilter enumeration value that specifies the PNG filter value.
    
    See Also:
    
    PNGFilter
  - setFilter
```
public void setFilter(PNGFilter filter)
```
    Sets the filter. This option is valid for conversion to PNG format only.
    
    Parameters:
    
    filter - A PNGFilter enumeration value that specifies the PNG filter value.
    
    See Also:
    
    PNGFilter
  - getFormat
```
public JPEGFormat getFormat()
```
    Retrieves the JPEG format.
    
    Returns:
    
    A JPEGFormat enumeration value that specifies the JPEG format.
    
    See Also:
    
    JPEGFormat
  - setFormat
```
public void setFormat(JPEGFormat format)
```
    Sets the JPEG format. This option is valid for conversion to JPEG format only.
    
    Parameters:
    
    format - A JPEGFormat enumeration value that specifies the JPEG format.
    
    See Also:
    
    JPEGFormat
  - getGrayScaleCompression
```
public GrayScaleCompression getGrayScaleCompression()
```
    Retrieves the grayscale compression.
    
    Returns:
    
    A GrayScaleCompression enumeration value that specifies the grayscale compression.
    
    See Also:
    
    GrayScaleCompression
  - setGrayScaleCompression
```
public void setGrayScaleCompression(GrayScaleCompression grayScaleCompression)
```
    Sets the grayscale compression. This option is valid for conversion to JPEG, JPEG2K, and TIFF formats.
    
    Parameters:
    
    grayScaleCompression - A GrayScaleCompression enumeration value that specifies the grayscale compression.
    
    See Also:
    
    GrayScaleCompression
  - getGrayScalePolicy
```
public GrayScalePolicy getGrayScalePolicy()
```
    Retrieves the grayscale policy.
    
    Returns:
    
    A GrayScalePolicy enumeration value that specifies the grayscale compression policy.
    
    See Also:
    
    GrayScalePolicy
  - setGrayScalePolicy
```
public void setGrayScalePolicy(GrayScalePolicy grayScalePolicy)
```
    Sets the grayscale policy. This option is valid for conversion to JPEG, JPEG2K, and TIFF formats.
    
    Parameters:
    
    grayScalePolicy - A GrayScalePolicy enumeration value that specifies the grayscale compression policy.
    
    See Also:
    
    GrayScalePolicy
  - getInterlace
```
public Interlace getInterlace()
```
    Retrieves the interlace.
    
    Returns:
    
    An Interlace enumeration value that specifies the interlace.
    
    See Also:
    
    Interlace
  - setInterlace
```
public void setInterlace(Interlace interlace)
```
    Sets the interlace. This option is valid for conversion to PNG format only.
    
    Parameters:
    
    interlace - An Interlace enumeration value that specifies the interlace.
    
    See Also:
    
    Interlace
  - getMonochrome
```
public MonochromeCompression getMonochrome()
```
    Retrieves the monochrome compression.
    
    Returns:
    
    A MonochromeCompression enumeration value that specifies the monochrome compression.
    
    See Also:
    
    MonochromeCompression
  - setMonochrome
```
public void setMonochrome(MonochromeCompression monochrome)
```
    Sets the monochrome compression. This option is valid for conversion to TIFF format only.
    
    Parameters:
    
    monochrome - A MonochromeCompression enumeration value that specifies the monochrome compression.
    
    See Also:
    
    MonochromeCompression
  - getResolution
```
public String getResolution()
```
    Retrieves the image resolution. A valid value is between 1 - 2400px/inch (inclusive).
    
    Returns:
    
    A string value that specifies the image resolution.
  - setResolution
```
public void setResolution(String resolution)
```
    Sets the image resolution.
    
    Parameters:
    
    resolution - A string value that specifies the image resolution.
  - getRgbPolicy
```
public RGBPolicy getRgbPolicy()
```
    Retrieves the RGB policy.
    
    Returns:
    
    A RGBPolicy enumeration value that specifies the RGB policy.
    
    See Also:
    
    RGBPolicy
  - setRgbPolicy
```
public void setRgbPolicy(RGBPolicy rgbPolicy)
```
    Sets the RGB policy.
    
    Parameters:
    
    rgbPolicy - A RGBPolicy enumeration value that specifies the RGB policy.
    
    See Also:
    
    RGBPolicy
  - getTileSize
```
public int getTileSize()
```
    Retrieves the tile size.
    
    Returns:
    
    The tile size, which will have a value in the following range: 128-2048.
  - setTileSize
```
public void setTileSize(int tileSize)
```
    Sets the image tile size. This option is valid for conversion to JPEG2K format only.
    
    Parameters:
    
    tileSize - The image tile size. It must be assigned a value in the following range: 128-2048.
  - getRowsPerStrip
```
public int getRowsPerStrip()
```
    Gets the rows for each strip.
    
    Returns:
    
    The number of rows for each strip.
  - setRowsPerStrip
```
public void setRowsPerStrip(int rowsPerStrip)
```
    Sets the rows for each strip.
    
    Parameters:
    
    rowsPerStrip - The number of rows for each strip.
  - getMultiPageTiff
```
public Boolean getMultiPageTiff()
```
    Specifies whether the output TIFF should be located on multiple pages. This does not work in toImage API and should be used only with toImage2 API.
    
    Returns:
    
    A boolean value that specifies whether the output TIFF file should be on multiple pages.
  - setMultiPageTiff
```
public void setMultiPageTiff(Boolean multiPageTiff)
```
    Sets whether the output TIFF should be located on multiple pages. This does not work in toImage API and should be used only with toImage2 API.
    
    Parameters:
    
    multiPageTiff - A boolean value that specifies whether the output TIFF file should be on multiple pages.
  - isIncludeComments
```
public boolean isIncludeComments()
```
    Specifies whether comments are included when converting the PDF document. This does not work in toImage API and should be used only with toImage2 API.
    
    Returns:
    
    A boolean value that specifies whether comments are included.
  - setIncludeComments
```
public void setIncludeComments(boolean includeComments)
```
    Specifies that comments are included when converting the PDF document. This does not work in toImage API and should be used only with toImage2 API.
    
    Parameters:
    
    includeComments - boolean value that specifies whether comments are included.
  - getImageSizeHeight
```
public String getImageSizeHeight()
```
    Returns a string value that specifies the page height of the resulting image file.
    
    Returns:
    
    A string value that specifies the page height of the resulting image file. This does not work in toImage API and should be used only with toImage2 API.
    
    See Also:
    
    setImageSizeHeight()
  - setImageSizeHeight
```
public void setImageSizeHeight(String imageSizeHeight)
```
    Sets the image height of the resulting image file.
    
    Parameters:
    
    imageSizeHeight - A string value that specifies the image height of the resulting image file. This does not work in toImage API and should be used only with toImage2 API.
  - getImageSizeWidth
```
public String getImageSizeWidth()
```
    Returns a string value that specifies the page width of the resulting image file.
    
    Returns:
    
    A string value that specifies the page width of the resulting image file. This does not work in toImage API and should be used only with toImage2 API.
    
    See Also:
    
    setImageSizeWidth()
  - setImageSizeWidth
```
public void setImageSizeWidth(String imageSizeWidth)
```
    Sets the image width of the resulting image file.
    
    Parameters:
    
    imageSizeWidth - A string value that specifies the image width of the resulting image file. This does not work in toImage API and should be used only with toImage2 API.
  - getPageRange
```
public String getPageRange()
```
    Returns a string value that specifies the page range value. For example, 1: "2-6", Example 2: "1,3,5-9,21-30". This does not work in toImage API and should be used only with toImage2 API.
    
    Returns:
    
    the pageRange
  - setPageRange
```
public void setPageRange(String pageRange)
```
    Sets a string value that specifies the page range value. Passing an empty value results all pages used witin the page range. This does not work in toImage API and should be used only with toImage2 API.
    
    Parameters:
    
    pageRange - the pageRange to set

Class ToImageOptionsSpec

Field Summary

Constructor Summary

Method Summary

Field Detail

imageConvertFormat

grayScaleCompression

colorCompression

format

rgbPolicy

cmykPolicy

grayScalePolicy

colorSpace

resolution

tileSize

rowsPerStrip

interlace

filter

monochrome

multiPageTiff

includeComments

imageSizeWidth

imageSizeHeight

pageRange

useLegacyImageSizeBehavior

Constructor Detail

ToImageOptionsSpec

Method Detail

isUseLegacyImageSizeBehavior

setUseLegacyImageSizeBehavior

getImageConvertFormat

setImageConvertFormat

getCmykPolicy

setCmykPolicy

getColorCompression

setColorCompression

getColorSpace

setColorSpace

getFilter

setFilter

getFormat

setFormat

getGrayScaleCompression

setGrayScaleCompression

getGrayScalePolicy

setGrayScalePolicy

getInterlace

setInterlace

getMonochrome

setMonochrome

getResolution

setResolution

getRgbPolicy

setRgbPolicy

getTileSize

setTileSize

getRowsPerStrip

setRowsPerStrip

getMultiPageTiff

setMultiPageTiff

isIncludeComments

setIncludeComments

getImageSizeHeight

setImageSizeHeight

getImageSizeWidth

setImageSizeWidth

getPageRange

setPageRange