Class ConfigSectionImpl

java.lang.Object

com.biglybt.ui.config.ConfigSectionImpl

All Implemented Interfaces:

BaseConfigSection

Direct Known Subclasses:

BasicPluginConfigImpl, ConfigSectionBackupRestore, ConfigSectionConnection, ConfigSectionConnectionAdvanced, ConfigSectionConnectionDNS, ConfigSectionConnectionEncryption, ConfigSectionConnectionProxy, ConfigSectionFile, ConfigSectionFileMove, ConfigSectionFilePerformance, ConfigSectionFileTorrents, ConfigSectionFileTorrentsDecoding, ConfigSectionHolder, ConfigSectionInterfaceAlertsSWT, ConfigSectionInterfaceColorSWT, ConfigSectionInterfaceDisplaySWT, ConfigSectionInterfaceLanguage, ConfigSectionInterfaceLegacySWT, ConfigSectionInterfacePasswordSWT, ConfigSectionInterfaceStartSWT, ConfigSectionInterfaceSWT, ConfigSectionInterfaceTablesSWT, ConfigSectionInterfaceTags, ConfigSectionIPFilter, ConfigSectionLogging, ConfigSectionMode, ConfigSectionPlugins, ConfigSectionSecurity, ConfigSectionSharing, ConfigSectionStartShutdown, ConfigSectionStats, ConfigSectionTracker, ConfigSectionTrackerClient, ConfigSectionTrackerServer, ConfigSectionTransfer, ConfigSectionTransferAutoSpeedClassic, ConfigSectionTransferAutoSpeedSelect, ConfigSectionTransferAutoSpeedV2, ConfigSectionTransferLAN

public abstract class ConfigSectionImpl
extends Object
implements BaseConfigSection

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfigSectionImpl.ConfigDetailsCallback

Field Summary

Fields

Modifier and Type	Field	Description
private int	defaultMode
private String[]	defaultUITypes
private boolean	isBuilt
static final String	L10N_SECTION_PREFIX
protected final Map<String, ParameterImpl>	mapPluginParams
private final int	minUserMode
private final String	parentSectionID
private ConfigSectionRebuildRunner	rebuildRunner
private final String	sectionID

Constructor Summary

Constructors

Constructor	Description
ConfigSectionImpl(WeakReference<BasicPluginConfigModel> model_ref)
ConfigSectionImpl(String sectionID, String parentSectionID)
ConfigSectionImpl(String sectionID, String parentSectionID, int minUserMode)

Method Summary

Modifier and Type	Method	Description
protected final <T extends ParameterImpl> T	add(String key, T param, int minMode, List<Parameter>... otherLists)
protected final <T extends ParameterImpl> T	add(String key, T param, List<Parameter>... otherLists)
protected final <T extends ParameterImpl> T	add(T param, int minMode, List<Parameter>... otherLists)
protected final <T extends ParameterImpl> T	add(T param, List<Parameter>... otherLists)
void	deleteConfigSection()	Config view is closing
final String	findPluginParamKey(Parameter param)
final String	getConfigSectionID()	In order for the plugin to display its section correctly, a key in the Plugin language file will need to contain ConfigView.section.<getConfigSectionID() result>=The Section name.
final int	getMaxUserMode()	Indicate if additional options are available to display a hint to the users
final int	getMinUserMode()	Returns the minimum user mode needed for this section to be displayed.
final Parameter[]	getParamArray()
final String	getParentSectionID()	Returns section you want your configuration panel to be under.
final ParameterImpl	getPluginParam(String key)
String	getSectionNameKey()
static String	getSectionNameKey(String sectionID)
protected String	guessParamName(Parameter param, boolean warnExists)
final boolean	isBuilt()
final void	postBuild()
void	requestRebuild()	Request the UI to rebuild this config section.
void	saveConfigSection()	User selected Save.
List<Parameter>	search(Pattern regex)
final void	setDefaultUITypesForAdd(String... defaultUITypes)	Any Parameters added after this call will be auto-assigned these UI Types
final void	setDefaultUserModeForAdd(int defaultMode)	Any Parameters added after this call will be auto-assigned this user mode
void	setRebuildRunner(ConfigSectionRebuildRunner rebuildRunner)

Methods inherited from class Object

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

Methods inherited from interface BaseConfigSection

build

Field Details

L10N_SECTION_PREFIX

public static final String L10N_SECTION_PREFIX

See Also:

• Constant Field Values

sectionID

private final String sectionID

parentSectionID

private final String parentSectionID

minUserMode

private final int minUserMode

defaultMode

private int defaultMode

isBuilt

private boolean isBuilt

defaultUITypes

private String[] defaultUITypes

rebuildRunner

