Class BasicPluginConfigModelImpl
- java.lang.Object
-
- com.biglybt.pifimpl.local.ui.model.BasicPluginConfigModelImpl
-
- All Implemented Interfaces:
BasicPluginConfigModel
,PluginConfigModel
public class BasicPluginConfigModelImpl extends java.lang.Object implements BasicPluginConfigModel
-
-
Field Summary
Fields Modifier and Type Field Description private PluginConfigImpl
configobj
private java.lang.String
key_prefix
private java.util.ArrayList<Parameter>
parameters
private java.lang.String
parent_section
private PluginInterface
pi
private java.lang.String
section
private UIManagerImpl
ui_manager
-
Constructor Summary
Constructors Constructor Description BasicPluginConfigModelImpl(UIManagerImpl _ui_manager, java.lang.String _parent_section, java.lang.String _section)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ActionParameter
addActionParameter2(java.lang.String label_resource_name, java.lang.String action_resource_name)
Adds an actionable UI widget, usually a displayed as button or a linkBooleanParameter
addBooleanParameter2(java.lang.String key, java.lang.String resource_name, boolean defaultValue)
Add a new Boolean Plugin Parameter to the Config Model.ColorParameter
addColorParameter2(java.lang.String key, java.lang.String resource_name, int r, int g, int b)
DirectoryParameter
addDirectoryParameter2(java.lang.String key, java.lang.String resource_name, java.lang.String defaultValue)
FileParameter
addFileParameter2(java.lang.String key, java.lang.String resource_name, java.lang.String defaultValue)
FileParameter
addFileParameter2(java.lang.String key, java.lang.String resource_name, java.lang.String defaultValue, java.lang.String[] file_extensions)
FloatParameter
addFloatParameter2(java.lang.String key, java.lang.String resource_name, float defaultValue, float minValue, float maxValue, boolean allowZero, int digitsAfterDecimal)
Add a new float Plugin Parameter to the Config ModelHyperlinkParameter
addHyperlinkParameter2(java.lang.String resource_name, java.lang.String url_location)
InfoParameter
addInfoParameter2(java.lang.String resource_name, java.lang.String value)
Display a label and a value together.IntListParameter
addIntListParameter2(java.lang.String key, java.lang.String resource_name, int[] values, java.lang.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 buttonsIntParameter
addIntParameter2(java.lang.String key, java.lang.String resource_name, int defaultValue)
IntParameter
addIntParameter2(java.lang.String key, java.lang.String resource_name, int defaultValue, int min_value, int max_value)
LabelParameter
addLabelParameter2(java.lang.String resource_name)
Displays a single label.PasswordParameter
addPasswordParameter2(java.lang.String key, java.lang.String resource_name, int encoding_type, byte[] defaultValue)
StringListParameter
addStringListParameter2(java.lang.String key, java.lang.String resource_name, java.lang.String[] values, java.lang.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 boxStringListParameter
addStringListParameter2(java.lang.String key, java.lang.String resource_name, java.lang.String[] values, java.lang.String[] labels, java.lang.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 boxStringParameter
addStringParameter2(java.lang.String key, java.lang.String resource_name, java.lang.String defaultValue)
Add a new String Plugin Parameter to the Config ModelUITextArea
addTextArea(java.lang.String resource_name)
Creates a read-only text area similar to a label, but typically allows scrollbars and copying of portions of text.UIParameter
addUIParameter2(UIParameterContext context, java.lang.String resource_name)
Creates aUIParameter
object to add to this config model object.ParameterGroup
createGroup(java.lang.String _resource_name, Parameter[] _parameters)
Creates a group around a list of Parameters.ParameterTabFolder
createTabFolder()
void
destroy()
Parameter[]
getParameters()
Retrieve all the parameters added to this plugin configjava.lang.String
getParentSection()
PluginInterface
getPluginInterface()
java.lang.String
getSection()
protected java.lang.String
resolveKey(java.lang.String key)
void
setLocalizedName(java.lang.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 Detail
-
ui_manager
private UIManagerImpl ui_manager
-
parent_section
private java.lang.String parent_section
-
section
private java.lang.String section
-
pi
private PluginInterface pi
-
parameters
private java.util.ArrayList<Parameter> parameters
-
key_prefix
private java.lang.String key_prefix
-
configobj
private PluginConfigImpl configobj
-
-
Constructor Detail
-
BasicPluginConfigModelImpl
public BasicPluginConfigModelImpl(UIManagerImpl _ui_manager, java.lang.String _parent_section, java.lang.String _section)
-
-
Method Detail
-
getParentSection
public java.lang.String getParentSection()
- Specified by:
getParentSection
in interfaceBasicPluginConfigModel
- Returns:
-
getSection
public java.lang.String getSection()
- Specified by:
getSection
in interfaceBasicPluginConfigModel
- Returns:
-
getPluginInterface
public PluginInterface getPluginInterface()
- Specified by:
getPluginInterface
in interfacePluginConfigModel
-
getParameters
public Parameter[] 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(java.lang.String key, java.lang.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
public StringParameter addStringParameter2(java.lang.String key, java.lang.String resource_name, java.lang.String defaultValue)
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(java.lang.String key, java.lang.String resource_name, java.lang.String[] values, java.lang.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(java.lang.String key, java.lang.String resource_name, java.lang.String[] values, java.lang.String[] labels, java.lang.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(java.lang.String key, java.lang.String resource_name, int[] values, java.lang.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(java.lang.String key, java.lang.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(java.lang.String key, java.lang.String resource_name, int encoding_type, byte[] defaultValue)
- Specified by:
addPasswordParameter2
in interfaceBasicPluginConfigModel
- Returns:
-
addIntParameter2
public IntParameter addIntParameter2(java.lang.String key, java.lang.String resource_name, int defaultValue)
- Specified by:
addIntParameter2
in interfaceBasicPluginConfigModel
- Returns:
-
addIntParameter2
public IntParameter addIntParameter2(java.lang.String key, java.lang.String resource_name, int defaultValue, int min_value, int max_value)
- Specified by:
addIntParameter2
in interfaceBasicPluginConfigModel
min_value
- Minimum allowed valuemax_value
- Maximum allowed value- Returns:
-
addDirectoryParameter2
public DirectoryParameter addDirectoryParameter2(java.lang.String key, java.lang.String resource_name, java.lang.String defaultValue)
- Specified by:
addDirectoryParameter2
in interfaceBasicPluginConfigModel
resource_name
- MessageBundle key- Returns:
-
addFileParameter2
public FileParameter addFileParameter2(java.lang.String key, java.lang.String resource_name, java.lang.String defaultValue)
- Specified by:
addFileParameter2
in interfaceBasicPluginConfigModel
- Returns:
-
addFileParameter2
public FileParameter addFileParameter2(java.lang.String key, java.lang.String resource_name, java.lang.String defaultValue, java.lang.String[] file_extensions)
- Specified by:
addFileParameter2
in interfaceBasicPluginConfigModel
file_extensions
- Allowed list of file extensions.- Returns:
-
addLabelParameter2
public LabelParameter addLabelParameter2(java.lang.String resource_name)
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
public InfoParameter addInfoParameter2(java.lang.String resource_name, java.lang.String value)
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
public HyperlinkParameter addHyperlinkParameter2(java.lang.String resource_name, java.lang.String url_location)
- Specified by:
addHyperlinkParameter2
in interfaceBasicPluginConfigModel
-
addColorParameter2
public ColorParameter addColorParameter2(java.lang.String key, java.lang.String resource_name, int r, int g, int b)
- Specified by:
addColorParameter2
in interfaceBasicPluginConfigModel
- Returns:
-
addUIParameter2
public UIParameter addUIParameter2(UIParameterContext context, java.lang.String resource_name)
Description copied from interface:BasicPluginConfigModel
Creates aUIParameter
object to add to this config model object.- Specified by:
addUIParameter2
in interfaceBasicPluginConfigModel
resource_name
- Not Used. null recommended.
-
addActionParameter2
public ActionParameter addActionParameter2(java.lang.String label_resource_name, java.lang.String action_resource_name)
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
public UITextArea addTextArea(java.lang.String resource_name)
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
public ParameterGroup createGroup(java.lang.String _resource_name, Parameter[] _parameters)
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
public ParameterTabFolder createTabFolder()
- Specified by:
createTabFolder
in interfaceBasicPluginConfigModel
- Returns:
-
destroy
public void destroy()
- Specified by:
destroy
in interfacePluginConfigModel
-
setLocalizedName
public void setLocalizedName(java.lang.String name)
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
protected java.lang.String resolveKey(java.lang.String key)
-
-