com.adobe.livecycle.convertpdfservice.client
Class ToPSOptionsSpec

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

All Implemented Interfaces:

java.io.Serializable

public final class ToPSOptionsSpec
extends java.lang.Object
implements java.io.Serializable

Represents run-time options that are used when converting a PDF document to a PostScript file. Using this class, you can specify run-time options such as the page size of the PostScript file. To see this class used within a code example, see the Converting a PDF document to PostScript using the Java API quick start in Programming with Adobe Experience Manager forms.

See Also:

Serialized Form

Constructor Summary

ToPSOptionsSpec()
A constructor that creates a ToPSOptionsSpec object.

Method Summary

Color	getColor() Returns a Color enumeration value that represents the composite color that is used in the resulting PostScript file.
FontInclusion	getFontInclusion() Returns a FontInclusion enumeration value.
LineWeight	getLineWeight() Returns a LineWeight enumeration value that specifies the weight of the lines in the resulting PostScript file.
java.lang.String	getOptions() For internal use only.
java.lang.String	getOptionsBean(java.lang.String key) For internal use only.
java.lang.String	getPageRange() Returns a string value that specifies the page range value.
PageSize	getPageSize() Returns a PageSize enumeration value that specifies the size of pages in the resulting PostScript file.
java.lang.String	getPageSizeHeight() Returns a string value that specifies the page height of the resulting PostScript file.
java.lang.String	getPageSizeWidth() Returns a string value that specifies the page width of the resulting PostScript file.
PSLevel	getPsLevel() Returns the PostScript language level of the resulting PostScript file.
int	getResolution() Deprecated.
Style	getStyle() Returns a Style enumeration value that specifies the style of printer marks to create.
boolean	isAllowBinaryContent() Specifies whether the PostScript file is created in a binary format.
boolean	isBleedMarks() Specifies if the Bleed Marks option is set.
boolean	isColorBars() Returns the value true if the ColorBars option is set.
boolean	isConvertTrueTypeToType1() Returns the value true if the ConvertTrueTypeToType1 option is set.
boolean	isEmitCIDFontType2() Returns the value true if the EmitCIDFontType2 option is set.
boolean	isEmitPSFormObjects() Returns the value true if the EmitPSFormObjects option is set.
boolean	isExpandToFit() Returns the value true if the ExpandToFit option is set.
boolean	isIncludeComments() Returns the value true if the IncludeComments option is set.
boolean	isLegacyToSimplePSFlag() Returns the value true if the LegacyToSimplePSFlag option is set.
boolean	isPageInformation() Returns the value true if the PageInformation option is set.
boolean	isRegistrationMarks() Returns the value true if the RegistrationMarks option is set.
boolean	isReverse() Returns the value true if the Reverse option is set.
boolean	isRotateAndCenter() Returns the value true if the RotateAndCenter option is set.
boolean	isShrinkToFit() Returns the value true if the ShrinkToFit option is set.
boolean	isTrimMarks() Returns the value true if the TrimMarks option is set.
boolean	isUseMaxJPEGImageResolution() Returns the value true if the UseMaxJPEGImageResolution option is set This option indicates that the highest available resolution for printing JPEG 2000 images is used.
void	setAllowBinaryContent(boolean allowBinaryContent) Sets if the PostScript file is created in a binary format.
void	setBleedMarks(boolean bleedMarks) Sets the Bleed Marks option.
void	setColor(Color color) Sets the Color object that represents the composite color.
void	setColorBars(boolean colorBars) Sets the ColorBars option.
void	setConvertTrueTypeToType1(boolean convertTrueTypeToType1) Sets the ConvertTrueTypeToType1 option.
void	setEmitCIDFontType2(boolean emitCIDFontType2) Sets the EmitCIDFontType2 option.
void	setEmitPSFormObjects(boolean emitPSFormObjects) Sets the EmitCIDFontType2 option.
void	setExpandToFit(boolean expandToFit) Sets the ExpandToFit option.
void	setFontInclusion(FontInclusion fontInclusion) Sets the FontInclusion option.
void	setIncludeComments(boolean includeComments) Sets the IncludeComments option.
void	setLegacyToSimplePSFlag(boolean legacyToSimplePSFlag) Sets the LegacyToSimplePSFlag option.
void	setLineWeight(LineWeight lineWeight) Sets the weight of the lines in the resulting PostScript file.
void	setPageInformation(boolean pageInformation) Sets the PageInformation option.
void	setPageRange(java.lang.String pageRange) Sets a string value that specifies the page range value.
void	setPageSize(PageSize pageSize) Sets a PageSize enumeration value that specifies the size of pages in the resulting PostScript file.
void	setPageSizeHeight(java.lang.String pageSizeHeight) Sets the page height of the resulting PostScript file.
void	setPageSizeWidth(java.lang.String pageSizeWidth) Sets the page width of the resulting PostScript file.
void	setPsLevel(PSLevel psLevel) Sets the PostScript language level of the resulting PostScript file.
void	setRegistrationMarks(boolean registrationMarks) Sets the RegistrationMarks option.
void	setResolution(int resolution) Deprecated.
void	setReverse(boolean reverse) Sets the Reverse option.
void	setRotateAndCenter(boolean rotateAndCenter) Sets the RotateAndCenter option.
void	setShrinkToFit(boolean shrinkToFit) Sets the ShrinkToFit option.
void	setStyle(Style style) Sets a Style enumeration value that specifies the style of printer marks to create.
void	setTrimMarks(boolean trimMarks) Sets the TrimMarks option.
void	setUseMaxJPEGImageResolution(boolean useMaxJPEGImageResolution) Sets the UseMaxJPEGImageResolution option.
java.lang.String	toString() Retrieves the entire option string.
void	updateOptionsBean(java.lang.String options) For internal use only.
void	updateOptionsBean(java.lang.String key, java.lang.String value) For internal use only.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToPSOptionsSpec

