EmbeddingConfiguration.DimAreaBehavior

Kotlin |Java

public final class EmbeddingConfiguration.DimAreaBehavior

The area of dimming to apply.

See also
`FLAG_DIM_BEHIND`

Summary

Public fields
`static final @NonNull EmbeddingConfiguration.DimAreaBehavior`	`ON_ACTIVITY_STACK` The dim effect is applying on the `ActivityStack` of the Activity window when needed.
`static final @NonNull EmbeddingConfiguration.DimAreaBehavior`	`ON_TASK` The dimming effect is applying on the area of the whole Task when needed.
`static final @NonNull EmbeddingConfiguration.DimAreaBehavior`	`UNDEFINED` The dim area is not defined.

Public methods
`@NonNull String`	`toString()`

Public fields

ON_ACTIVITY_STACK

public static final @NonNull EmbeddingConfiguration.DimAreaBehavior ON_ACTIVITY_STACK

The dim effect is applying on the ActivityStack of the Activity window when needed. If the ActivityStack is split and displayed side-by-side with another ActivityStack, the dim effect is applying only on the 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 ActivityStacks.

This is the default dim area configuration of the Activity Embedding environment, before the DimAreaBehavior is explicitly set by ActivityEmbeddingController.setEmbeddingConfiguration.

UNDEFINED

public static final @NonNull EmbeddingConfiguration.DimAreaBehavior UNDEFINED

The dim area is not defined.

This is the default value while building a EmbeddingConfiguration. This would also keep the existing dim area configuration of the current Activity Embedding environment unchanged when ActivityEmbeddingController.setEmbeddingConfiguration is called.

See also
`setEmbeddingConfiguration`

Public methods

toString

public @NonNull String toString()