org.gudy.azureus2.plugins.ui.model
Interface BasicPluginConfigModel

All Superinterfaces:
PluginConfigModel
All Known Implementing Classes:
BasicPluginConfigModelImpl

public interface BasicPluginConfigModel
extends PluginConfigModel

This object represents a configuration section.

If you specify "_blank" as a resource name (the label for the parameter), (or use the BLANK_RESOURCE constant defined here), then this will be a blank label (available since 3.0.5.3).


Field Summary
static java.lang.String BLANK_RESOURCE
           
 
Method Summary
 ActionParameter addActionParameter2(java.lang.String label_resource_name, java.lang.String action_resource_name)
           
 void addBooleanParameter(java.lang.String key, java.lang.String resource_name, boolean defaultValue)
          Deprecated. use addBooleanParameter2
 BooleanParameter addBooleanParameter2(java.lang.String key, java.lang.String resource_name, boolean defaultValue)
           
 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)
           
 HyperlinkParameter addHyperlinkParameter2(java.lang.String resource_name, java.lang.String url_location)
           
 InfoParameter addInfoParameter2(java.lang.String resource_name, java.lang.String value)
           
 IntParameter 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)
           
 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)
           
 StringListParameter addStringListParameter2(java.lang.String key, java.lang.String resource_name, java.lang.String[] values, java.lang.String[] labels, java.lang.String defaultValue)
           
 void addStringParameter(java.lang.String key, java.lang.String resource_name, java.lang.String defaultValue)
          Deprecated. user addStringParameter2
 StringParameter addStringParameter2(java.lang.String key, java.lang.String resource_name, java.lang.String defaultValue)
           
 UITextArea addTextArea(java.lang.String resource_name)
           
 UIParameter addUIParameter2(UIParameterContext context, java.lang.String name)
          Creates a UIParameter object to add to this config model object.
 ParameterGroup createGroup(java.lang.String resource_name, Parameter[] parameters)
           
 ParameterTabFolder createTabFolder()
           
 Parameter[] getParameters()
          Retrieve all the parameters added to this plugin config
 java.lang.String getParentSection()
           
 java.lang.String getSection()
           
 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).
 
Methods inherited from interface org.gudy.azureus2.plugins.ui.model.PluginConfigModel
destroy, getPluginInterface
 

Field Detail

BLANK_RESOURCE

static final java.lang.String BLANK_RESOURCE
Since:
3.0.5.3
See Also:
Constant Field Values
Method Detail

addBooleanParameter

void addBooleanParameter(java.lang.String key,
                         java.lang.String resource_name,
                         boolean defaultValue)
Deprecated. use addBooleanParameter2

Parameters:
key -
resource_name -
defaultValue -
Since:
2.1.0.0

addStringParameter

void addStringParameter(java.lang.String key,
                        java.lang.String resource_name,
                        java.lang.String defaultValue)
Deprecated. user addStringParameter2

Parameters:
key -
resource_name -
defaultValue -
Since:
2.1.0.0

addBooleanParameter2

BooleanParameter addBooleanParameter2(java.lang.String key,
                                      java.lang.String resource_name,
                                      boolean defaultValue)
Parameters:
key -
resource_name -
defaultValue -
Returns:
Since:
2.1.0.2

addStringParameter2

StringParameter addStringParameter2(java.lang.String key,
                                    java.lang.String resource_name,
                                    java.lang.String defaultValue)
Parameters:
key -
resource_name -
defaultValue -
Returns:
Since:
2.1.0.2

addStringListParameter2

StringListParameter addStringListParameter2(java.lang.String key,
                                            java.lang.String resource_name,
                                            java.lang.String[] values,
                                            java.lang.String defaultValue)
Parameters:
key -
resource_name -
values -
defaultValue -
Returns:
Since:
2.1.0.2

addStringListParameter2

StringListParameter addStringListParameter2(java.lang.String key,
                                            java.lang.String resource_name,
                                            java.lang.String[] values,
                                            java.lang.String[] labels,
                                            java.lang.String defaultValue)
