Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.
Android 0.0.0 Developer Preview
belongs to Maven artifact androidx.leanback:leanback:1.1.0-alpha01

PickerColumn

public class PickerColumn
extends Object

java.lang.Object
   ↳ androidx.leanback.widget.picker.PickerColumn


Picker column class used by 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 setLabelFormat(String) or a list of static labels set by setStaticLabels(CharSequence[]).

Summary

Public constructors

PickerColumn()

Public methods

int getCount()

Get total items count between minValue and maxValue.

int getCurrentValue()

Returns current value of the Column.

CharSequence getLabelFor(int value)

Get a label for value.

String getLabelFormat()

Return string format (see String.format(String, Object...)) to display label for value.

int getMaxValue()

Returns maximum value of the Column.

int getMinValue()

Returns minimal value of the Column.

CharSequence[] getStaticLabels()

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

void setCurrentValue(int value)

Sets current value of the Column.

void setLabelFormat(String labelFormat)

Set string format (see String.format(String, Object...)) to display label for an integer value.

void setMaxValue(int maxValue)

Sets maximum value of the Column.

void setMinValue(int minValue)

Sets minimal value of the Column.

void setStaticLabels(CharSequence[] labels)

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

Inherited methods

Public constructors

PickerColumn

public PickerColumn ()

Public methods

getCount

public int getCount ()

Get total items count between minValue and maxValue.

Returns
int Total items count between minValue and maxValue.

getCurrentValue

public int getCurrentValue ()

Returns current value of the Column.

Returns
int Current value of the Column.

getLabelFor

public CharSequence getLabelFor (int value)

Get a label for value. The label can be static setStaticLabels(CharSequence[]) or dynamically generated setLabelFormat(String) when static labels is null.

Parameters
value int: Value between minValue and maxValue.

Returns
CharSequence Label for the value.

getLabelFormat

public String getLabelFormat ()

Return string format (see String.format(String, Object...)) to display label for value.

Returns
String String format to display label for value.

getMaxValue

public int getMaxValue ()

Returns maximum value of the Column.

Returns
int Maximum value of the Column.

getMinValue

public int getMinValue ()

Returns minimal value of the Column.

Returns
int Minimal value of the Column.

getStaticLabels

public CharSequence[] getStaticLabels ()

Returns static labels for each value, minValue maps to labels[0], maxValue maps to labels[labels.length - 1]. When null, getLabelFormat() will be used.

Returns
CharSequence[]

setCurrentValue

public void setCurrentValue (int value)

Sets current value of the Column.

Parameters
value int

setLabelFormat

public void setLabelFormat (String labelFormat)

Set string format (see String.format(String, Object...)) to display label for an integer value. setStaticLabels(CharSequence[]) overrides the format.

Parameters
labelFormat String: String format to display label for value between minValue and maxValue.

setMaxValue

public void setMaxValue (int maxValue)

Sets maximum value of the Column.

Parameters
maxValue int: New maximum value to set.

setMinValue

public void setMinValue (int minValue)

Sets minimal value of the Column.

Parameters
minValue int: New minimal value to set.

setStaticLabels

public void setStaticLabels (CharSequence[] labels)

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

Parameters
labels CharSequence: Static labels for each value between minValue and maxValue.