com.motivewave.platform.sdk.common.desc

Class DoubleDescriptor

java.lang.Object

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

com.motivewave.platform.sdk.common.desc.DoubleDescriptor

public class DoubleDescriptor
extends SettingDescriptor

Describes a double value that is part of the study/strategy settings. These values may be given a minimum, maximum and step value.

Constructor Summary

Constructors

Constructor and Description
DoubleDescriptor(java.lang.String name, java.lang.String label, double defaultValue, double minValue, double maxValue, double step) 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.Double	getDefaultValue() Gets the default value as a double.
double	getMaxValue() Gets the maximum allowable value.
double	getMinValue() Gets the minimum allowable value.
double	getStep() Gets the incremental step.

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

DoubleDescriptor

public DoubleDescriptor(java.lang.String name,
                java.lang.String label,
                double defaultValue,
                double minValue,
                double maxValue,
                double step)

Constructor

Parameters:

name - name of this setting (key)

label - label displayed to the user

defaultValue - default double value

minValue - minimum double value

maxValue - maximum double value

step - step increment

Method Detail

getDefaultValue

public java.lang.Double getDefaultValue()

Gets the default value as a double.

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.

getMinValue

public double getMinValue()

Gets the minimum allowable value.

getMaxValue

public double getMaxValue()

Gets the maximum allowable value.

getStep

public double getStep()

Gets the incremental step.