# PickerColumn

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

*** ** * ** ***

<br />

```
public class PickerColumn
```

<br />

*** ** * ** ***

Picker column class used by `https://developer.android.com/reference/androidx/leanback/widget/picker/Picker`, defines a contiguous value ranges and associated labels. A PickerColumn has a minValue and maxValue to choose between. The Picker column has a current value. The labels can be dynamically generated from value by `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#setLabelFormat(java.lang.String)` or a list of static labels set by `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#setStaticLabels(java.lang.CharSequence[])`.

## Summary

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

| ### Public methods |
|---|---|
| `int` | `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#getCount()()` Get total items count between minValue and maxValue. |
| `int` | `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#getCurrentValue()()` Returns current value of the Column. |
| `https://developer.android.com/reference/java/lang/CharSequence.html` | `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#getLabelFor(int)(int value)` Get a label for value. |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#getLabelFormat()()` Return string format (see `https://developer.android.com/reference/java/lang/String.html#format(java.lang.String, java.lang.Object...)`) to display label for value. |
| `int` | `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#getMaxValue()()` Returns maximum value of the Column. |
| `int` | `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#getMinValue()()` Returns minimal value of the Column. |
| `CharSequence[]` | `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#getStaticLabels()()` Returns static labels for each value, minValue maps to labels\[0\], maxValue maps to labels\[labels.length - 1\]. |
| `void` | `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#setCurrentValue(int)(int value)` Sets current value of the Column. |
| `void` | `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#setLabelFormat(java.lang.String)(https://developer.android.com/reference/java/lang/String.html labelFormat)` Set string format (see `https://developer.android.com/reference/java/lang/String.html#format(java.lang.String, java.lang.Object...)`) to display label for an integer value. |
| `void` | `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#setMaxValue(int)(int maxValue)` Sets maximum value of the Column. |
| `void` | `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#setMinValue(int)(int minValue)` Sets minimal value of the Column. |
| `void` | `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#setStaticLabels(java.lang.CharSequence[])(CharSequence[] labels)` Set static labels for each value, minValue maps to labels\[0\], maxValue maps to labels\[labels.length - 1\]. |

## Public constructors

### PickerColumn

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

```
public PickerColumn()
```

## Public methods

### getCount

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

```
public int getCount()
```

Get total items count between minValue and maxValue.

| Returns |
|---|---|
| `int` | Total items count between minValue and maxValue. |

### getCurrentValue

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

```
public int getCurrentValue()
```

Returns current value of the Column.

| Returns |
|---|---|
| `int` | Current value of the Column. |

### getLabelFor

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

```
public CharSequence getLabelFor(int value)
```

Get a label for value. The label can be static `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#setStaticLabels(java.lang.CharSequence[])` or dynamically generated `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#setLabelFormat(java.lang.String)` when static labels is null.

| Parameters |
|---|---|
| `int value` | Value between minValue and maxValue. |

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence.html` | Label for the value. |

### getLabelFormat

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

```
public String getLabelFormat()
```

Return string format (see `https://developer.android.com/reference/java/lang/String.html#format(java.lang.String, java.lang.Object...)`) to display label for value.

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | String format to display label for value. |

### getMaxValue

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

```
public int getMaxValue()
```

Returns maximum value of the Column.

| Returns |
|---|---|
| `int` | Maximum value of the Column. |

### getMinValue

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

```
public int getMinValue()
```

Returns minimal value of the Column.

| Returns |
|---|---|
| `int` | Minimal value of the Column. |

### getStaticLabels

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

```
public CharSequence[] getStaticLabels()
```

Returns static labels for each value, minValue maps to labels\[0\], maxValue maps to labels\[labels.length - 1\]. When null, `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#getLabelFormat()` will be used.

### setCurrentValue

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

```
public void setCurrentValue(int value)
```

Sets current value of the Column.

### setLabelFormat

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

```
public void setLabelFormat(String labelFormat)
```

Set string format (see `https://developer.android.com/reference/java/lang/String.html#format(java.lang.String, java.lang.Object...)`) to display label for an integer value. `https://developer.android.com/reference/androidx/leanback/widget/picker/PickerColumn#setStaticLabels(java.lang.CharSequence[])` overrides the format.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html labelFormat` | String format to display label for value between minValue and maxValue. |

### setMaxValue

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

```
public void setMaxValue(int maxValue)
```

Sets maximum value of the Column.

| Parameters |
|---|---|
| `int maxValue` | New maximum value to set. |

### setMinValue

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

```
public void setMinValue(int minValue)
```

Sets minimal value of the Column.

| Parameters |
|---|---|
| `int minValue` | New minimal value to set. |

### setStaticLabels

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

```
public void setStaticLabels(CharSequence[] labels)
```

Set static labels for each value, minValue maps to labels\[0\], maxValue maps to labels\[labels.length - 1\].

| Parameters |
|---|---|
| `CharSequence[] labels` | Static labels for each value between minValue and maxValue. |