# EmbeddingConfiguration.DimAreaBehavior

# EmbeddingConfiguration.DimAreaBehavior

Artifact:[androidx.window:window](https://developer.android.com/jetpack/androidx/releases/window)  
[View Source](https://cs.android.com/search?q=file:androidx/window/embedding/EmbeddingConfiguration.kt+class:androidx.window.embedding.EmbeddingConfiguration.DimAreaBehavior)  
Added in[1.4.0](https://developer.android.com/jetpack/androidx/releases/window#1.4.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior "View this page in Java")

<br />

```
class EmbeddingConfiguration.DimAreaBehavior
```

<br />

*** ** * ** ***

The area of dimming to apply.  

|                                                         See also                                                          |
|---------------------------------------------------------------------------------------------------------------------------|---|
| [FLAG_DIM_BEHIND](https://developer.android.com/reference/android/view/WindowManager.LayoutParams.html#FLAG_DIM_BEHIND()) |   |

## Summary

|                                                              ### Public companion properties                                                              |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [EmbeddingConfiguration.DimAreaBehavior](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior) | [ON_ACTIVITY_STACK](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior#ON_ACTIVITY_STACK()) The dim effect is applying on the[ActivityStack](https://developer.android.com/reference/kotlin/androidx/window/embedding/ActivityStack)of the Activity window when needed. |
| [EmbeddingConfiguration.DimAreaBehavior](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior) | [ON_TASK](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior#ON_TASK()) The dimming effect is applying on the area of the whole Task when needed.                                                                                                                       |
| [EmbeddingConfiguration.DimAreaBehavior](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior) | [UNDEFINED](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior#UNDEFINED()) The dim area is not defined.                                                                                                                                                                |

|                                   ### Public functions                                   |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| `open `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) | [toString](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior#toString())`()` |

## Public companion properties

### ON_ACTIVITY_STACK

```
val ON_ACTIVITY_STACK: EmbeddingConfiguration.DimAreaBehavior
```

The dim effect is applying on the[ActivityStack](https://developer.android.com/reference/kotlin/androidx/window/embedding/ActivityStack)of the Activity window when needed. If the[ActivityStack](https://developer.android.com/reference/kotlin/androidx/window/embedding/ActivityStack)is split and displayed side-by-side with another[ActivityStack](https://developer.android.com/reference/kotlin/androidx/window/embedding/ActivityStack), the dim effect is applying only on the[ActivityStack](https://developer.android.com/reference/kotlin/androidx/window/embedding/ActivityStack)of the requested Activity.  

### ON_TASK

```
val ON_TASK: EmbeddingConfiguration.DimAreaBehavior
```

The dimming effect is applying on the area of the whole Task when needed. If the embedded transparent activity is split and displayed side-by-side with another activity, the dim effect is applying on the Task, which across over the two[ActivityStack](https://developer.android.com/reference/kotlin/androidx/window/embedding/ActivityStack)s.

This is the default dim area configuration of the Activity Embedding environment, before the[DimAreaBehavior](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior)is explicitly set by[ActivityEmbeddingController.setEmbeddingConfiguration](https://developer.android.com/reference/kotlin/androidx/window/embedding/ActivityEmbeddingController#setEmbeddingConfiguration(androidx.window.embedding.EmbeddingConfiguration)).  

### UNDEFINED

```
val UNDEFINED: EmbeddingConfiguration.DimAreaBehavior
```

The dim area is not defined.

This is the default value while building a[EmbeddingConfiguration](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration). This would also keep the existing dim area configuration of the current Activity Embedding environment unchanged when[ActivityEmbeddingController.setEmbeddingConfiguration](https://developer.android.com/reference/kotlin/androidx/window/embedding/ActivityEmbeddingController#setEmbeddingConfiguration(androidx.window.embedding.EmbeddingConfiguration))is called.  

|                                                                                                   See also                                                                                                    |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setEmbeddingConfiguration](https://developer.android.com/reference/kotlin/androidx/window/embedding/ActivityEmbeddingController#setEmbeddingConfiguration(androidx.window.embedding.EmbeddingConfiguration)) |   |

## Public functions

### toString

```
open fun toString(): String
```