com.biomatters.geneious.publicapi.plugin

Class GeneiousPreferences.GeneiousRadioButtonPreference

java.lang.Object

com.biomatters.geneious.publicapi.plugin.GeneiousPreferences.GeneiousPreference

com.biomatters.geneious.publicapi.plugin.GeneiousPreferences.GeneiousRadioButtonPreference

Enclosing interface:

GeneiousPreferences

public static final class GeneiousPreferences.GeneiousRadioButtonPreference
extends GeneiousPreferences.GeneiousPreference

A preference for specifying one of a small set of possible values.

Displayed to the user as a set of radio buttons.

Field Summary

Fields

Modifier and Type	Field and Description
List<String>	values A list of values, each of which will be displayed as a RadioButton in a set of RadioButtons.

Constructor Summary

Constructors

Constructor and Description
GeneiousPreferences.GeneiousRadioButtonPreference(String code, String name, String[] values, String defaultValue)

Method Summary

Methods

Modifier and Type	Method and Description
String	getCurrentValue()
void	setCurrentValue(String currentValue) This change will be reflected in the preference dialog of the program.

Methods inherited from class com.biomatters.geneious.publicapi.plugin.GeneiousPreferences.GeneiousPreference

addChangelistener, getCode, getName, isProOnly, removeChangeListener, setProOnly

Methods inherited from class java.lang.Object

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

Field Detail

values

public final List<String> values

A list of values, each of which will be displayed as a RadioButton in a set of RadioButtons. These values should be mutually exclusive as only one can be selected.

Constructor Detail

GeneiousPreferences.GeneiousRadioButtonPreference

public GeneiousPreferences.GeneiousRadioButtonPreference(String code,
                                                 String name,
                                                 String[] values,
                                                 String defaultValue)

Parameters:

code - GeneiousPreferences.GeneiousPreference.code

name - GeneiousPreferences.GeneiousPreference.name

values - possible for this preference values

defaultValue - default value for this preference. This is used when the user has not previously set a value for this preference. The RadioButton representing the default value will be selected in that case.

Method Detail

getCurrentValue

public String getCurrentValue()

Returns:

the current value of this preference

setCurrentValue

public void setCurrentValue(String currentValue)

This change will be reflected in the preference dialog of the program. Use this if a plugin changes its own preferences independently of the preferences dialog in the program.

Parameters:

currentValue - the current value of this preference.