Package com.motivewave.platform.sdk.common.desc

Class BooleanDescriptor

java.lang.Object

com.motivewave.platform.sdk.common.desc.SettingDescriptor<Boolean>

com.motivewave.platform.sdk.common.desc.BooleanDescriptor

public class BooleanDescriptor
extends SettingDescriptor<Boolean>

Describes a boolean setting

Constructor Summary

Constructors

Constructor	Description
BooleanDescriptor(String name, String label, Boolean defaultValue)	Constructor
BooleanDescriptor(String name, String label, Boolean defaultValue, boolean showLabel)	Constructor
BooleanDescriptor(String name, String label, Boolean defaultValue, boolean showLabel, int gridWidth)	Constructor

Method Summary

Modifier and Type	Method	Description
javafx.scene.Node	createInputFX(Settings settings, boolean readOnly)	Creates the component that will accept the user input.
Object	fromJson(Object json)
Boolean	getDefaultValue()	Gets the default value for this setting.

Methods inherited from class com.motivewave.platform.sdk.common.desc.SettingDescriptor

createInput, createTBInput, getDescription, getGridWidth, getHelpLink, getIconFactory, getId, getLabel, getName, isAllowUserDefaults, isDisplaySetting, isEnabled, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setDescription, setEnabled, setGridWidth, setHelpLink, setIconFactory, setShowLabel, setSupportsDisable

Methods inherited from class java.lang.Object

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

Constructor Details

BooleanDescriptor

public BooleanDescriptor(String name,
 String label,
 Boolean defaultValue)

Constructor

Parameters:

name - name of this setting (key)

label - label displayed to the user

defaultValue - default boolean value

BooleanDescriptor

public BooleanDescriptor(String name,
 String label,
 Boolean defaultValue,
 boolean showLabel)

Constructor

Parameters:

name - name of this setting (key)

label - label displayed to the user

defaultValue - default boolean value

showLabel - indicates if the label should be displayed

BooleanDescriptor

public BooleanDescriptor(String name,
 String label,
 Boolean defaultValue,
 boolean showLabel,
 int gridWidth)

Constructor

Parameters:

name - name of this setting (key)

label - label displayed to the user

defaultValue - default boolean value

showLabel - indicates if the label should be displayed

gridWidth - overrides the default grid width of 1

Method Details

getDefaultValue

public Boolean getDefaultValue()

Gets the default value for this setting.

Overrides:

getDefaultValue in class SettingDescriptor<Boolean>

Returns:

default value for the setting

createInputFX

public javafx.scene.Node createInputFX(Settings settings,
 boolean readOnly)

Description copied from class: SettingDescriptor

Creates the component that will accept the user input. This is called by the study framework.

Specified by:

createInputFX in class SettingDescriptor<Boolean>

Parameters:

settings - settings for the study

readOnly - true if the component should not accept user input

Returns:

component that will accept user input.

fromJson

public Object fromJson(Object json)

Overrides:

fromJson in class SettingDescriptor<Boolean>