public ToPSOptionsSpec()

A constructor that creates a ToPSOptionsSpec object.

Method Detail

isLegacyToSimplePSFlag

public boolean isLegacyToSimplePSFlag()

Returns the value true if the LegacyToSimplePSFlag option is set. This would support conversion of interactive documents to postscript.

Returns:

A boolean value that specifies if the LegacyToSimplePSFlag option is set.

See Also:

setLegacyToSimplePSFlag()

setLegacyToSimplePSFlag

public void setLegacyToSimplePSFlag(boolean legacyToSimplePSFlag)

Sets the LegacyToSimplePSFlag option. This would support conversion of interactive documents to postscript.

Parameters:

legacyToSimplePSFlag - A boolean value that specifies if the LegacyToSimplePSFlag option is set.

isAllowBinaryContent

public boolean isAllowBinaryContent()

Specifies whether the PostScript file is created in a binary format.

Returns:

A boolean value that specifies whether the PostScript file is created in binary format.

setAllowBinaryContent

public void setAllowBinaryContent(boolean allowBinaryContent)

Sets if the PostScript file is created in a binary format.

Parameters:

A - boolean value that specifies whether the PostScript file is created in binary format.

isBleedMarks

public boolean isBleedMarks()

Specifies if the Bleed Marks option is set. This option indicates that a mark in each of the four corners of the bleed box is present.

Returns:

A boolean value that specifies if the Bleed Marks option is set.

setBleedMarks

public void setBleedMarks(boolean bleedMarks)

Sets the Bleed Marks option. This option indicates that a mark in each of the four corners of the bleed box is present.

Parameters:

bleedMarks - A boolean value that specifies if the Bleed Marks option is set.

getColor

public Color getColor()

Returns a Color enumeration value that represents the composite color that is used in the resulting PostScript file.

Returns:

A Color enumeration value that represents the composite color.

setColor

public void setColor(Color color)

Sets the Color object that represents the composite color.

Parameters:

color - A Color object that represents the color.

isColorBars

public boolean isColorBars()

Returns the value true if the ColorBars option is set. This option places a color bar at the top of the page, outside of the crop area. The color bar shows a single box for each spot or process color in the document. Spot colors converted to process colors are represented by process colors.

Returns:

A boolean value that specifies if the ColorBars option is set.

See Also:

setColorBars()

setColorBars

public void setColorBars(boolean colorBars)

Sets the ColorBars option. This option places a color bar at the top of the page, outside of the crop area. The color bar shows a single box for each spot or process color in the document. Spot colors converted to process colors are represented by process colors.

Parameters:

