FlattenTransparencyParams

java.lang.Object
- com.datalogics.PDFL.FlattenTransparencyParams

```
public class FlattenTransparencyParams
extends java.lang.Object
```
Represents control parameters for flattening transparencies within a PDF file. Class that represents control parameters for flattening transparencies within a PDF file. PDF files can hold objects that are stacked, and that are partially or fully transparent. This means that these objects can blend in various ways with objects behind them. With a stacked set of transparent graphics or images in a PDF file, each one contributing to the final result that appears on the page. One or more graphics images presented together in a stack is referred to as a transparency group. With a stack of transparent images, the final colors shown are the result of blending the colors of all of the overlapping objects. Flatten Transparency merges a stack of transparent objects or graphics into a single image on the PDF page.
Flattening images in a PDF file is generally necessary before you can send the document to a printer. The flattening process simplifies the PDF file and may make it smaller as well.

Constructor Summary

Constructors
Constructor and Description
`FlattenTransparencyParams()` Set up default parameters for flattening transparency.
`FlattenTransparencyParams(boolean UseTextOutlines, boolean ConvertStrokesToOutlines, boolean ClipComplexRegions, int InternalDPI, int ExternalDPI, boolean PreserveOverprint, int Quality)` Set up parameters for flattening transparency.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete()`
`boolean`	`getClipComplexRegions()` If true, ensure that boundaries between vector and rasterized artwork fall along object paths.
`FlattenerColorCompression`	`getColorCompressionScheme()` The compression scheme used for flattened color images.
`FlattenerQualitySetting`	`getColorImageQuality()` Quality Setting for Flattened JPEG and JPEG2000 colored Images.
`boolean`	`getConvertStrokesToOutlines()` If true, convert strokes to outlines.
`int`	`getExternalDPI()` Resolution for flattening edges of atomic regions.
`FlattenerGrayCompression`	`getGrayCompressionScheme()` The compression scheme used for flattened gray images.
`FlattenerQualitySetting`	`getGrayImageQuality()` Quality Setting for Flattened JPEG and JPEG2000 gray Images.
`int`	`getInternalDPI()` Resolution for flattening the interior of an atomic region.
`int`	`getMaxPageFlatteningTime()` The maximum allowed time that will be spent flattening a single page.
`FlattenerMonoCompression`	`getMonoCompressionScheme()` The compression scheme used for flattened monochrome images.
`boolean`	`getPreserveOverprint()` If true, attempt to preserve overprint.
`java.lang.String`	`getProfileDescription()` The Page Level Transparency Blending ColorSpace Profile Description.
`int`	`getQuality()` The percentage of vector information that is to be preserved.
`boolean`	`getUseTextOutlines()` If true, output text outlines instead of native text.
`void`	`setClipComplexRegions(boolean theSetting)` If true, ensure that boundaries between vector and rasterized artwork fall along object paths.
`void`	`setColorCompressionScheme(FlattenerColorCompression theScheme)` The compression scheme used for flattened color images.
`void`	`setColorImageQuality(FlattenerQualitySetting theQuality)` Quality Setting for Flattened JPEG and JPEG2000 colored Images.
`void`	`setConvertStrokesToOutlines(boolean theSetting)` If true, convert strokes to outlines.
`void`	`setExternalDPI(int theExternalDPI)` Resolution for flattening edges of atomic regions.
`void`	`setGrayCompressionScheme(FlattenerGrayCompression theScheme)` The compression scheme used for flattened gray images.
`void`	`setGrayImageQuality(FlattenerQualitySetting theQuality)` Quality Setting for Flattened JPEG and JPEG2000 gray Images.
`void`	`setInternalDPI(int theInternalDPI)` Resolution for flattening the interior of an atomic region.
`void`	`setMaxPageFlatteningTime(int theTime)` The maximum allowed time that will be spent flattening a single page.
`void`	`setMonoCompressionScheme(FlattenerMonoCompression theScheme)` The compression scheme used for flattened monochrome images.
`void`	`setPreserveOverprint(boolean theSetting)` If true, attempt to preserve overprint.
`void`	`setProfileDescription(java.lang.String descript)` The Page Level Transparency Blending ColorSpace Profile Description.
`void`	`setQuality(int theQuality)` The percentage of vector information that is to be preserved.
`void`	`setUseTextOutlines(boolean theSetting)` If true, output text outlines instead of native text.

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

- Constructor Detail
  - FlattenTransparencyParams
```
public FlattenTransparencyParams()
```
    Set up default parameters for flattening transparency.
    - UseTextOutlines - Output text outlines instead of native text. Default is true.
    - ConvertStrokesToOutlines - Convert strokes to outlines. Default is true.
    - ClipComplexRegions - Ensure that boundaries between vector and rasterized artwork fall along object paths. Default is true.
    - InternalDPI - Resolution for flattening the interior of an atomic region. Default is 150.
    - ExternalDPI - Resolution for flattening edges of atomic regions. Default is 300.
    - PreserveOverprint - Attempt to preserve overprint. Default is true.
    - Quality - The percentage of vector information that is to be preserved. Default is 100.
  - FlattenTransparencyParams
```
public FlattenTransparencyParams(boolean UseTextOutlines,
                                 boolean ConvertStrokesToOutlines,
                                 boolean ClipComplexRegions,
                                 int InternalDPI,
                                 int ExternalDPI,
                                 boolean PreserveOverprint,
                                 int Quality)
