com.adobe.livecycle.convertpdfservice.client
Class ToImageOptionsSpec

java.lang.Object
  com.adobe.livecycle.convertpdfservice.client.ToImageOptionsSpec

All Implemented Interfaces:

java.io.Serializable

public class ToImageOptionsSpec
extends java.lang.Object
implements java.io.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 ES4.

See Also:

Serialized Form

Constructor Summary

ToImageOptionsSpec()
The standard default constructor.

ToImageOptionsSpec(java.lang.String sOptions)
A constructor that enables you to specify a standard query string that sets conversion run-time options.

Method Summary

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.
java.lang.String	getImageSizeHeight() Returns a string value that specifies the page height of the resulting image file.
java.lang.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.
java.lang.Boolean	getMultiPageTiff() Specifies whether the output TIFF should be located on multiple pages.
java.lang.String	getOptions() Retrieves the entire option string.
java.lang.String	getPageRange() Returns a string value that specifies the page range value.
java.lang.String	getProperty(java.lang.String key) For internal use only.
java.lang.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	resetProperty(java.lang.String key) Resets the specified property.
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(java.lang.String imageSizeHeight) Sets the image height of the resulting image file.
void	setImageSizeWidth(java.lang.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(java.lang.Boolean multiPageTiff) Sets whether the output TIFF should be located on multiple pages.
void	setPageRange(java.lang.String pageRange) Sets a string value that specifies the page range value.
void	setResolution(java.lang.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
java.lang.String	toString() Retrieves the entire option string.
void	updateOptionsBean(java.lang.String key, java.lang.String value) For internal use only.
void	updateOptionsSpec(java.lang.String options) For internal use only.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToImageOptionsSpec

public ToImageOptionsSpec()

The standard default constructor.

ToImageOptionsSpec

public ToImageOptionsSpec(java.lang.String sOptions)
                   throws ConvertPdfException

A constructor that enables you to specify a standard query string that sets conversion run-time options. For example, ConversionFormat=jpeg&GrayCompression=low.

Throws:

ConvertPdfException

Method Detail

isUseLegacyImageSizeBehavior

public boolean isUseLegacyImageSizeBehavior()

returns the option whether the legacy image size behavior needs to be used or not

Returns:

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 java.lang.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(java.lang.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 java.lang.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(java.lang.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:

A - boolean value that specifies whether comments are included.

getImageSizeHeight

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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

updateOptionsSpec

public void updateOptionsSpec(java.lang.String options)
                       throws ConvertPdfException

For internal use only.

Throws:

ConvertPdfException

updateOptionsBean

public void updateOptionsBean(java.lang.String key,
                              java.lang.String value)
                       throws ConvertPdfException

For internal use only.

Throws:

ConvertPdfException

toString

public java.lang.String toString()

Retrieves the entire option string.

Overrides:

toString in class java.lang.Object

Returns:

The entire option string.

getOptions

public java.lang.String getOptions()

Retrieves the entire option string.

Returns:

The entire option string.

resetProperty

public void resetProperty(java.lang.String key)

Resets the specified property.

Parameters:

key - The property name.

getProperty

public java.lang.String getProperty(java.lang.String key)

For internal use only.