colorBars - A boolean value that specifies if the ColorBars option is set.

isConvertTrueTypeToType1

public boolean isConvertTrueTypeToType1()

Returns the value true if the ConvertTrueTypeToType1 option is set. This option converts TrueType fonts to Type 1 fonts in the resulting PostScript file. Some older PostScript output devices may require this conversion.

Returns:

A boolean value that specifies if the ConvertTrueTypeToType1 option is set.

See Also:

setConvertTrueTypeToType1()

setConvertTrueTypeToType1

public void setConvertTrueTypeToType1(boolean convertTrueTypeToType1)

Sets the ConvertTrueTypeToType1 option. This option converts TrueType fonts to Type 1 fonts in the resulting PostScript file. Some older PostScript output devices may require this conversion.

Parameters:

convertTrueTypeToType1 - the convertTrueTypeToType1 to set

isEmitCIDFontType2

public boolean isEmitCIDFontType2()

Returns the value true if the EmitCIDFontType2 option is set. This option preserves the hinting information in the original font when printing. If this option is not set, then CIDFontType2 fonts are converted to CIDFontType0 fonts, which are compatible with a wider range of printers.

Returns:

A boolean value that specifies if the EmitCIDFontType2 option is set.

See Also:

setEmitCIDFontType2()

setEmitCIDFontType2

public void setEmitCIDFontType2(boolean emitCIDFontType2)

Sets the EmitCIDFontType2 option. This option preserves the hinting information in the original font when printing. If this option is not set, then CIDFontType2 fonts are converted to CIDFontType0 fonts, which are compatible with a wider range of printers.

Parameters:

emitCIDFontType2 - A boolean value that specifies if the EmitCIDFontType2 option is set.

isEmitPSFormObjects

public boolean isEmitPSFormObjects()

Returns the value true if the EmitPSFormObjects option is set. Emit PostScript form objects for Form XObjects within the input PDF document. This may reduce the overall size of the print job, but it will increase the printer memory that is used. Form XObjects are used to create a single description for complex objects that can appear many times in a single document, like background images, for example.

Returns:

A boolean value that specifies if the EmitPSFormObjects option is set.

See Also:

setEmitPSFormObjects()

setEmitPSFormObjects

public void setEmitPSFormObjects(boolean emitPSFormObjects)

Sets the EmitCIDFontType2 option. Emit PostScript form objects for Form XObjects within the input PDF document. This may reduce the overall size of the print job, but it will increase the printer memory that is used. Form XObjects are used to create a single description for complex objects that can appear many times in a single document, like background images, for example.

Parameters:

emitPSFormObjects - A boolean value that specifies if the EmitPSFormObjects option is set.

isExpandToFit

public boolean isExpandToFit()

Returns the value true if the ExpandToFit option is set. This option expands the size of the resulting PostScript file to fit the page. When setting this option, you must also set the PageSize option using the setPageSize method.

Returns:

A boolean value that specifies if the ExpandToFit option is set.

setExpandToFit

public void setExpandToFit(boolean expandToFit)

Sets the ExpandToFit option. This option expands the size of the resulting PostScript file to fit the page. When setting this option, you must also set the PageSize option using the setPageSize method.

Parameters:

expandToFit - A boolean value that specifies if the ExpandToFit option is set.

getFontInclusion

public FontInclusion getFontInclusion()

Returns a FontInclusion enumeration value. This option controls which fonts should be included in the PostScript file. Embedded fonts are taken directly from the input PDF docuemnt. Referenced fonts are taken from the computer hosting Adobe Experience Manager forms.

Returns:

A FontInclusion enumeration value.

setFontInclusion

public void setFontInclusion(FontInclusion fontInclusion)

Sets the FontInclusion option. This option controls which fonts should be included in the PostScript file. Embedded fonts are taken directly from the input PDF docuemnt. Referenced fonts are taken from the computer hosting Adobe Experience Manager forms.

Parameters:

fontInclusion - A FontInclusion enumeration value.

isIncludeComments

public boolean isIncludeComments()

Returns the value true if the IncludeComments option is set. This option preserves the appearance of comments in the resulting PostScript file. The information located in the comment is not present in the resulting PostScript file, only the appearance of the comment.

Returns:

A boolean value that specifies if the IncludeComments option is set.

