com.biomatters.geneious.publicapi.plugin

Class GeneiousPreferences.GeneiousComboBoxPreference

java.lang.Object

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

com.biomatters.geneious.publicapi.plugin.GeneiousPreferences.GeneiousComboBoxPreference

Enclosing interface:

GeneiousPreferences

public static final class GeneiousPreferences.GeneiousComboBoxPreference
extends GeneiousPreferences.GeneiousPreference

A preference for specifying one of a set of values.

Displayed to the user as a combo box.

Field Summary

Fields

Modifier and Type	Field and Description
List<Object>	values A list of values, each of which will be displayed as an item in a combo box.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Object	getCurrentValue()
void	setCurrentValue(Object 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<Object> values

A list of values, each of which will be displayed as an item in a combo box. These values should be mutually exclusive as only one can be selected.

Constructor Detail

GeneiousPreferences.GeneiousComboBoxPreference

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

Parameters:

code - GeneiousPreferences.GeneiousPreference.code

name - GeneiousPreferences.GeneiousPreference.name

values - the possible values for this preference values

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

Method Detail

getCurrentValue

public Object getCurrentValue()

Returns:

the current value of this preference

setCurrentValue

public void setCurrentValue(Object 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.