Interface SettingsPanelSetting

public interface SettingsPanelSetting
Represents an entry within a Settings panel.

  • Method Details

    • integerSetting

      static SettingsPanelSetting integerSetting(String name)
      Used to build a text field that only accepts integer values.
      Parameters:
      name - the name used to access the associated data via SettingsPanelWithData.
      Returns:
      the SettingsPanelSetting.

    • integerSetting

      static SettingsPanelSetting integerSetting(String name, int defaultValue)
      Used to build a text field that only accepts integer values and has an initial value. If a value with the same name has been previously persisted value then this will be used instead of the default value.
      Parameters:
      name - the name used to access the associated data via SettingsPanelWithData.
      defaultValue - the initial value.
      Returns:
      the SettingsPanelSetting.

    • integerSetting

      static SettingsPanelSetting integerSetting(String description, String name)
      Used to build a text field with a description that only accepts integer values.
      Parameters:
      description - the description displayed for this setting.
      name - the name used to access the associated data via SettingsPanelWithData.
      Returns:
      the SettingsPanelSetting.

    • integerSetting

      static SettingsPanelSetting integerSetting(String description, String name, int defaultValue)
      Used to build a text field with a description that only accepts integer values and has an initial value. If a value with the same name has been previously persisted value then this will be used instead of the default value.
      Parameters:
      description - the description displayed for this setting.
      name - the name used to access the associated data via SettingsPanelWithData.
      defaultValue - the initial value.
      Returns:
      the SettingsPanelSetting.

    • booleanSetting

      static SettingsPanelSetting booleanSetting(String name)
      Used to build a checkbox.
      Parameters:
      name - the name used to access the associated data via SettingsPanelWithData.
      Returns:
      the SettingsPanelSetting.

    • booleanSetting

      static SettingsPanelSetting booleanSetting(String name, boolean defaultValue)
      Used to a checkbox that is set via an initial selection state. If a value with the same name has been previously persisted state then this will be used instead of the default state.
      Parameters:
      name - the name used to access the associated data via SettingsPanelWithData.
      defaultValue - the initial value.
      Returns:
      the SettingsPanelSetting.

    • booleanSetting

      static SettingsPanelSetting booleanSetting(String description, String name)
      Used to build a checkbox with a description.
      Parameters:
      description - the description displayed for this setting.
      name - the name used to access the associated data via SettingsPanelWithData.
      Returns:
      the SettingsPanelSetting.

    • booleanSetting

      static SettingsPanelSetting booleanSetting(String description, String name, boolean defaultValue)
      Used to build a checkbox with a description that is set via an initial selection state. If a value with the same name has been previously persisted state then this will be used instead of the default state.
      Parameters:
      description - the description displayed for this setting.
      name - the name used to access the associated data via SettingsPanelWithData.
      defaultValue - the initial value.
      Returns:
      the SettingsPanelSetting.

    • stringSetting

      static SettingsPanelSetting stringSetting(String name)
      Used to build a text field.
      Parameters:
      name - the name used to access the associated data via SettingsPanelWithData.
      Returns:
      the SettingsPanelSetting.

    • stringSetting

      static SettingsPanelSetting stringSetting(String name, String defaultValue)
      Used to build a text field that has an initial value. If a value with the same name has been previously persisted value then this will be used instead of the default value.
      Parameters:
      name - the name used to access the associated data via SettingsPanelWithData.
      defaultValue - the initial value.
      Returns:
      the SettingsPanelSetting.

    • stringSetting

      static SettingsPanelSetting stringSetting(String description, String name, String defaultValue)
      Used to build a text field with a description that has an initial value. If a value with the same name has been previously persisted value then this will be used instead of the default value.
      Parameters:
      description - the description displayed for this setting.
      name - the name used to access the associated data via SettingsPanelWithData.
      defaultValue - the initial value.
      Returns:
      the SettingsPanelSetting.

    • listSetting

      static SettingsPanelSetting listSetting(String name, String... values)
      Used to build a combo box.
      Parameters:
      name - the name used to access the associated data via SettingsPanelWithData.
      values - the values to use within the combo box.
      Returns:
      the SettingsPanelSetting.

    • listSetting

      static SettingsPanelSetting listSetting(String name, List<String> values, String defaultValue)
      Used to build a combo box that has a specific initial value selected. If a value with the same name has been previously persisted value then this will be used instead of the default value.
      Parameters:
      name - the name used to access the associated data via SettingsPanelWithData.
      values - the values to use within the combo box.
      defaultValue - the initial value.
      Returns:
      the SettingsPanelSetting.

    • listSetting

      static SettingsPanelSetting listSetting(String description, String name, List<String> values, String defaultValue)
      Used to build a combo box with a description that has a specific initial value selected. If a value with the same name has been previously persisted value then this will be used instead of the default value.
      Parameters:
      description - the description displayed for this setting.
      name - the name used to access the associated data via SettingsPanelWithData.
      values - the values to use within the combo box.
      defaultValue - the initial value.
      Returns:
      the SettingsPanelSetting.