com.motivewave.platform.sdk.common.desc

Class InstrumentDescriptor

java.lang.Object

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

com.motivewave.platform.sdk.common.desc.InstrumentDescriptor

public class InstrumentDescriptor
extends SettingDescriptor

Describes an input for selecting an instrument that is part of the study/strategy. Please Note: you must declare 'multipleInstrument=true' in the study header in order for data to be returned at runtime.

Constructor Summary

Constructors

Constructor and Description
InstrumentDescriptor(java.lang.String name, java.lang.String label) 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.

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

getDefaultValue, 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

InstrumentDescriptor

public InstrumentDescriptor(java.lang.String name,
                    java.lang.String label)

Constructor.

Parameters:

name - name of this setting (key)

label - label displayed to the user

Method Detail

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.