Class StringParameterImpl

java.lang.Object

com.biglybt.pifimpl.local.ui.config.ParameterImpl

com.biglybt.pifimpl.local.ui.config.StringParameterImpl

All Implemented Interfaces:

ParameterListener, ConfigParameter, EnablerParameter, Parameter, ParameterWithHint, ParameterWithSuffix, StringParameter

public class StringParameterImpl
extends ParameterImpl
implements StringParameter

Field Summary

Fields

Modifier and Type	Field	Description
private String	hintKey
private int	line_count
private String	suffixLabelKey
private int	textLimit
private String	validChars
private boolean	validCharsCaseSensitive
private int	widthInCharacters

Fields inherited from class ParameterImpl

configKey

Fields inherited from interface Parameter

MODE_ADVANCED, MODE_BEGINNER, MODE_INTERMEDIATE

Constructor Summary

Constructors

Constructor	Description
StringParameterImpl(String coreConfigKey, String labelKey)

Method Summary

Modifier and Type	Method	Description
void	addStringValidator(ParameterValidator<String> stringParamValidator)	Same as Parameter.addValidator(ParameterValidator), but casts the "toValue" to String.
String	getHintKey()	Get the messagebundle key for the Parameter's hint.
int	getMultiLine()
String	getSuffixLabelKey()
int	getTextLimit()	Get the character limit for Parameter
String	getValidChars()
String	getValue()
Object	getValueObject()	Retrieve the parameter's value as an Object.
int	getWidthInCharacters()
boolean	isValidCharsCaseSensitive()
void	setHintKey(String hintKey)	Sets the widget message to a messagebundle key.
void	setHintText(String text)	Sets the widget message.
void	setMultiLine(int visible_line_count)
void	setSuffixLabelKey(String suffixLabelKey)
void	setSuffixLabelText(String text)
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 s)
void	setWidthInCharacters(int widthInCharacters)	Set a width hint for displaying the text field

Methods inherited from class ParameterImpl

addAndFireListener, addConfigParameterListener, addDisabledOnSelection, addDisabledOnSelection, addEnabledOnSelection, addEnabledOnSelection, addImplListener, addListener, addValidator, destroy, fireParameterChanged, getConfigKeyName, getDisabledOnSelectionParameters, getEnabledOnSelectionParameters, getGenerateIntermediateEvents, getGroup, getIndent, getKey, getLabelKey, getLabelText, getMinimumRequiredUserMode, getReferenceID, hasBeenSet, isEnabled, isForUIType, isIndentFancy, isVisible, parameterChanged, refreshControl, removeConfigParameterListener, removeImplListener, removeListener, resetToDefault, search, setAllowedUiTypes, setEnabled, setGenerateIntermediateEvents, setGroup, setIndent, setLabelKey, setLabelText, setMinimumRequiredUserMode, setReferenceID, setVisible, validate

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ConfigParameter

addConfigParameterListener, removeConfigParameterListener

Methods inherited from interface Parameter

addAndFireListener, addListener, addValidator, getConfigKeyName, getGenerateIntermediateEvents, getLabelKey, getLabelText, getMinimumRequiredUserMode, hasBeenSet, isEnabled, isForUIType, isVisible, removeListener, resetToDefault, setAllowedUiTypes, setEnabled, setGenerateIntermediateEvents, setIndent, setLabelKey, setLabelText, setMinimumRequiredUserMode, setVisible

Field Details

line_count

private int line_count

widthInCharacters

private int widthInCharacters

validChars

private String validChars

validCharsCaseSensitive

private boolean validCharsCaseSensitive

suffixLabelKey

private String suffixLabelKey

textLimit

private int textLimit

hintKey

private String hintKey

Constructor Details

StringParameterImpl

public StringParameterImpl(String coreConfigKey,
 String labelKey)

Method Details

getValue

public String getValue()

Specified by:

getValue in interface StringParameter

setValue

public void setValue(String s)

Specified by:

setValue in interface StringParameter

setMultiLine

public void setMultiLine(int visible_line_count)

Specified by:

setMultiLine in interface StringParameter

Parameters:

visible_line_count -

getMultiLine

public int getMultiLine()

setWidthInCharacters

public void setWidthInCharacters(int widthInCharacters)

Description copied from interface: StringParameter

Set a width hint for displaying the text field

Specified by:

setWidthInCharacters in interface StringParameter

getWidthInCharacters

public int getWidthInCharacters()

Specified by:

getWidthInCharacters in interface StringParameter

Returns:

width hint in characters for displaying the text field

setValidChars

public void setValidChars(String chars,
 boolean caseSensitive)

Description copied from interface: StringParameter

Limit characters to a list

Specified by:

setValidChars in interface StringParameter

addStringValidator

public void addStringValidator(ParameterValidator<String> stringParamValidator)

Description copied from interface: StringParameter

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

Specified by:

addStringValidator in interface StringParameter

See Also:

• Parameter.addValidator(ParameterValidator)

getValidChars

public String getValidChars()

isValidCharsCaseSensitive

public boolean isValidCharsCaseSensitive()

getSuffixLabelKey

public String getSuffixLabelKey()

Specified by:

getSuffixLabelKey in interface ParameterWithSuffix

setSuffixLabelKey

public void setSuffixLabelKey(String suffixLabelKey)

Specified by:

setSuffixLabelKey in interface ParameterWithSuffix

setSuffixLabelText

public void setSuffixLabelText(String text)

Specified by:

setSuffixLabelText in interface ParameterWithSuffix

setTextLimit

public void setTextLimit(int textLimit)

Description copied from interface: StringParameter

Limit the number of characters for Parameter

Specified by:

setTextLimit in interface StringParameter

getTextLimit

public int getTextLimit()

Description copied from interface: StringParameter

Get the character limit for Parameter

Specified by:

getTextLimit in interface StringParameter

getHintKey

public String getHintKey()

Description copied from interface: ParameterWithHint

Get the messagebundle key for the Parameter's hint. Hints are usually only displayed when the field is empty.

Specified by:

getHintKey in interface ParameterWithHint

setHintKey

public void setHintKey(String hintKey)

Description copied from interface: ParameterWithHint

Sets the widget message to a messagebundle key. The message text is displayed as a hint for the user, indicating the purpose of the field. Hints are usually only displayed when the field is empty.

Specified by:

setHintKey in interface ParameterWithHint

setHintText

public void setHintText(String text)

Description copied from interface: ParameterWithHint

Sets the widget message. The text is displayed as a hint for the user, indicating the purpose of the field. Hints are usually only displayed when the field is empty.

Specified by:

setHintText in interface ParameterWithHint

getValueObject

public Object getValueObject()

Description copied from interface: Parameter

Retrieve the parameter's value as an Object. Subclasses will usually have a getValue() that will return a specific type.

Specified by:

getValueObject in interface Parameter

Overrides:

getValueObject in class ParameterImpl