```
    Set up parameters for flattening transparency.
    
    Parameters:
    
    UseTextOutlines - If true, output text outlines instead of native text.
    
    ConvertStrokesToOutlines - If true, convert strokes to outlines.
    
    ClipComplexRegions - If true, ensure that boundaries between vector and rasterized artwork fall along object paths.
    
    InternalDPI - Resolution for flattening the interior of an atomic region. Range is 1 to 9600.
    
    ExternalDPI - Resolution for flattening edges of atomic regions. Range is 1 to 1200.
    
    PreserveOverprint - If true, attempt to preserve overprint.
    
    Quality - The percentage of vector information that is to be preserved. Lower values will cause higher rasterization of vectors. Range is 0 to 100.
- Method Detail
  - delete
```
public void delete()
```
  - getUseTextOutlines
```
public boolean getUseTextOutlines()
```
    If true, output text outlines instead of native text.
  - setUseTextOutlines
```
public void setUseTextOutlines(boolean theSetting)
```
    If true, output text outlines instead of native text.
  - getConvertStrokesToOutlines
```
public boolean getConvertStrokesToOutlines()
```
    If true, convert strokes to outlines.
  - setConvertStrokesToOutlines
```
public void setConvertStrokesToOutlines(boolean theSetting)
```
    If true, convert strokes to outlines.
  - getClipComplexRegions
```
public boolean getClipComplexRegions()
```
    If true, ensure that boundaries between vector and rasterized artwork fall along object paths.
  - setClipComplexRegions
```
public void setClipComplexRegions(boolean theSetting)
```
    If true, ensure that boundaries between vector and rasterized artwork fall along object paths.
  - getInternalDPI
```
public int getInternalDPI()
```
    Resolution for flattening the interior of an atomic region. Range is 1 to 9600.
  - setInternalDPI
```
public void setInternalDPI(int theInternalDPI)
```
    Resolution for flattening the interior of an atomic region. Range is 1 to 9600.
  - getExternalDPI
```
public int getExternalDPI()
```
    Resolution for flattening edges of atomic regions. Range is 1 to 1200.
  - setExternalDPI
```
public void setExternalDPI(int theExternalDPI)
```
    Resolution for flattening edges of atomic regions. Range is 1 to 1200.
  - getPreserveOverprint
```
public boolean getPreserveOverprint()
```
    If true, attempt to preserve overprint.
  - setPreserveOverprint
```
public void setPreserveOverprint(boolean theSetting)
```
    If true, attempt to preserve overprint.
  - getQuality
```
public int getQuality()
```
    The percentage of vector information that is to be preserved. Lower values will cause higher rasterization of vectors. Range is 0 to 100.
  - setQuality
```
public void setQuality(int theQuality)
```
    The percentage of vector information that is to be preserved. Lower values will cause higher rasterization of vectors. Range is 0 to 100.
  - getColorCompressionScheme
```
public FlattenerColorCompression getColorCompressionScheme()
```
    The compression scheme used for flattened color images. Default to JPEGCompression.
  - setColorCompressionScheme
```
public void setColorCompressionScheme(FlattenerColorCompression theScheme)
```
    The compression scheme used for flattened color images. Default to JPEGCompression.
  - getGrayCompressionScheme
```
public FlattenerGrayCompression getGrayCompressionScheme()
```
    The compression scheme used for flattened gray images. Default to GrayJPEGCompression.
  - setGrayCompressionScheme
```
public void setGrayCompressionScheme(FlattenerGrayCompression theScheme)
```
    The compression scheme used for flattened gray images. Default to GrayJPEGCompression.
  - getMonoCompressionScheme
```
public FlattenerMonoCompression getMonoCompressionScheme()
```
    The compression scheme used for flattened monochrome images. Default to MonoCCITTGroup4Compression.
  - setMonoCompressionScheme
```
public void setMonoCompressionScheme(FlattenerMonoCompression theScheme)
```
    The compression scheme used for flattened monochrome images. Default to MonoCCITTGroup4Compression.
  - setColorImageQuality
```
public void setColorImageQuality(FlattenerQualitySetting theQuality)
```
    Quality Setting for Flattened JPEG and JPEG2000 colored Images. This is valid only if the value of ColorCompressionScheme is equal to JPEGCompression or JPEG2000Compression Default value: High
  - getColorImageQuality
```
public FlattenerQualitySetting getColorImageQuality()
```
    Quality Setting for Flattened JPEG and JPEG2000 colored Images. This is valid only if the value of ColorCompressionScheme is equal to JPEGCompression or JPEG2000Compression Default value: High
  - setGrayImageQuality
```
public void setGrayImageQuality(FlattenerQualitySetting theQuality)
```
    Quality Setting for Flattened JPEG and JPEG2000 gray Images. This is valid only if the value of GrayCompressionScheme is equal to GrayJPEGCompression or GrayJPEG2000Compression Default value: High
  - getGrayImageQuality
```
public FlattenerQualitySetting getGrayImageQuality()
```
    Quality Setting for Flattened JPEG and JPEG2000 gray Images. This is valid only if the value of GrayCompressionScheme is equal to GrayJPEGCompression or GrayJPEG2000Compression Default value: High
  - getProfileDescription
```
public java.lang.String getProfileDescription()
```
    The Page Level Transparency Blending ColorSpace Profile Description.
  - setProfileDescription
```
public void setProfileDescription(java.lang.String descript)
```
    The Page Level Transparency Blending ColorSpace Profile Description.
  - getMaxPageFlatteningTime
```
public int getMaxPageFlatteningTime()
```
    The maximum allowed time that will be spent flattening a single page. A value less than zero will disable the time limit. A value equal to 0 (default) will set the limit to 120 seconds. A value greater than 0 will set the allowed limit (in seconds). Any value less than 60 seconds will be increased to 60 seconds.
  - setMaxPageFlatteningTime
```
public void setMaxPageFlatteningTime(int theTime)
```
    The maximum allowed time that will be spent flattening a single page. A value less than zero will disable the time limit. A value equal to 0 (default) will set the limit to 120 seconds. A value greater than 0 will set the allowed limit (in seconds).

Class FlattenTransparencyParams

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FlattenTransparencyParams

FlattenTransparencyParams

Method Detail

delete

getUseTextOutlines

setUseTextOutlines

getConvertStrokesToOutlines

setConvertStrokesToOutlines

getClipComplexRegions

setClipComplexRegions

getInternalDPI

setInternalDPI

getExternalDPI

setExternalDPI

getPreserveOverprint

setPreserveOverprint

getQuality

setQuality

getColorCompressionScheme

setColorCompressionScheme

getGrayCompressionScheme

setGrayCompressionScheme

getMonoCompressionScheme

setMonoCompressionScheme

setColorImageQuality

getColorImageQuality

setGrayImageQuality

getGrayImageQuality

getProfileDescription

setProfileDescription

getMaxPageFlatteningTime

setMaxPageFlatteningTime