com.motivewave.platform.sdk.common.desc

Class BooleanDescriptor

java.lang.Object

com.motivewave.platform.sdk.common.desc.SettingDescriptor

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

public class BooleanDescriptor
extends SettingDescriptor

Describes a boolean setting

Constructor Summary

Constructors

Constructor and Description
BooleanDescriptor(java.lang.String name, java.lang.String label, java.lang.Boolean defaultValue) Constructor
BooleanDescriptor(java.lang.String name, java.lang.String label, java.lang.Boolean defaultValue, boolean showLabel) Constructor
BooleanDescriptor(java.lang.String name, java.lang.String label, java.lang.Boolean defaultValue, boolean showLabel, int gridWidth) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JComponent	createInput(Settings settings, boolean readOnly) Creates the component that will accept the user input.
java.lang.Boolean	getDefaultValue() Gets the default value as a Boolean value.

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

getGridWidth, getLabel, getName, isAllowUserDefaults, isDisplaySetting, isEnabled, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setEnabled, setGridWidth, setShowLabel, setSupportsDisable

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanDescriptor

public BooleanDescriptor(java.lang.String name,
                 java.lang.String label,
                 java.lang.Boolean defaultValue)

Constructor

Parameters:

name - name of this setting (key)

label - label displayed to the user

defaultValue - default boolean value

BooleanDescriptor

public BooleanDescriptor(java.lang.String name,
                 java.lang.String label,
                 java.lang.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(java.lang.String name,
                 java.lang.String label,
                 java.lang.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 Detail

getDefaultValue

public java.lang.Boolean getDefaultValue()

Gets the default value as a Boolean value.

Overrides:

getDefaultValue in class SettingDescriptor

Returns:

default value for the setting

createInput

public javax.swing.JComponent createInput(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:

createInput in class SettingDescriptor

Parameters:

settings - settings for the study

readOnly - true if the component should not accept user input

Returns:

component that will accept user input.