# Toggle

# Toggle

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)  
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 "View this page in Java")

<br />

```
@CarProtocol
class Toggle
```

<br />

*** ** * ** ***

Represents a toggle that can have either a checked or unchecked state.

Toggles are allowed in Map and Pane templates from API \>= 6. Old hosts may render bad UI if the toggles are added to hosts that don't support them.

## Summary

|                                                                                                  ### Nested types                                                                                                  |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[Toggle.Builder](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle.Builder) A builder of[Toggle](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle). |
| `interface `[Toggle.OnCheckedChangeListener](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle.OnCheckedChangeListener) A listener for handling checked state change events.            |

|                                                   ### Public functions                                                   |
|--------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                      | [equals](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle#equals(java.lang.Object))`(other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)`                                                                                                                                                                                                                     |
| [OnCheckedChangeDelegate](https://developer.android.com/reference/kotlin/androidx/car/app/model/OnCheckedChangeDelegate) | [getOnCheckedChangeDelegate](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle#getOnCheckedChangeDelegate())`()` Returns the[OnCheckedChangeDelegate](https://developer.android.com/reference/kotlin/androidx/car/app/model/OnCheckedChangeDelegate)that is called when the checked state of the[Toggle](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle)is changed. |
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                                              | [hashCode](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle#hashCode())`()`                                                                                                                                                                                                                                                                                                                      |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                      | [isChecked](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle#isChecked())`()` Returns`true`if the toggle is checked.                                                                                                                                                                                                                                                                             |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                      | `@`[RequiresCarApi](https://developer.android.com/reference/kotlin/androidx/car/app/annotations/RequiresCarApi)`(value = 5)` [isEnabled](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle#isEnabled())`()` Returns`true`if the toggle is enabled.                                                                                                                                                |
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)                                        | [toString](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle#toString())`()`                                                                                                                                                                                                                                                                                                                      |

## Public functions

### equals

```
fun equals(other: Any?): Boolean
```  

### getOnCheckedChangeDelegate

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

```
fun getOnCheckedChangeDelegate(): OnCheckedChangeDelegate
```

Returns the[OnCheckedChangeDelegate](https://developer.android.com/reference/kotlin/androidx/car/app/model/OnCheckedChangeDelegate)that is called when the checked state of the[Toggle](https://developer.android.com/reference/kotlin/androidx/car/app/model/Toggle)is changed.  

### hashCode

```
fun hashCode(): Int
```  

### isChecked

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

```
fun isChecked(): Boolean
```

Returns`true`if the toggle is checked.  

### isEnabled

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

```
@RequiresCarApi(value = 5)
fun isEnabled(): Boolean
```

Returns`true`if the toggle is enabled.  

### toString

```
fun toString(): String
```