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 java.lang.String
hintKey
private int
line_count
private java.lang.String
suffixLabelKey
private int
textLimit
private java.lang.String
validChars
private boolean
validCharsCaseSensitive
private int
widthInCharacters
-
Fields inherited from class com.biglybt.pifimpl.local.ui.config.ParameterImpl
configKey
-
Fields inherited from interface com.biglybt.pif.ui.config.Parameter
MODE_ADVANCED, MODE_BEGINNER, MODE_INTERMEDIATE
-
-
Constructor Summary
Constructors Constructor Description StringParameterImpl(java.lang.String coreConfigKey, java.lang.String labelKey)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addStringValidator(ParameterValidator<java.lang.String> stringParamValidator)
Same asParameter.addValidator(ParameterValidator)
, but casts the "toValue" to String.java.lang.String
getHintKey()
Get the messagebundle key for the Parameter's hint.int
getMultiLine()
java.lang.String
getSuffixLabelKey()
int
getTextLimit()
Get the character limit for Parameterjava.lang.String
getValidChars()
java.lang.String
getValue()
java.lang.Object
getValueObject()
Retrieve the parameter's value as an Object.int
getWidthInCharacters()
boolean
isValidCharsCaseSensitive()
void
setHintKey(java.lang.String hintKey)
Sets the widget message to a messagebundle key.void
setHintText(java.lang.String text)
Sets the widget message.void
setMultiLine(int visible_line_count)
void
setSuffixLabelKey(java.lang.String suffixLabelKey)
void
setSuffixLabelText(java.lang.String text)
void
setTextLimit(int textLimit)
Limit the number of characters for Parametervoid
setValidChars(java.lang.String chars, boolean caseSensitive)
Limit characters to a listvoid
setValue(java.lang.String s)
void
setWidthInCharacters(int widthInCharacters)
Set a width hint for displaying the text field-
Methods inherited from class com.biglybt.pifimpl.local.ui.config.ParameterImpl
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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.biglybt.pif.config.ConfigParameter
addConfigParameterListener, removeConfigParameterListener
-
Methods inherited from interface com.biglybt.pif.ui.config.Parameter
addListener, addValidator, getConfigKeyName, getGenerateIntermediateEvents, getLabelKey, getLabelText, getMinimumRequiredUserMode, hasBeenSet, isEnabled, isForUIType, isVisible, removeListener, resetToDefault, setAllowedUiTypes, setEnabled, setGenerateIntermediateEvents, setIndent, setLabelKey, setLabelText, setMinimumRequiredUserMode, setVisible
-
-
-
-
Field Detail
-
line_count
private int line_count
-
widthInCharacters
private int widthInCharacters
-
validChars
private java.lang.String validChars
-
validCharsCaseSensitive
private boolean validCharsCaseSensitive
-
suffixLabelKey
private java.lang.String suffixLabelKey
-
textLimit
private int textLimit
-
hintKey
private java.lang.String hintKey
-
-
Method Detail
-
getValue
public java.lang.String getValue()
- Specified by:
getValue
in interfaceStringParameter
-
setValue
public void setValue(java.lang.String s)
- Specified by:
setValue
in interfaceStringParameter
-
setMultiLine
public void setMultiLine(int visible_line_count)
- Specified by:
setMultiLine
in interfaceStringParameter
-
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 interfaceStringParameter
-
getWidthInCharacters
public int getWidthInCharacters()
- Specified by:
getWidthInCharacters
in interfaceStringParameter
- Returns:
- width hint in characters for displaying the text field
-
setValidChars
public void setValidChars(java.lang.String chars, boolean caseSensitive)
Description copied from interface:StringParameter
Limit characters to a list- Specified by:
setValidChars
in interfaceStringParameter
-
addStringValidator
public void addStringValidator(ParameterValidator<java.lang.String> stringParamValidator)
Description copied from interface:StringParameter
Same asParameter.addValidator(ParameterValidator)
, but casts the "toValue" to String.- Specified by:
addStringValidator
in interfaceStringParameter
- See Also:
Parameter.addValidator(ParameterValidator)
-
getValidChars
public java.lang.String getValidChars()
-
isValidCharsCaseSensitive
public boolean isValidCharsCaseSensitive()
-
getSuffixLabelKey
public java.lang.String getSuffixLabelKey()
- Specified by:
getSuffixLabelKey
in interfaceParameterWithSuffix
-
setSuffixLabelKey
public void setSuffixLabelKey(java.lang.String suffixLabelKey)
- Specified by:
setSuffixLabelKey
in interfaceParameterWithSuffix
-
setSuffixLabelText
public void setSuffixLabelText(java.lang.String text)
- Specified by:
setSuffixLabelText
in interfaceParameterWithSuffix
-
setTextLimit
public void setTextLimit(int textLimit)
Description copied from interface:StringParameter
Limit the number of characters for Parameter- Specified by:
setTextLimit
in interfaceStringParameter
-
getTextLimit
public int getTextLimit()
Description copied from interface:StringParameter
Get the character limit for Parameter- Specified by:
getTextLimit
in interfaceStringParameter
-
getHintKey
public java.lang.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 interfaceParameterWithHint
-
setHintKey
public void setHintKey(java.lang.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 interfaceParameterWithHint
-
setHintText
public void setHintText(java.lang.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 interfaceParameterWithHint
-
getValueObject
public java.lang.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 interfaceParameter
- Overrides:
getValueObject
in classParameterImpl
-
-