Parameters:
key -
resource_name -
values -
labels - A list of localised message strings corresponding to each value.
defaultValue -
Returns:
Since:
2.3.0.6

addPasswordParameter2

PasswordParameter addPasswordParameter2(java.lang.String key,
                                        java.lang.String resource_name,
                                        int encoding_type,
                                        byte[] defaultValue)
Parameters:
key -
resource_name -
encoding_type -
defaultValue -
Returns:
Since:
2.1.0.2

addIntParameter2

IntParameter addIntParameter2(java.lang.String key,
                              java.lang.String resource_name,
                              int defaultValue)
Parameters:
key -
resource_name -
defaultValue -
Returns:
Since:
2.1.0.2

addIntParameter2

IntParameter addIntParameter2(java.lang.String key,
                              java.lang.String resource_name,
                              int defaultValue,
                              int min_value,
                              int max_value)
Parameters:
key -
resource_name -
defaultValue -
min_value - Minimum allowed value
max_value - Maximum allowed value
Returns:
Since:
3.0.3.5

addLabelParameter2

LabelParameter addLabelParameter2(java.lang.String resource_name)
Parameters:
resource_name -
Returns:
Since:
2.1.0.2

addInfoParameter2

InfoParameter addInfoParameter2(java.lang.String resource_name,
                                java.lang.String value)
Parameters:
resource_name -
value -
Returns:
Since:
4005

addHyperlinkParameter2

HyperlinkParameter addHyperlinkParameter2(java.lang.String resource_name,
                                          java.lang.String url_location)
Since:
2.5.0.2

addDirectoryParameter2

DirectoryParameter addDirectoryParameter2(java.lang.String key,
                                          java.lang.String resource_name,
                                          java.lang.String defaultValue)
Parameters:
key -
resource_name -
defaultValue -
Returns:
Since:
2.1.0.2

addFileParameter2

FileParameter addFileParameter2(java.lang.String key,
                                java.lang.String resource_name,
                                java.lang.String defaultValue)
Parameters:
key -
resource_name -
defaultValue -
Returns:
Since:
2.5.0.1

addFileParameter2

FileParameter addFileParameter2(java.lang.String key,
                                java.lang.String resource_name,
                                java.lang.String defaultValue,
                                java.lang.String[] file_extensions)
Parameters:
key -
resource_name -
defaultValue -
file_extensions - Allowed list of file extensions.
Returns:
Since:
2.5.0.1

addActionParameter2

ActionParameter addActionParameter2(java.lang.String label_resource_name,
                                    java.lang.String action_resource_name)
Parameters:
label_resource_name -
action_resource_name -
Returns:
Since:
2.1.0.2

addColorParameter2

ColorParameter addColorParameter2(java.lang.String key,
                                  java.lang.String resource_name,
                                  int r,
                                  int g,
                                  int b)
Parameters:
key -
resource_name -
r -
g -
b -
Returns:
Since:
3.0.3.5

addUIParameter2

UIParameter addUIParameter2(UIParameterContext context,
                            java.lang.String name)
Creates a UIParameter object to add to this config model object.

Since:
3.0.5.3

addTextArea

UITextArea addTextArea(java.lang.String resource_name)

createGroup

ParameterGroup createGroup(java.lang.String resource_name,
                           Parameter[] parameters)
Parameters:
resource_name -
parameters -
Returns:
Since:
2.3.0.0

createTabFolder

ParameterTabFolder createTabFolder()
Parameters:
resource_name -
Returns:
Since:
5601

getSection

java.lang.String getSection()
Returns:
Since:
2.3.0.5

getParentSection

java.lang.String getParentSection()
Returns:
Since:
2.3.0.5

getParameters

Parameter[] getParameters()
Retrieve all the parameters added to this plugin config

Returns:
parameter list
Since:
2.3.0.5

setLocalizedName

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).

Since:
3.0.5.3