Class FileParameterImpl

java.lang.Object

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

com.biglybt.pifimpl.local.ui.config.FileParameterImpl

All Implemented Interfaces:

ParameterListener, ConfigParameter, EnablerParameter, FileParameter, Parameter, ParameterWithHint

public class FileParameterImpl
extends ParameterImpl
implements FileParameter

Field Summary

Fields

Modifier and Type	Field	Description
private String[]	file_extensions
private String	fileNameHint
private String	hintKey
private String	keyDialogTitle

Fields inherited from class ParameterImpl

configKey

Fields inherited from interface Parameter

MODE_ADVANCED, MODE_BEGINNER, MODE_INTERMEDIATE

Constructor Summary

Constructors

Constructor	Description
FileParameterImpl(String key, String labelKey, String... file_extensions)

Method Summary

Modifier and Type	Method	Description
String[]	getFileExtensions()
String	getFileName()
String	getFileNameHint()
String	getHintKey()	Get the messagebundle key for the Parameter's hint.
String	getKeyDialogTitle()
String	getValue()
Object	getValueObject()	Retrieve the parameter's value as an Object.
void	setDialogTitleKey(String key)	Title of the dialog box shown when user clicks the browse button
void	setFileName(String filename)
void	setFileNameHint(String fileNameHint)
void	setHintKey(String hintKey)	Sets the widget message to a messagebundle key.
void	setHintText(String text)	Sets the widget message.

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

fileNameHint

private String fileNameHint

file_extensions

private String[] file_extensions

keyDialogTitle

private String keyDialogTitle

hintKey

private String hintKey

Constructor Details

FileParameterImpl

public FileParameterImpl(String key,
 String labelKey,
 String... file_extensions)

Method Details

getValue

public String getValue()

Specified by:

getValue in interface FileParameter

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

getFileNameHint

public String getFileNameHint()

setFileNameHint

public void setFileNameHint(String fileNameHint)

getFileExtensions

public String[] getFileExtensions()

setDialogTitleKey

public void setDialogTitleKey(String key)

Description copied from interface: FileParameter

Title of the dialog box shown when user clicks the browse button

Specified by:

setDialogTitleKey in interface FileParameter

getKeyDialogTitle

public String getKeyDialogTitle()

getFileName

public String getFileName()

setFileName

public void setFileName(String filename)

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