Class BasicPluginConfigModelImpl
java.lang.Object
com.biglybt.pifimpl.local.ui.model.BasicPluginConfigModelImpl
- All Implemented Interfaces:
BasicPluginConfigModel
,PluginConfigModel
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate PluginConfigImpl
private String
private String
private PluginInterface
private String
private UIManagerImpl
-
Constructor Summary
ConstructorsConstructorDescriptionBasicPluginConfigModelImpl
(UIManagerImpl _ui_manager, String _parent_section, String _section) -
Method Summary
Modifier and TypeMethodDescriptionaddActionParameter2
(String label_resource_name, String action_resource_name) Adds an actionable UI widget, usually a displayed as button or a linkaddBooleanParameter2
(String key, String resource_name, boolean defaultValue) Add a new Boolean Plugin Parameter to the Config Model.addColorParameter2
(String key, String resource_name, int r, int g, int b) addDirectoryParameter2
(String key, String resource_name, String defaultValue) addFileParameter2
(String key, String resource_name, String defaultValue) addFileParameter2
(String key, String resource_name, String defaultValue, String[] file_extensions) addFloatParameter2
(String key, String resource_name, float defaultValue, float minValue, float maxValue, boolean allowZero, int digitsAfterDecimal) Add a new float Plugin Parameter to the Config ModeladdHyperlinkParameter2
(String resource_name, String url_location) addInfoParameter2
(String resource_name, String value) Display a label and a value together.addIntListParameter2
(String key, String resource_name, int[] values, String[] labels, int defaultValue) Add to the Config Model a new integer plugin parameter which is limited to a set list
Typically shown as a set of radio buttonsaddIntParameter2
(String key, String resource_name, int defaultValue) addIntParameter2
(String key, String resource_name, int defaultValue, int min_value, int max_value) addLabelParameter2
(String resource_name) Displays a single label.addPasswordParameter2
(String key, String resource_name, int encoding_type, byte[] defaultValue) addStringListParameter2
(String key, String resource_name, String[] values, String defaultValue) Add to the Config Model a new String plugin parameter which is limited to a set list
Typically shown as a drop down list, or a list boxaddStringListParameter2
(String key, String resource_name, String[] values, String[] labels, String defaultValue) Add to the Config Model a new String plugin parameter which is limited to a set list
Typically shown as a drop down list, or a list boxaddStringParameter2
(String key, String resource_name, String defaultValue) Add a new String Plugin Parameter to the Config ModeladdTextArea
(String resource_name) Creates a read-only text area similar to a label, but typically allows scrollbars and copying of portions of text.addUIParameter2
(UIParameterContext context, String resource_name) Creates aUIParameter
object to add to this config model object.createGroup
(String _resource_name, Parameter[] _parameters) Creates a group around a list of Parameters.void
destroy()
Retrieve all the parameters added to this plugin configprotected String
resolveKey
(String key) void
setLocalizedName
(String name) Sets the name of the configuration model - this is useful in situations where the configuration section is being dynamically created (perhaps with user input).
-
Field Details
-
ui_manager
-
parent_section
-
section
-
pi
-
parameters
-
key_prefix
-
configobj
-
-
Constructor Details
-
BasicPluginConfigModelImpl
public BasicPluginConfigModelImpl(UIManagerImpl _ui_manager, String _parent_section, String _section)
-
-
Method Details
-
getParentSection
- Specified by:
getParentSection
in interfaceBasicPluginConfigModel
- Returns:
-
getSection
- Specified by:
getSection
in interfaceBasicPluginConfigModel
- Returns:
-
getPluginInterface
- Specified by:
getPluginInterface
in interfacePluginConfigModel
-
getParameters
Description copied from interface:BasicPluginConfigModel
Retrieve all the parameters added to this plugin config- Specified by:
getParameters
in interfaceBasicPluginConfigModel
- Returns:
- parameter list
-
addBooleanParameter2
public BooleanParameter addBooleanParameter2(String key, String resource_name, boolean defaultValue) Description copied from interface:BasicPluginConfigModel
Add a new Boolean Plugin Parameter to the Config Model.
Typically shown as a checkbox- Specified by:
addBooleanParameter2
in interfaceBasicPluginConfigModel
- Parameters:
key
- Plugin config keyresource_name
- Label resource key
-
addStringParameter2
Description copied from interface:BasicPluginConfigModel
Add a new String Plugin Parameter to the Config Model- Specified by:
addStringParameter2
in interfaceBasicPluginConfigModel
- Parameters:
key
- Plugin config keyresource_name
- Label resource key
-
addStringListParameter2
public StringListParameter addStringListParameter2(String key, String resource_name, String[] values, String defaultValue) Description copied from interface:BasicPluginConfigModel
Add to the Config Model a new String plugin parameter which is limited to a set list
Typically shown as a drop down list, or a list box- Specified by:
addStringListParameter2
in interfaceBasicPluginConfigModel
- Parameters:
key
- Plugin config keyresource_name
- Label resource keyvalues
- List of available values
-
addStringListParameter2
public StringListParameter addStringListParameter2(String key, String resource_name, String[] values, String[] labels, String defaultValue) Description copied from interface:BasicPluginConfigModel
Add to the Config Model a new String plugin parameter which is limited to a set list
Typically shown as a drop down list, or a list box- Specified by:
addStringListParameter2
in interfaceBasicPluginConfigModel
- Parameters:
key
- Plugin config keyresource_name
- Label resource keylabels
- A list of localised message strings corresponding to each value.
-
addIntListParameter2
public IntListParameter addIntListParameter2(String key, String resource_name, int[] values, String[] labels, int defaultValue) Description copied from interface:BasicPluginConfigModel
Add to the Config Model a new integer plugin parameter which is limited to a set list
Typically shown as a set of radio buttons- Specified by:
addIntListParameter2
in interfaceBasicPluginConfigModel
- Parameters:
key
- Plugin config keyresource_name
- Label resource keylabels
- A list of localised message strings corresponding to each value.
-
addFloatParameter2
public FloatParameter addFloatParameter2(String key, String resource_name, float defaultValue, float minValue, float maxValue, boolean allowZero, int digitsAfterDecimal) Description copied from interface:BasicPluginConfigModel
Add a new float Plugin Parameter to the Config Model- Specified by:
addFloatParameter2
in interfaceBasicPluginConfigModel
- Parameters:
key
- Plugin config keyresource_name
- Label resource key
-
addPasswordParameter2
public PasswordParameter addPasswordParameter2(String key, String resource_name, int encoding_type, byte[] defaultValue) - Specified by:
addPasswordParameter2
in interfaceBasicPluginConfigModel
- Parameters:
key
-resource_name
-encoding_type
-defaultValue
-- Returns:
-
addIntParameter2
- Specified by:
addIntParameter2
in interfaceBasicPluginConfigModel
- Parameters:
key
-resource_name
-defaultValue
-- Returns:
-
addIntParameter2
public IntParameter addIntParameter2(String key, String resource_name, int defaultValue, int min_value, int max_value) - Specified by:
addIntParameter2
in interfaceBasicPluginConfigModel
- Parameters:
key
-resource_name
-defaultValue
-min_value
- Minimum allowed valuemax_value
- Maximum allowed value- Returns:
-
addDirectoryParameter2
public DirectoryParameter addDirectoryParameter2(String key, String resource_name, String defaultValue) - Specified by:
addDirectoryParameter2
in interfaceBasicPluginConfigModel
- Parameters:
key
-resource_name
- MessageBundle keydefaultValue
-- Returns:
-
addFileParameter2
- Specified by:
addFileParameter2
in interfaceBasicPluginConfigModel
- Parameters:
key
-resource_name
-defaultValue
-- Returns:
-
addFileParameter2
public FileParameter addFileParameter2(String key, String resource_name, String defaultValue, String[] file_extensions) - Specified by:
addFileParameter2
in interfaceBasicPluginConfigModel
- Parameters:
key
-resource_name
-defaultValue
-file_extensions
- Allowed list of file extensions.- Returns:
-
addLabelParameter2
Description copied from interface:BasicPluginConfigModel
Displays a single label. Not linked to a config key.- Specified by:
addLabelParameter2
in interfaceBasicPluginConfigModel
- Parameters:
resource_name
- MessageBundle key
-
addInfoParameter2
Description copied from interface:BasicPluginConfigModel
Display a label and a value together. Not linked to a config key.- Specified by:
addInfoParameter2
in interfaceBasicPluginConfigModel
- Parameters:
resource_name
- MessageBundle keyvalue
- String value
-
addHyperlinkParameter2
- Specified by:
addHyperlinkParameter2
in interfaceBasicPluginConfigModel
-
addColorParameter2
- Specified by:
addColorParameter2
in interfaceBasicPluginConfigModel
- Parameters:
key
-resource_name
-r
-g
-b
-- Returns:
-
addUIParameter2
Description copied from interface:BasicPluginConfigModel
Creates aUIParameter
object to add to this config model object.- Specified by:
addUIParameter2
in interfaceBasicPluginConfigModel
- Parameters:
resource_name
- Not Used. null recommended.
-
addActionParameter2
Description copied from interface:BasicPluginConfigModel
Adds an actionable UI widget, usually a displayed as button or a link- Specified by:
addActionParameter2
in interfaceBasicPluginConfigModel
- Parameters:
label_resource_name
- Text before the buttonaction_resource_name
- Button Text
-
addTextArea
Description copied from interface:BasicPluginConfigModel
Creates a read-only text area similar to a label, but typically allows scrollbars and copying of portions of text.- Specified by:
addTextArea
in interfaceBasicPluginConfigModel
-
createGroup
Description copied from interface:BasicPluginConfigModel
Creates a group around a list of Parameters. Typically displayed in a border when there's a resource_name, or borderless when there isn't.- Specified by:
createGroup
in interfaceBasicPluginConfigModel
-
createTabFolder
- Specified by:
createTabFolder
in interfaceBasicPluginConfigModel
- Returns:
-
destroy
public void destroy()- Specified by:
destroy
in interfacePluginConfigModel
-
setLocalizedName
Description copied from interface:BasicPluginConfigModel
Sets the name of the configuration model - this is useful in situations where the configuration section is being dynamically created (perhaps with user input).- Specified by:
setLocalizedName
in interfaceBasicPluginConfigModel
-
resolveKey
-