# ShadowOverlayHelper.Builder

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

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/leanback/widget/ShadowOverlayHelper.Builder "View this page in Java")

<br />

```
class ShadowOverlayHelper.Builder
```

<br />

*** ** * ** ***

Builder for creating ShadowOverlayHelper.

## Summary

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

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

## Public constructors

### Builder

Added in 1.1.0  

```
Builder()
```  

## Public functions

### build

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

```
fun build(context: Context!): ShadowOverlayHelper!
```

Create ShadowOverlayHelper object  

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

|                                                        Returns                                                        |
|-----------------------------------------------------------------------------------------------------------------------|---------------------------------|
| [ShadowOverlayHelper](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ShadowOverlayHelper)`!` | The ShadowOverlayHelper object. |

### keepForegroundDrawable

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

```
fun keepForegroundDrawable(keepForegroundDrawable: Boolean): ShadowOverlayHelper.Builder!
```

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                                                   |
|---------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| `keepForegroundDrawable: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True to keep the original foreground drawable. |

|                                                                Returns                                                                |
|---------------------------------------------------------------------------------------------------------------------------------------|----------------------------|
| [ShadowOverlayHelper.Builder](https://developer.android.com/reference/kotlin/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)  

```
fun needsOverlay(needsOverlay: Boolean): ShadowOverlayHelper.Builder!
```

Set if needs overlay color.  

|                                             Parameters                                              |
|-----------------------------------------------------------------------------------------------------|------------------------|
| `needsOverlay: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True if needs overlay. |

|                                                                Returns                                                                |
|---------------------------------------------------------------------------------------------------------------------------------------|----------------------------|
| [ShadowOverlayHelper.Builder](https://developer.android.com/reference/kotlin/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)  

```
fun needsRoundedCorner(needsRoundedCorner: Boolean): ShadowOverlayHelper.Builder!
```

Set if needs rounded corner.  

|                                                Parameters                                                 |
|-----------------------------------------------------------------------------------------------------------|-------------------------------|
| `needsRoundedCorner: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True if needs rounded corner. |

|                                                                Returns                                                                |
|---------------------------------------------------------------------------------------------------------------------------------------|----------------------------|
| [ShadowOverlayHelper.Builder](https://developer.android.com/reference/kotlin/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)  

```
fun needsShadow(needsShadow: Boolean): ShadowOverlayHelper.Builder!
```

Set if needs shadow.  

|                                             Parameters                                             |
|----------------------------------------------------------------------------------------------------|-----------------------|
| `needsShadow: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True if needs shadow. |

|                                                                Returns                                                                |
|---------------------------------------------------------------------------------------------------------------------------------------|----------------------------|
| [ShadowOverlayHelper.Builder](https://developer.android.com/reference/kotlin/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)  

```
fun options(options: ShadowOverlayHelper.Options!): ShadowOverlayHelper.Builder!
```

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

|                                                                    Parameters                                                                    |
|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|
| `options: `[ShadowOverlayHelper.Options](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ShadowOverlayHelper.Options)`!` | The Options object to create ShadowOverlayHelper. |

### preferZOrder

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

```
fun preferZOrder(preferZOrder: Boolean): ShadowOverlayHelper.Builder!
```

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[Settings](https://developer.android.com/reference/kotlin/androidx/leanback/system/Settings).  

|                                             Parameters                                              |
|-----------------------------------------------------------------------------------------------------|-------------------------------------------|
| `preferZOrder: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True if prefer Z shadow. Default is true. |

|                                                                Returns                                                                |
|---------------------------------------------------------------------------------------------------------------------------------------|----------------------------|
| [ShadowOverlayHelper.Builder](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ShadowOverlayHelper.Builder)`!` | The Builder object itself. |