Interface StringParameter

All Superinterfaces:

ConfigParameter, Parameter, ParameterWithHint, ParameterWithSuffix

All Known Implementing Classes:

StringParameterImpl

public interface StringParameter
extends Parameter, ParameterWithSuffix, ParameterWithHint

Field Summary

Fields inherited from interface Parameter

MODE_ADVANCED, MODE_BEGINNER, MODE_INTERMEDIATE

Method Summary

Modifier and Type	Method	Description
void	addStringValidator(ParameterValidator<String> stringParamValidator)	Same as Parameter.addValidator(ParameterValidator), but casts the "toValue" to String.
int	getTextLimit()	Get the character limit for Parameter
String	getValue()
int	getWidthInCharacters()
void	setMultiLine(int visible_line_count)
void	setTextLimit(int textLimit)	Limit the number of characters for Parameter
void	setValidChars(String chars, boolean caseSensitive)	Limit characters to a list
void	setValue(String value)
void	setWidthInCharacters(int widthInCharacters)	Set a width hint for displaying the text field

Methods inherited from interface ConfigParameter

addConfigParameterListener, removeConfigParameterListener

Methods inherited from interface 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 ParameterWithHint

getHintKey, setHintKey, setHintText

Methods inherited from interface ParameterWithSuffix

getSuffixLabelKey, setSuffixLabelKey, setSuffixLabelText

Method Details

setValue

void setValue(String value)

getValue

String getValue()

setMultiLine

void setMultiLine(int visible_line_count)

Parameters:

visible_line_count -

Since:

5201

setWidthInCharacters

void setWidthInCharacters(int widthInCharacters)

Set a width hint for displaying the text field

Since:

BiglyBT 1.9.0.1

getWidthInCharacters

int getWidthInCharacters()

Returns:

width hint in characters for displaying the text field

Since:

BiglyBT 1.9.0.1

setValidChars

void setValidChars(String chars,
 boolean caseSensitive)

Limit characters to a list

Since:

BiglyBT 1.9.0.1

addStringValidator

void addStringValidator(ParameterValidator<String> stringParamValidator)

Same as Parameter.addValidator(ParameterValidator), but casts the "toValue" to String.

Since:

BiglyBT 1.9.0.1

See Also:

• Parameter.addValidator(ParameterValidator)

setTextLimit

void setTextLimit(int textLimit)

Limit the number of characters for Parameter

Since:

BiglyBT 1.9.0.1

getTextLimit

int getTextLimit()

Get the character limit for Parameter

Since:

BiglyBT 1.9.0.1