Interface BasicPluginConfigModel

    • Method Detail

      • addBooleanParameter2

        BooleanParameter addBooleanParameter2​(java.lang.String key,
                                              java.lang.String resource_name,
                                              boolean defaultValue)
        Add a new Boolean Plugin Parameter to the Config Model.
        Typically shown as a checkbox
        Parameters:
        key - Plugin config key
        resource_name - Label resource key
        Since:
        Azureus 2.1.0.2
      • addStringParameter2

        StringParameter addStringParameter2​(java.lang.String key,
                                            java.lang.String resource_name,
                                            java.lang.String defaultValue)
        Add a new String Plugin Parameter to the Config Model
        Parameters:
        key - Plugin config key
        resource_name - Label resource key
        Since:
        Azurues 2.1.0.2
      • addStringListParameter2

        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 box
        Parameters:
        key - Plugin config key
        resource_name - Label resource key
        values - List of available values
        Since:
        Azureus 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)
        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
        Parameters:
        key - Plugin config key
        resource_name - Label resource key
        labels - A list of localised message strings corresponding to each value.
        Since:
        Azureus 2.3.0.6
      • addIntListParameter2

        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 buttons
        Parameters:
        key - Plugin config key
        resource_name - Label resource key
        labels - A list of localised message strings corresponding to each value.
        Since:
        BiglyBT 1.7.0.1
      • addFloatParameter2

        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 Model
        Parameters:
        key - Plugin config key
        resource_name - Label resource key
        Since:
        BiglyBT 1.7.0.1
      • 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)
        Displays a single label. Not linked to a config key.
        Parameters:
        resource_name - MessageBundle key
        Since:
        Azureus 2.1.0.2
      • addInfoParameter2

        InfoParameter addInfoParameter2​(java.lang.String resource_name,
                                        java.lang.String value)
        Display a label and a value together. Not linked to a config key.
        Parameters:
        resource_name - MessageBundle key
        value - String value
        Since:
        Vuze 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 - MessageBundle key
        defaultValue -
        Returns:
        Since:
        Azureus 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)
        Adds an actionable UI widget, usually a displayed as button or a link
        Parameters:
        label_resource_name - Text before the button
        action_resource_name - Button Text
        Since:
        Azureus 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 resource_name)
        Creates a UIParameter object to add to this config model object.
        Parameters:
        resource_name - Not Used. null recommended.
        Since:
        Vuze 3.0.5.3
      • addTextArea

        UITextArea 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.
      • createGroup

        ParameterGroup createGroup​(java.lang.String resource_name,
                                   Parameter... parameters)
        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.
        Since:
        Azureus 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