StringListParameter

All Superinterfaces:: ConfigParameter, Parameter, ParameterWithSuffix

All Known Implementing Classes:: StringListParameterImpl

public interface StringListParameter extends Parameter, ParameterWithSuffix

An String config parameter that's limited to a list of values. Values are usually shown to user in friendly text representations.

Since:

BiglyBT 1.0.0.0

See Also:

Field Summary

Fields

Modifier and Type

Field

Description

static final int

TYPE_DROPDOWN

Dropdown style.

static final int

TYPE_LISTBOX

Listbox style.

Fields inherited from interface com.biglybt.pif.ui.config.Parameter
MODE_ADVANCED, MODE_BEGINNER, MODE_INTERMEDIATE
Method Summary

Modifier and Type

Method

Description

String[]

getLabels()

List of labels displayed to user

int

getListType()

String

getValue()

String[]

getValues()

List of values that can be stored to config

void

setLabels(String[] labels)

Set list of labels displayed to user

void

setListType(int listType)

void

setValue(String value)

Methods inherited from interface com.biglybt.pif.config.ConfigParameter
addConfigParameterListener, removeConfigParameterListener

Methods inherited from interface com.biglybt.pif.ui.config.Parameter
addAndFireListener, addListener, addValidator, getConfigKeyName, getGenerateIntermediateEvents, getLabelKey, getLabelText, getMinimumRequiredUserMode, getValueObject, hasBeenSet, isEnabled, isForUIType, isVisible, removeListener, resetToDefault, setAllowedUiTypes, setEnabled, setGenerateIntermediateEvents, setIndent, setLabelKey, setLabelText, setMinimumRequiredUserMode, setVisible

Methods inherited from interface com.biglybt.pif.ui.config.ParameterWithSuffix
getSuffixLabelKey, setSuffixLabelKey, setSuffixLabelText

Field Details
- TYPE_DROPDOWN
  
  static final int TYPE_DROPDOWN
  
  Dropdown style. Default.
  Since:
  
  BiglyBT 1.0.0.0
  
  See Also:
  
  Constant Field Values
- TYPE_LISTBOX
  
  static final int TYPE_LISTBOX
  
  Listbox style. Typically will display each option on a new row
  Since:
  
  BiglyBT 1.9.0.1
  
  See Also:
  
  Constant Field Values
Method Details
- setValue
  
  void setValue(String value)
- getValue
  
  String getValue()
- getLabels
  
  String[] getLabels()
  
  List of labels displayed to user
  
  Since:
  
  BiglyBT 1.9.0.1
- setLabels
  
  void setLabels(String[] labels)
  
  Set list of labels displayed to user
  
  Since:
  
  BiglyBT 1.0.0.0
- getValues
  
  String[] getValues()
  
  List of values that can be stored to config
  
  Since:
  
  BiglyBT 1.9.0.1
- setListType
  
  void setListType(int listType)
- getListType
  
  int getListType()