# FlattenTransparencyParams Class

> Represents control parameters for flattening transparencies within a PDF file.

- Product: Adobe PDF Library 18
- Language: Java
- Version: APDFL18.0.5PlusP2e
- HTML page: https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/FlattenTransparencyParams
- Version index: https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/llms.txt

```java
class FlattenTransparencyParams
```

**Namespace:** `com::datalogics::PDFL`

## Description

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.

**Referenced by:** [`Document`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/Document.md)

## Constructors

### FlattenTransparencyParams

```java
com.datalogics.PDFL.FlattenTransparencyParams.FlattenTransparencyParams()
```

*constructor*

Set up default parameters for flattening transparency.

Defaults: UseTextOutlines = false, ConvertStrokesToOutlines = true, ClipComplexRegions = false, InternalDPI = 800, ExternalDPI = 200, PreserveOverprint = true, Quality = 100.

### FlattenTransparencyParams

```java
com.datalogics.PDFL.FlattenTransparencyParams.FlattenTransparencyParams(boolean UseTextOutlines, boolean ConvertStrokesToOutlines, boolean ClipComplexRegions, int InternalDPI, int ExternalDPI, boolean PreserveOverprint, int Quality)
```

*constructor*

**Parameters**

- `UseTextOutlines` (`boolean`): If true, output text outlines instead of native text.
- `ConvertStrokesToOutlines` (`boolean`): If true, convert strokes to outlines.
- `ClipComplexRegions` (`boolean`): If true, ensure that boundaries between vector and rasterized artwork fall along object paths.
- `InternalDPI` (`int`): Resolution for flattening the interior of an atomic region. Range is 1 to 9600.
- `ExternalDPI` (`int`): Resolution for flattening edges of atomic regions. Range is 1 to 1200.
- `PreserveOverprint` (`boolean`): If true, attempt to preserve overprint.
- `Quality` (`int`): The percentage of vector information that is to be preserved. Lower values will cause higher rasterization of vectors. Range is 0 to 100.

Set up parameters for flattening transparency.

## Methods

### delete

```java
synchronized void com.datalogics.PDFL.FlattenTransparencyParams.delete(Boolean disposing)
```

*protected*

**Parameters**

- `disposing` (`Boolean`)

**Returns:** `synchronized void`

### delete

```java
synchronized void com.datalogics.PDFL.FlattenTransparencyParams.delete()
```

**Returns:** `synchronized void`

### finalize

```java
void com.datalogics.PDFL.FlattenTransparencyParams.finalize()
```

*protected*

**Returns:** `void`

### getClipComplexRegions

```java
boolean com.datalogics.PDFL.FlattenTransparencyParams.getClipComplexRegions()
```

**Returns:** `boolean`

If true, ensure that boundaries between vector and rasterized artwork fall along object paths.

### getColorCompressionScheme

```java
FlattenerColorCompression com.datalogics.PDFL.FlattenTransparencyParams.getColorCompressionScheme()
```

**Returns:** `FlattenerColorCompression`

The compression scheme used for flattened color images. Default to JPEGCompression.

### getColorImageQuality

```java
FlattenerQualitySetting com.datalogics.PDFL.FlattenTransparencyParams.getColorImageQuality()
```

**Returns:** `FlattenerQualitySetting`

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

### getConvertStrokesToOutlines

```java
boolean com.datalogics.PDFL.FlattenTransparencyParams.getConvertStrokesToOutlines()
```

**Returns:** `boolean`

If true, convert strokes to outlines.

### getExternalDPI

```java
int com.datalogics.PDFL.FlattenTransparencyParams.getExternalDPI()
```

**Returns:** `int`

Resolution for flattening edges of atomic regions. Range is 1 to 1200.

### getGrayCompressionScheme

```java
FlattenerGrayCompression com.datalogics.PDFL.FlattenTransparencyParams.getGrayCompressionScheme()
```

**Returns:** `FlattenerGrayCompression`

The compression scheme used for flattened gray images. Default to GrayJPEGCompression.

### getGrayImageQuality

```java
FlattenerQualitySetting com.datalogics.PDFL.FlattenTransparencyParams.getGrayImageQuality()
```

**Returns:** `FlattenerQualitySetting`

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

### getInternalDPI

```java
int com.datalogics.PDFL.FlattenTransparencyParams.getInternalDPI()
```

**Returns:** `int`

Resolution for flattening the interior of an atomic region. Range is 1 to 9600.

### getMaxPageFlatteningTime

```java
int com.datalogics.PDFL.FlattenTransparencyParams.getMaxPageFlatteningTime()
```

