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

*** ** * ** ***


```
@CarProtocol
public final 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 |
|---|
| `public final class https://developer.android.com/reference/androidx/car/app/model/Toggle.Builder` A builder of `https://developer.android.com/reference/androidx/car/app/model/Toggle`. |
| `public interface https://developer.android.com/reference/androidx/car/app/model/Toggle.OnCheckedChangeListener` A listener for handling checked state change events. |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/car/app/model/Toggle#equals(java.lang.Object)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html other)` |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/car/app/model/OnCheckedChangeDelegate` | `https://developer.android.com/reference/androidx/car/app/model/Toggle#getOnCheckedChangeDelegate()()` Returns the `https://developer.android.com/reference/androidx/car/app/model/OnCheckedChangeDelegate` that is called when the checked state of the `https://developer.android.com/reference/androidx/car/app/model/Toggle` is changed. |
| `int` | `https://developer.android.com/reference/androidx/car/app/model/Toggle#hashCode()()` |
| `boolean` | `https://developer.android.com/reference/androidx/car/app/model/Toggle#isChecked()()` Returns `true` if the toggle is checked. |
| `boolean` | `@https://developer.android.com/reference/androidx/car/app/annotations/RequiresCarApi(value = 5) https://developer.android.com/reference/androidx/car/app/model/Toggle#isEnabled()()` Returns `true` if the toggle is enabled. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/car/app/model/Toggle#toString()()` |

## Public methods

### equals

```
public boolean equals(@Nullable Object other)
```

### getOnCheckedChangeDelegate

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

```
public @NonNull OnCheckedChangeDelegate getOnCheckedChangeDelegate()
```

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

### hashCode

```
public int hashCode()
```

### isChecked

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

```
public boolean isChecked()
```

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)
public boolean isEnabled()
```

Returns `true` if the toggle is enabled.

### toString

```
public @NonNull String toString()
```