# Toggle.Builder

# Toggle.Builder

Artifact:[androidx.car.app:app](https://developer.android.com/jetpack/androidx/releases/car-app)  
[View Source](https://cs.android.com/search?q=file:androidx/car/app/model/Toggle.java+class:androidx.car.app.model.Toggle.Builder)  
Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/car/app/model/Toggle.Builder "View this page in Java")

<br />

```
class Toggle.Builder
```

<br />

*** ** * ** ***

A builder of[Toggle](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle).

## Summary

|                                                                                                                                                                                                                                                                                           ### Public constructors                                                                                                                                                                                                                                                                                            |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Builder](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle.Builder#Builder(androidx.car.app.model.Toggle.OnCheckedChangeListener))`(onCheckedChangeListener: `[Toggle.OnCheckedChangeListener](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle.OnCheckedChangeListener)`)` Returns a new instance of a[Builder](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle.Builder)with the given[OnCheckedChangeListener](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle.OnCheckedChangeListener). |

|                                          ### Public functions                                          |
|--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Toggle](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle)                 | [build](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle.Builder#build())`()` Constructs the[Toggle](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle)defined by this builder.                                                                                                                                                                                                                                          |
| [Toggle.Builder](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle.Builder) | [setChecked](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle.Builder#setChecked(boolean))`(checked: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`)` Sets the initial checked state for[Toggle](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle).                                                                                                                              |
| [Toggle.Builder](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle.Builder) | `@`[RequiresCarApi](https://developer.android.com/reference/kotlin/androidx/car/app/annotations/RequiresCarApi)`(value = 5)` [setEnabled](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle.Builder#setEnabled(boolean))`(enabled: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`)` Sets the initial enabled state for[Toggle](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle). |

## Public constructors

### Builder

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)  

```
Builder(onCheckedChangeListener: Toggle.OnCheckedChangeListener)
```

Returns a new instance of a[Builder](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle.Builder)with the given[OnCheckedChangeListener](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle.OnCheckedChangeListener).

Note that the listener relates to UI events and will be executed on the main thread using[getMainLooper](https://developer.android.com/reference/android/os/Looper.html#getMainLooper()).  

|                                                    Throws                                                     |
|---------------------------------------------------------------------------------------------------------------|-------------------------------------|
| [java.lang.NullPointerException](https://developer.android.com/reference/java/lang/NullPointerException.html) | if`onCheckedChangeListener`is`null` |

## Public functions

### build

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)  

```
fun build(): Toggle
```

Constructs the[Toggle](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle)defined by this builder.  

### setChecked

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)  

```
fun setChecked(checked: Boolean): Toggle.Builder
```

Sets the initial checked state for[Toggle](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle).

The default state of a[Toggle](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle)is unchecked.  

### setEnabled

Added in[1.3.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.3.0)  

```
@RequiresCarApi(value = 5)
fun setEnabled(enabled: Boolean): Toggle.Builder
```

Sets the initial enabled state for[Toggle](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle).

The default state of a[Toggle](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle)is enabled.