private ConfigSectionRebuildRunner rebuildRunner

mapPluginParams

protected final Map<String, ParameterImpl> mapPluginParams

Constructor Details

ConfigSectionImpl

public ConfigSectionImpl(WeakReference<BasicPluginConfigModel> model_ref)

ConfigSectionImpl

public ConfigSectionImpl(String sectionID,
 String parentSectionID)

ConfigSectionImpl

public ConfigSectionImpl(String sectionID,
 String parentSectionID,
 int minUserMode)

Method Details

getConfigSectionID

public final String getConfigSectionID()

Description copied from interface: BaseConfigSection

In order for the plugin to display its section correctly, a key in the Plugin language file will need to contain ConfigView.section.<getConfigSectionID() result>=The Section name.

Specified by:

getConfigSectionID in interface BaseConfigSection

Returns:

The name of the configuration section

getParentSectionID

public final String getParentSectionID()

Description copied from interface: BaseConfigSection

Returns section you want your configuration panel to be under. See BasicPluginConfigModel.SECTION_* constants. To add a subsection to your own ConfigSection, return the getConfigSectionID result of your parent.

Specified by:

getParentSectionID in interface BaseConfigSection

postBuild

public final void postBuild()

Specified by:

postBuild in interface BaseConfigSection

isBuilt

public final boolean isBuilt()

Specified by:

isBuilt in interface BaseConfigSection

setDefaultUserModeForAdd

public final void setDefaultUserModeForAdd(int defaultMode)

Any Parameters added after this call will be auto-assigned this user mode

setDefaultUITypesForAdd

public final void setDefaultUITypesForAdd(String... defaultUITypes)

Any Parameters added after this call will be auto-assigned these UI Types

Parameters:

defaultUITypes - UIInstance.UIT_SWT, UIInstance.UIT_CONSOLE, etc

add

@SafeVarargs
protected final <T extends ParameterImpl> T add(T param,
 List<Parameter>... otherLists)

add

@SafeVarargs
protected final <T extends ParameterImpl> T add(T param,
 int minMode,
 List<Parameter>... otherLists)

add

@SafeVarargs
protected final <T extends ParameterImpl> T add(String key,
 T param,
 List<Parameter>... otherLists)

add

@SafeVarargs
protected final <T extends ParameterImpl> T add(String key,
 T param,
 int minMode,
 List<Parameter>... otherLists)

guessParamName

protected String guessParamName(Parameter param,
 boolean warnExists)

getParamArray

public final Parameter[] getParamArray()

Specified by:

getParamArray in interface BaseConfigSection

getPluginParam

public final ParameterImpl getPluginParam(String key)

Specified by:

getPluginParam in interface BaseConfigSection

findPluginParamKey

public final String findPluginParamKey(Parameter param)

saveConfigSection

public void saveConfigSection()

Description copied from interface: BaseConfigSection

User selected Save. All saving of non-plugin tabs have been completed, as well as saving of plugins that implement com.biglybt.pif.ui.config parameters.

Specified by:

saveConfigSection in interface BaseConfigSection

deleteConfigSection

public void deleteConfigSection()

Description copied from interface: BaseConfigSection

Config view is closing

Specified by:

deleteConfigSection in interface BaseConfigSection

getMinUserMode

public final int getMinUserMode()

Description copied from interface: BaseConfigSection

Returns the minimum user mode needed for this section to be displayed.

Note: Section may be visually displayed, but with a notification that modification is unavailable at current user mode.

Specified by:

getMinUserMode in interface BaseConfigSection

See Also:

• Parameter.MODE_BEGINNER
• Parameter.MODE_INTERMEDIATE
• Parameter.MODE_ADVANCED

setRebuildRunner

public void setRebuildRunner(ConfigSectionRebuildRunner rebuildRunner)

Specified by:

setRebuildRunner in interface BaseConfigSection

requestRebuild

public void requestRebuild()

Description copied from interface: BaseConfigSection

Request the UI to rebuild this config section. For SWT, all SWT objects will be disposed and recreated.

Specified by:

requestRebuild in interface BaseConfigSection

getMaxUserMode

public final int getMaxUserMode()

Description copied from interface: BaseConfigSection

Indicate if additional options are available to display a hint to the users

Specified by:

getMaxUserMode in interface BaseConfigSection

Returns:

the highest user mode that reveals additional options (0 = Beginner, 1 = Intermediate, 2 = Advanced)

getSectionNameKey

public String getSectionNameKey()

Specified by:

getSectionNameKey in interface BaseConfigSection

getSectionNameKey

public static String getSectionNameKey(String sectionID)

search

public List<Parameter> search(Pattern regex)

Specified by:

search in interface BaseConfigSection