# ShadowOverlayHelper.Builder

Artifact: [androidx.leanback:leanback](https://developer.android.com/jetpack/androidx/releases/leanback) [View Source](https://cs.android.com/search?q=file:androidx/leanback/widget/ShadowOverlayHelper.java+class:androidx.leanback.widget.ShadowOverlayHelper.Builder) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

*** ** * ** ***


```
public final class ShadowOverlayHelper.Builder
```

<br />

*** ** * ** ***

Builder for creating ShadowOverlayHelper.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder#Builder()()` |

| ### Public methods |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper` | `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder#build(android.content.Context)(https://developer.android.com/reference/android/content/Context.html context)` Create ShadowOverlayHelper object |
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder` | `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder#keepForegroundDrawable(boolean)(boolean keepForegroundDrawable)` Set if not using foreground drawable for overlay color. |
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder` | `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder#needsOverlay(boolean)(boolean needsOverlay)` Set if needs overlay color. |
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder` | `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder#needsRoundedCorner(boolean)(boolean needsRoundedCorner)` Set if needs rounded corner. |
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder` | `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder#needsShadow(boolean)(boolean needsShadow)` Set if needs shadow. |
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder` | `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder#options(androidx.leanback.widget.ShadowOverlayHelper.Options)(https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Options options)` Set option values e.g. Shadow Z value, rounded corner radius. |
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder` | `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder#preferZOrder(boolean)(boolean preferZOrder)` Set if prefer z-order shadow. |

## Public constructors

### Builder

Added in 1.1.0

```
public Builder()
```

## Public methods

### build

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public ShadowOverlayHelper build(Context context)
```

Create ShadowOverlayHelper object

| Parameters |
|---|---|
| `https://developer.android.com/reference/android/content/Context.html context` | The context uses to read Resources settings. |

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper` | The ShadowOverlayHelper object. |

### keepForegroundDrawable

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public ShadowOverlayHelper.Builder keepForegroundDrawable(boolean keepForegroundDrawable)
```

Set if not using foreground drawable for overlay color. For example if the view has already assigned a foreground drawable for other purposes. When it's true, helper will use a ShadowOverlayContainer for overlay color.

| Parameters |
|---|---|
| `boolean keepForegroundDrawable` | True to keep the original foreground drawable. |

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder` | The Builder object itself. |

### needsOverlay

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public ShadowOverlayHelper.Builder needsOverlay(boolean needsOverlay)
```

Set if needs overlay color.

| Parameters |
|---|---|
| `boolean needsOverlay` | True if needs overlay. |

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder` | The Builder object itself. |

### needsRoundedCorner

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public ShadowOverlayHelper.Builder needsRoundedCorner(boolean needsRoundedCorner)
```

Set if needs rounded corner.

| Parameters |
|---|---|
| `boolean needsRoundedCorner` | True if needs rounded corner. |

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder` | The Builder object itself. |

### needsShadow

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public ShadowOverlayHelper.Builder needsShadow(boolean needsShadow)
```

Set if needs shadow.

| Parameters |
|---|---|
| `boolean needsShadow` | True if needs shadow. |

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder` | The Builder object itself. |

### options

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public ShadowOverlayHelper.Builder options(ShadowOverlayHelper.Options options)
```

Set option values e.g. Shadow Z value, rounded corner radius.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Options options` | The Options object to create ShadowOverlayHelper. |

### preferZOrder

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public ShadowOverlayHelper.Builder preferZOrder(boolean preferZOrder)
```

Set if prefer z-order shadow. On old devices, z-order shadow might be slow, set to false to fall back to static 9-patch shadow. Recommend to read from system wide Setting value: see `https://developer.android.com/reference/androidx/leanback/system/Settings`.

| Parameters |
|---|---|
| `boolean preferZOrder` | True if prefer Z shadow. Default is true. |

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder` | The Builder object itself. |