Class BasicPluginConfigModelImpl

java.lang.Object

com.biglybt.pifimpl.local.ui.model.BasicPluginConfigModelImpl

All Implemented Interfaces:

BasicPluginConfigModel, PluginConfigModel

public class BasicPluginConfigModelImpl
extends Object
implements BasicPluginConfigModel

Field Summary

Fields

Modifier and Type	Field	Description
private PluginConfigImpl	configobj
private String	key_prefix
private ArrayList<Parameter>	parameters
private String	parent_section
private PluginInterface	pi
private String	section
private UIManagerImpl	ui_manager

Constructor Summary

Constructors

Constructor	Description
BasicPluginConfigModelImpl(UIManagerImpl _ui_manager, String _parent_section, String _section)

Method Summary

Modifier and Type	Method	Description
ActionParameter	addActionParameter2(String label_resource_name, String action_resource_name)	Adds an actionable UI widget, usually a displayed as button or a link
BooleanParameter	addBooleanParameter2(String key, String resource_name, boolean defaultValue)	Add a new Boolean Plugin Parameter to the Config Model.
ColorParameter	addColorParameter2(String key, String resource_name, int r, int g, int b)
DirectoryParameter	addDirectoryParameter2(String key, String resource_name, String defaultValue)
FileParameter	addFileParameter2(String key, String resource_name, String defaultValue)
FileParameter	addFileParameter2(String key, String resource_name, String defaultValue, String[] file_extensions)
FloatParameter	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 Model
HyperlinkParameter	addHyperlinkParameter2(String resource_name, String url_location)
InfoParameter	addInfoParameter2(String resource_name, String value)	Display a label and a value together.
IntListParameter	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 buttons
IntParameter	addIntParameter2(String key, String resource_name, int defaultValue)
IntParameter	addIntParameter2(String key, String resource_name, int defaultValue, int min_value, int max_value)
LabelParameter	addLabelParameter2(String resource_name)	Displays a single label.
LongParameter	addLongParameter2(String key, String resource_name, long defaultValue)
LongParameter	addLongParameter2(String key, String resource_name, long defaultValue, long min_value, long max_value)
PasswordParameter	addPasswordParameter2(String key, String resource_name, int encoding_type, byte[] defaultValue)
StringListParameter	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 box
StringListParameter	addStringListParameter2(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 box
StringParameter	addStringParameter2(String key, String resource_name, String defaultValue)	Add a new String Plugin Parameter to the Config Model
UITextArea	addTextArea(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, String resource_name)	Creates a UIParameter object to add to this config model object.
ParameterGroup	createGroup(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 config
String	getParentSection()
PluginInterface	getPluginInterface()
String	getSection()
protected 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).

Methods inherited from class Object

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

Field Details

ui_manager

private UIManagerImpl ui_manager

parent_section

private String parent_section

section

private String section

pi

private PluginInterface pi

parameters

private ArrayList<Parameter> parameters

key_prefix

private String key_prefix

configobj

private PluginConfigImpl configobj

Constructor Details

BasicPluginConfigModelImpl

public BasicPluginConfigModelImpl(UIManagerImpl _ui_manager,
 String _parent_section,
 String _section)

Method Details

getParentSection

public String getParentSection()

Specified by:

getParentSection in interface BasicPluginConfigModel

Returns:

getSection

public String getSection()

Specified by:

getSection in interface BasicPluginConfigModel

Returns:

getPluginInterface

public PluginInterface getPluginInterface()

Specified by:

getPluginInterface in interface PluginConfigModel

getParameters

public Parameter[] getParameters()

Description copied from interface: BasicPluginConfigModel

Retrieve all the parameters added to this plugin config

Specified by:

getParameters in interface BasicPluginConfigModel

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 interface BasicPluginConfigModel

Parameters:

key - Plugin config key

resource_name - Label resource key

addStringParameter2

public StringParameter addStringParameter2(String key,
 String resource_name,
 String defaultValue)

Description copied from interface: BasicPluginConfigModel

Add a new String Plugin Parameter to the Config Model

Specified by:

addStringParameter2 in interface BasicPluginConfigModel

Parameters:

key - Plugin config key

resource_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 interface BasicPluginConfigModel

Parameters:

key - Plugin config key

resource_name - Label resource key

values - 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 interface BasicPluginConfigModel

Parameters:

key - Plugin config key

resource_name - Label resource key

labels - 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 interface BasicPluginConfigModel

Parameters:

key - Plugin config key

resource_name - Label resource key

labels - 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 interface BasicPluginConfigModel

Parameters:

key - Plugin config key

resource_name - Label resource key

addPasswordParameter2

public PasswordParameter addPasswordParameter2(String key,
 String resource_name,
 int encoding_type,
 byte[] defaultValue)

Specified by:

addPasswordParameter2 in interface BasicPluginConfigModel

Parameters:

key -

resource_name -

encoding_type -

defaultValue -

Returns:

addIntParameter2

public IntParameter addIntParameter2(String key,
 String resource_name,
 int defaultValue)

Specified by:

addIntParameter2 in interface BasicPluginConfigModel

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 interface BasicPluginConfigModel

Parameters:

key -

resource_name -

defaultValue -

min_value - Minimum allowed value

max_value - Maximum allowed value

Returns:

addLongParameter2

public LongParameter addLongParameter2(String key,
 String resource_name,
 long defaultValue)

Specified by:

addLongParameter2 in interface BasicPluginConfigModel

addLongParameter2

public LongParameter addLongParameter2(String key,
 String resource_name,
 long defaultValue,
 long min_value,
 long max_value)

Specified by:

addLongParameter2 in interface BasicPluginConfigModel

addDirectoryParameter2

public DirectoryParameter addDirectoryParameter2(String key,
 String resource_name,
 String defaultValue)

Specified by:

addDirectoryParameter2 in interface BasicPluginConfigModel

Parameters:

key -

resource_name - MessageBundle key

defaultValue -

Returns:

addFileParameter2

public FileParameter addFileParameter2(String key,
 String resource_name,
 String defaultValue)

Specified by:

addFileParameter2 in interface BasicPluginConfigModel

Parameters:

key -

resource_name -

defaultValue -

Returns:

addFileParameter2

public FileParameter addFileParameter2(String key,
 String resource_name,
 String defaultValue,
 String[] file_extensions)

Specified by:

addFileParameter2 in interface BasicPluginConfigModel

Parameters:

key -

resource_name -

defaultValue -

file_extensions - Allowed list of file extensions.

Returns:

addLabelParameter2

public LabelParameter addLabelParameter2(String resource_name)

Description copied from interface: BasicPluginConfigModel

Displays a single label. Not linked to a config key.

Specified by:

addLabelParameter2 in interface BasicPluginConfigModel

Parameters:

resource_name - MessageBundle key

addInfoParameter2

public InfoParameter addInfoParameter2(String resource_name,
 String value)

Description copied from interface: BasicPluginConfigModel

Display a label and a value together. Not linked to a config key.

Specified by:

addInfoParameter2 in interface BasicPluginConfigModel

Parameters:

resource_name - MessageBundle key

value - String value

addHyperlinkParameter2

public HyperlinkParameter addHyperlinkParameter2(String resource_name,
 String url_location)

Specified by:

addHyperlinkParameter2 in interface BasicPluginConfigModel

addColorParameter2

public ColorParameter addColorParameter2(String key,
 String resource_name,
 int r,
 int g,
 int b)

Specified by:

addColorParameter2 in interface BasicPluginConfigModel

Parameters:

key -

resource_name -

r -

g -

b -

Returns:

addUIParameter2

public UIParameter addUIParameter2(UIParameterContext context,
 String resource_name)

Description copied from interface: BasicPluginConfigModel

Creates a UIParameter object to add to this config model object.

Specified by:

addUIParameter2 in interface BasicPluginConfigModel

Parameters:

resource_name - Not Used. null recommended.

addActionParameter2

public ActionParameter addActionParameter2(String label_resource_name,
 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 interface BasicPluginConfigModel

Parameters:

label_resource_name - Text before the button

action_resource_name - Button Text

addTextArea

public UITextArea addTextArea(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 interface BasicPluginConfigModel

createGroup

public ParameterGroup createGroup(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 interface BasicPluginConfigModel

createTabFolder

public ParameterTabFolder createTabFolder()

Specified by:

createTabFolder in interface BasicPluginConfigModel

Returns:

destroy

public void destroy()

Specified by:

destroy in interface PluginConfigModel

setLocalizedName

public void setLocalizedName(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 interface BasicPluginConfigModel

resolveKey

protected String resolveKey(String key)