Package com.biomatters.geneious.publicapi.plugin

Class GeneiousPreferences.GeneiousCheckBoxPreference

java.lang.Object

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

com.biomatters.geneious.publicapi.plugin.GeneiousPreferences.GeneiousCheckBoxPreference

Enclosing interface:

GeneiousPreferences

public static final class GeneiousPreferences.GeneiousCheckBoxPreference
extends GeneiousPreferences.GeneiousPreference

A preference for specifying a yes/no (on/off) choice.

Displayed to the user as a check box.

Constructor Summary

Constructors

Constructor	Description
GeneiousCheckBoxPreference(java.lang.String code, java.lang.String name, boolean defaultValue)

Method Summary

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

Constructor Detail

GeneiousCheckBoxPreference

public GeneiousCheckBoxPreference(java.lang.String code,
                                  java.lang.String name,
                                  boolean defaultValue)

Parameters:

code - GeneiousPreferences.GeneiousPreference.code

name - GeneiousPreferences.GeneiousPreference.name

defaultValue - value for this preference. This is used when the user has not previously set a value for this preference. The associated CheckBox will be in this selection state in that case.

Method Detail

getCurrentValue

public boolean getCurrentValue()

Returns:

the current value of this preference

setCurrentValue

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