belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
PickerColumn
public
class
PickerColumn
extends Object
java.lang.Object | |
↳ | android.support.v17.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 |
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 |
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 | |
---|---|
From
class
java.lang.Object
|
Public constructors
Public methods
getCount
int getCount ()
Get total items count between minValue and maxValue.
Returns | |
---|---|
int |
Total items count between minValue and maxValue. |
getCurrentValue
int getCurrentValue ()
Returns current value of the Column.
Returns | |
---|---|
int |
Current value of the Column. |
getLabelFor
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
String getLabelFormat ()
Return string format (see format(String, Object...)
) to display label for
value.
Returns | |
---|---|
String |
String format to display label for value. |
getMaxValue
int getMaxValue ()
Returns maximum value of the Column.
Returns | |
---|---|
int |
Maximum value of the Column. |
getMinValue
int getMinValue ()
Returns minimal value of the Column.
Returns | |
---|---|
int |
Minimal value of the Column. |
getStaticLabels
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
void setCurrentValue (int value)
Sets current value of the Column.
Parameters | |
---|---|
value |
int |
setLabelFormat
void setLabelFormat (String labelFormat)
Set string format (see 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
void setMaxValue (int maxValue)
Sets maximum value of the Column.
Parameters | |
---|---|
maxValue |
int : New maximum value to set.
|
setMinValue
void setMinValue (int minValue)
Sets minimal value of the Column.
Parameters | |
---|---|
minValue |
int : New minimal value to set.
|
setStaticLabels
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.
|
Interfaces
Classes