com.motivewave.platform.sdk.common.desc

Class IntegerDescriptor

java.lang.Object

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

com.motivewave.platform.sdk.common.desc.IntegerDescriptor

public class IntegerDescriptor
extends SettingDescriptor

Describes an integer value that is used to configure a study/strategy.

Constructor Summary

Constructors

Constructor and Description
IntegerDescriptor(java.lang.String name, java.lang.String label, int defaultValue, int minValue, int maxValue, int 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.Integer	getDefaultValue() Gets the default value as an Integer.
int	getMaxValue() Gets the maximum value for the setting.
int	getMinValue() Gets the minimum value for the setting.
int	getStep() Gets the step increment 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

IntegerDescriptor

public IntegerDescriptor(java.lang.String name,
                 java.lang.String label,
                 int defaultValue,
                 int minValue,
                 int maxValue,
                 int step)

Constructor.

Parameters:

name - name of this setting (key)

label - label displayed to the user

defaultValue - default integer value

minValue - minimum integer value

maxValue - maximum integer value

step - step increment

Method Detail

getDefaultValue

public java.lang.Integer getDefaultValue()

Gets the default value as an Integer.

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 int getMinValue()

Gets the minimum value for the setting.

getMaxValue

public int getMaxValue()

Gets the maximum value for the setting.

getStep

public int getStep()

Gets the step increment value.