See Also:

setIncludeComments()

setIncludeComments

public void setIncludeComments(boolean includeComments)

Sets the IncludeComments option. This option preserves the appearance of comments in the resulting PostScript file. The information located in the comment is not present in the resulting PostScript file, only the appearance of the comment.

Parameters:

includeComments - A boolean value that specifies if the IncludeComments option is set.

getLineWeight

public LineWeight getLineWeight()

Returns a LineWeight enumeration value that specifies the weight of the lines in the resulting PostScript file.

Returns:

A LineWeight enumeration value.

See Also:

setLineWeight()

setLineWeight

public void setLineWeight(LineWeight lineWeight)

Sets the weight of the lines in the resulting PostScript file.

Parameters:

lineWeight - A LineWeight enumeration value that specifies the weight of the lines in the resulting PostScript file.

isPageInformation

public boolean isPageInformation()

Returns the value true if the PageInformation option is set. This option outputs page information outside of the crop area of the page.

Returns:

A boolean value that specifies if the PageInformation option is set.

See Also:

setPageInformation()

setPageInformation

public void setPageInformation(boolean pageInformation)

Sets the PageInformation option. This option outputs page information outside of the crop area of the page.

Parameters:

pageInformation - A boolean value that specifies if the PageInformation option is set.

getPageSizeHeight

public java.lang.String getPageSizeHeight()

Returns a string value that specifies the page height of the resulting PostScript file.

Returns:

A string value that specifies the page height of the resulting PostScript file.

See Also:

setPageSizeHeight()

setPageSizeHeight

public void setPageSizeHeight(java.lang.String pageSizeHeight)

Sets the page height of the resulting PostScript file.

Parameters:

pageSizeHeight - A string value that specifies the page height of the resulting PostScript file.

getPageSizeWidth

public java.lang.String getPageSizeWidth()

Returns a string value that specifies the page width of the resulting PostScript file.

Returns:

A string value that specifies the page width of the resulting PostScript file.

See Also:

setPageSizeWidth()

setPageSizeWidth

public void setPageSizeWidth(java.lang.String pageSizeWidth)

Sets the page width of the resulting PostScript file.

Parameters:

pageSizeWidth - A string value that specifies the page width of the resulting PostScript file.

getPsLevel

public PSLevel getPsLevel()

Returns the PostScript language level of the resulting PostScript file.

Returns:

A PSLevel enumeration value that specifies the PostScript language level of the resulting PostScript file.

See Also:

setPsLevel()

setPsLevel

public void setPsLevel(PSLevel psLevel)

Sets the PostScript language level of the resulting PostScript file.

To see this method used in a code example, see the Converting a PDF document to PostScript using the Java API quick start in Programming with Adobe Experience Manager forms.

Parameters:

psLevel - A PSLevel enumeration value that specifies the PostScript language level of the resulting PostScript file.

isRegistrationMarks

public boolean isRegistrationMarks()

Returns the value true if the RegistrationMarks option is set. This option places registration marks outside of the crop area of the page.

Returns:

A boolean value that specifies if the RegistrationMarks option is set.

See Also:

setRegistrationMarks()

setRegistrationMarks

public void setRegistrationMarks(boolean registrationMarks)

Sets the RegistrationMarks option. This option places registration marks outside of the crop area of the page.

Parameters:

registrationMarks - A boolean value that specifies if the RegistrationMarks option is set.

isReverse

public boolean isReverse()

Returns the value true if the Reverse option is set.

Returns:

A boolean value that specifies if the Reverse option is set.

setReverse

public void setReverse(boolean reverse)

Sets the Reverse option.

Parameters:

reverse - A boolean value that specifies if the RegistrationMarks option is set.

isRotateAndCenter

public boolean isRotateAndCenter()

Returns the value true if the RotateAndCenter option is set. This option centers the page content in the resulting PostScript document.

Returns:

A boolean value that specifies if the RotateAndCenter option is set.

See Also:

setRotateAndCenter()

setRotateAndCenter

public void setRotateAndCenter(boolean rotateAndCenter)

Sets the RotateAndCenter option. This option centers the page content in the resulting PostScript document.

To see this method used in a code example, see the Converting a PDF document to PostScript using the Java API quick start in Programming with Adobe Experience Manager forms.