**Returns:** `int`

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.

### getMonoCompressionScheme

```java
FlattenerMonoCompression com.datalogics.PDFL.FlattenTransparencyParams.getMonoCompressionScheme()
```

**Returns:** `FlattenerMonoCompression`

The compression scheme used for flattened monochrome images. Default to MonoCCITTGroup4Compression.

### getPreserveOverprint

```java
boolean com.datalogics.PDFL.FlattenTransparencyParams.getPreserveOverprint()
```

**Returns:** `boolean`

If true, attempt to preserve overprint.

### getProfileDescription

```java
String com.datalogics.PDFL.FlattenTransparencyParams.getProfileDescription()
```

**Returns:** `String`

The Page Level Transparency Blending ColorSpace Profile Description.

### getQuality

```java
int com.datalogics.PDFL.FlattenTransparencyParams.getQuality()
```

**Returns:** `int`

The percentage of vector information that is to be preserved. Lower values will cause higher rasterization of vectors. Range is 0 to 100.

### getUseTextOutlines

```java
boolean com.datalogics.PDFL.FlattenTransparencyParams.getUseTextOutlines()
```

**Returns:** `boolean`

If true, output text outlines instead of native text.

### setClipComplexRegions

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setClipComplexRegions(boolean theSetting)
```

**Parameters**

- `theSetting` (`boolean`)

**Returns:** `void`

If true, ensure that boundaries between vector and rasterized artwork fall along object paths.

### setColorCompressionScheme

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setColorCompressionScheme(FlattenerColorCompression theScheme)
```

**Parameters**

- `theScheme` (`FlattenerColorCompression`)

**Returns:** `void`

The compression scheme used for flattened color images. Default to JPEGCompression.

### setColorImageQuality

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setColorImageQuality(FlattenerQualitySetting theQuality)
```

**Parameters**

- `theQuality` (`FlattenerQualitySetting`)

**Returns:** `void`

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

### setConvertStrokesToOutlines

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setConvertStrokesToOutlines(boolean theSetting)
```

**Parameters**

- `theSetting` (`boolean`)

**Returns:** `void`

If true, convert strokes to outlines.

### setExternalDPI

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setExternalDPI(int theExternalDPI)
```

**Parameters**

- `theExternalDPI` (`int`)

**Returns:** `void`

Resolution for flattening edges of atomic regions. Range is 1 to 1200.

### setGrayCompressionScheme

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setGrayCompressionScheme(FlattenerGrayCompression theScheme)
```

**Parameters**

- `theScheme` (`FlattenerGrayCompression`)

**Returns:** `void`

The compression scheme used for flattened gray images. Default to GrayJPEGCompression.

### setGrayImageQuality

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setGrayImageQuality(FlattenerQualitySetting theQuality)
```

**Parameters**

- `theQuality` (`FlattenerQualitySetting`)

**Returns:** `void`

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

### setInternalDPI

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setInternalDPI(int theInternalDPI)
```

**Parameters**

- `theInternalDPI` (`int`)

**Returns:** `void`

Resolution for flattening the interior of an atomic region. Range is 1 to 9600.

### setMaxPageFlatteningTime

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setMaxPageFlatteningTime(int theTime)
```

**Parameters**

- `theTime` (`int`)

**Returns:** `void`

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

### setMonoCompressionScheme

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setMonoCompressionScheme(FlattenerMonoCompression theScheme)
```

**Parameters**

- `theScheme` (`FlattenerMonoCompression`)

**Returns:** `void`

The compression scheme used for flattened monochrome images. Default to MonoCCITTGroup4Compression.

### setPreserveOverprint

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setPreserveOverprint(boolean theSetting)
```

**Parameters**

- `theSetting` (`boolean`)

**Returns:** `void`

If true, attempt to preserve overprint.

### setProfileDescription

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setProfileDescription(String descript)
```

**Parameters**

- `descript` (`String`)

**Returns:** `void`

The Page Level Transparency Blending ColorSpace Profile Description.

### setQuality

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setQuality(int theQuality)
```

**Parameters**

- `theQuality` (`int`)

**Returns:** `void`

The percentage of vector information that is to be preserved. Lower values will cause higher rasterization of vectors. Range is 0 to 100.

### setUseTextOutlines

```java
void com.datalogics.PDFL.FlattenTransparencyParams.setUseTextOutlines(boolean theSetting)
```

**Parameters**

- `theSetting` (`boolean`)

**Returns:** `void`

If true, output text outlines instead of native text.
