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

*** ** * ** ***


```
public final class EmbeddingConfiguration.DimAreaBehavior
```

<br />

*** ** * ** ***

The area of dimming to apply.

| See also |
|---|---|
| `https://developer.android.com/reference/android/view/WindowManager.LayoutParams.html#FLAG_DIM_BEHIND` |   |

## Summary

| ### Public fields |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior` | `https://developer.android.com/reference/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior#ON_ACTIVITY_STACK()` The dim effect is applying on the `https://developer.android.com/reference/androidx/window/embedding/ActivityStack` of the Activity window when needed. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior` | `https://developer.android.com/reference/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior#ON_TASK()` The dimming effect is applying on the area of the whole Task when needed. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior` | `https://developer.android.com/reference/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior#UNDEFINED()` The dim area is not defined. |

| ### Public methods |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior#toString()()` |

## Public fields

### ON_ACTIVITY_STACK

```
public static final @NonNull EmbeddingConfiguration.DimAreaBehavior ON_ACTIVITY_STACK
```

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

### ON_TASK

```
public static final @NonNull EmbeddingConfiguration.DimAreaBehavior ON_TASK
```

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 `https://developer.android.com/reference/androidx/window/embedding/ActivityStack`s.

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

### UNDEFINED

```
public static final @NonNull EmbeddingConfiguration.DimAreaBehavior UNDEFINED
```

The dim area is not defined.

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

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

## Public methods

### toString

```
public @NonNull String toString()
```