Parameters:

rotateAndCenter - A boolean value that specifies if the RotateAndCenter option is set.

isShrinkToFit

public boolean isShrinkToFit()

Returns the value true if the ShrinkToFit option is set. This option shrinks the size of the resulting PostScript file to fit the page. When setting this option, you must also set the PageSize option using the setPageSize method.

Returns:

A boolean value that specifies if the ShrinkToFit option is set.

setShrinkToFit

public void setShrinkToFit(boolean shrinkToFit)

Sets the ShrinkToFit option. This option shrinks the size of the resulting PostScript file to fit the page. When setting this option, you must also set the PageSize option using the setPageSize method.

To see this method used in a code example, see the Converting a PDF document to PostScript using the Java API quick start in Programming with Adobe Experience Manager forms.

Parameters:

shrinkToFit - A boolean value that specifies if the ShrinkToFit option is set.

isTrimMarks

public boolean isTrimMarks()

Returns the value true if the TrimMarks option is set. This option indicates that marks are placed in each of the four corners of the trim box in the resulting PostScript file.

Returns:

A boolean value that specifies if the TrimMarks option is set.

setTrimMarks

public void setTrimMarks(boolean trimMarks)

Sets the TrimMarks option.

Parameters:

trimMarks - A boolean value that specifies if the TrimMarks option is set.

isUseMaxJPEGImageResolution

public boolean isUseMaxJPEGImageResolution()

Returns the value true if the UseMaxJPEGImageResolution option is set This option indicates that the highest available resolution for printing JPEG 2000 images is used. If you leave do not set this option, the pixels per inch value (from the Line Art and Text Resolution field in the Flattener Preview dialog) multipled by the value 2 is used as the rasterization resolution for JPEG2000 images. For example, if 72 ppi is selected (in the Line Art and Text Resolution field) and this option is not set, JPEG2000 images are rasterized into 144 ppi images.

Returns:

A boolean value that specifies if the UseMaxJPEGImageResolution option is set.

See Also:

setUseMaxJPEGImageResolution()

setUseMaxJPEGImageResolution

public void setUseMaxJPEGImageResolution(boolean useMaxJPEGImageResolution)

Sets the UseMaxJPEGImageResolution option. This option indicates that the highest available resolution for printing JPEG 2000 images is used. If you leave do not set this option, the pixels per inch value (from the Line Art and Text Resolution field in the Flattener Preview dialog) multipled by the value 2 is used as the rasterization resolution for JPEG2000 images. For example, if 72 ppi is selected (in the Line Art and Text Resolution field) and this option is not set, JPEG2000 images are rasterized into 144 ppi images.

Parameters:

useMaxJPEGImageResolution - A boolean value that specifies if the UseMaxJPEGImageResolution option is set.

getStyle

public Style getStyle()

Returns a Style enumeration value that specifies the style of printer marks to create.

Returns:

A Style enumeration value.

setStyle

public void setStyle(Style style)

Sets a Style enumeration value that specifies the style of printer marks to create.

Parameters:

style - A Style enumeration value.

getPageSize

public PageSize getPageSize()

Returns a PageSize enumeration value that specifies the size of pages in the resulting PostScript file.

Returns:

A PageSize enumeration value.

See Also:

setPageSize()

setPageSize

public void setPageSize(PageSize pageSize)

Sets a PageSize enumeration value that specifies the size of pages in the resulting PostScript file.

Parameters:

pageSize - A PageSize enumeration value that specifies the size of pages in the resulting PostScript file.

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

Returns:

A string value that specifies the page range value.

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.

Parameters:

pageRange - A string value that specifies the page range value.

getResolution

@Deprecated
public int getResolution()

Deprecated.

Returns the resolution that is used in the resulting PostScript file.

Returns:

An integer value that specifies the resolution that is used in the resulting PostScript file.

See Also:

setResolution()

setResolution

@Deprecated
public void setResolution(int resolution)

Deprecated.

Sets the resolution that is used in the resulting PostScript file.

Parameters:

resolution - An integer value that specifies the resolution that is used in the resulting PostScript file.

getOptions

public java.lang.String getOptions()

For internal use only.

getOptionsBean

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

For internal use only.

updateOptionsBean

public void updateOptionsBean(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.