Interface EnablerParameter

All Superinterfaces:

ConfigParameter, Parameter

All Known Subinterfaces:

BooleanParameter

All Known Implementing Classes:

ActionParameterImpl, BooleanParameterImpl, ColorParameterImpl, DateTimeParameterImpl, DirectoryParameterImpl, FileParameterImpl, FloatParameterImpl, HyperlinkParameterImpl, InfoParameterImpl, IntListParameterImpl, IntParameterImpl, LabelParameterImpl, LongParameterImpl, ParameterGroupImpl, ParameterImpl, ParameterTabFolderImpl, PasswordParameterImpl, StringListParameterImpl, StringParameterImpl, UIParameterImpl, UITextAreaImpl

public interface EnablerParameter
extends Parameter

represents a parameter that is able to enable/disable other parameters.

Field Summary

Fields inherited from interface Parameter

MODE_ADVANCED, MODE_BEGINNER, MODE_INTERMEDIATE

Method Summary

Modifier and Type	Method	Description
void	addDisabledOnSelection(Parameter parameterToDisable)	disables parameter when EnablerParameter is selected.
void	addDisabledOnSelection(Parameter... parametersToDisable)	disables parameter when EnablerParameter is selected.
void	addEnabledOnSelection(Parameter paramToEnable)	enables paramToEnable when this EnablerParameter is selected (checked). paramToEnable is disabled when this EnablerParameter isn't selected (checked).
void	addEnabledOnSelection(Parameter... parametersToEnable)	enables paramToEnable when this EnablerParameter is selected (checked). paramToEnable is disabled when this EnablerParameter isn't selected (checked).

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

Method Details

addDisabledOnSelection

void addDisabledOnSelection(Parameter... parametersToDisable)

disables parameter when EnablerParameter is selected.

Parameters:

parametersToDisable - the Parameter to act on

Since:

BiglyBT 1.9.0.1

addDisabledOnSelection

void addDisabledOnSelection(Parameter parameterToDisable)

disables parameter when EnablerParameter is selected.

Parameters:

parameterToDisable - the Parameter to act on

Since:

BiglyBT 1.0.0.0

addEnabledOnSelection

void addEnabledOnSelection(Parameter paramToEnable)

enables paramToEnable when this EnablerParameter is selected (checked).
paramToEnable is disabled when this EnablerParameter isn't selected (checked).

Note: When this EnableParameter is disabled, paramToEnable's state will not be modified. In cases where parameter1 is enabled by its parent, and parameter1 enabled children, you must also parent.addEnabledOnSelection(children) if you want the children to be disabled when parent is unselected (unchecked).

Parameters:

paramToEnable - the Parameter to act on

Since:

BiglyBT 1.0.0.0

addEnabledOnSelection

void addEnabledOnSelection(Parameter... parametersToEnable)

enables paramToEnable when this EnablerParameter is selected (checked).
paramToEnable is disabled when this EnablerParameter isn't selected (checked).

Note: When this EnableParameter is disabled, parametersToDisable's state will not be modified. In cases where parameter1 is enabled by its parent, and parameter1 enabled children, you must also parent.addEnabledOnSelection(children) if you want the children to be disabled when parent is unselected (unchecked).

Parameters:

parametersToEnable - the Parameter to act on

Since:

BiglyBT 1.9.0.1