Class BarDescriptor

java.lang.Object

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

com.motivewave.platform.sdk.common.desc.BarDescriptor

public class BarDescriptor
extends SettingDescriptor<BarInfo>

Describes a vertical bar.

Constructor Summary

Constructors

Constructor	Description
BarDescriptor(String name, String label, Color color, boolean enabled, boolean supportsDisable)	Constructor.
BarDescriptor(String name, String label, Color color, Integer fixedWidth, boolean enabled, boolean supportsDisable)	Constructor.

Method Summary

Modifier and Type	Method	Description
javafx.scene.Node	createControl(SettingsBase settings, boolean readOnly)	Creates the component that will accept the user input.
Object	fromJson(Object json)
Color	getColor()	Gets the default color of the bar.
BarInfo	getDefaultValue()	Gets the default value for this setting.
Integer	getFixedWidth()	Gets the fixed width of the bar.
boolean	isDisplaySetting()	Indicates if this setting is used to affect the appearance of the of the study/strategy

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

createInput, createInputFX, createTBInput, createTBInput, getDescription, getGridWidth, getHelpLink, getIconFactory, getId, getLabel, getName, getPostLabel, isAllowUserDefaults, isEnabled, isReadOnly, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setDescription, setEnabled, setGridWidth, setHelpLink, setIconFactory, setPostLabel, setReadOnly, setShowLabel, setSupportsDisable

Methods inherited from class java.lang.Object

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

Constructor Details

BarDescriptor

public BarDescriptor(String name,
 String label,
 Color color,
 boolean enabled,
 boolean supportsDisable)

Constructor.

Parameters:

name - name of this setting (key)

label - label displayed to the user

color - default color of the bar

enabled - default enabled state

supportsDisable - indicates if the user can disable this setting

BarDescriptor

public BarDescriptor(String name,
 String label,
 Color color,
 Integer fixedWidth,
 boolean enabled,
 boolean supportsDisable)

Constructor.

Parameters:

name - name of this setting (key)

label - label displayed to the user

color - default color of the bar

fixedWidth - fixed width of the bar (null for dynamic size)

enabled - default enabled state

supportsDisable - indicates if the user can disable this setting

Method Details

getDefaultValue

public BarInfo getDefaultValue()

Gets the default value for this setting.

Overrides:

getDefaultValue in class SettingDescriptor<BarInfo>

Returns:

default value for the setting

isDisplaySetting

public boolean isDisplaySetting()

Description copied from class: SettingDescriptor

Indicates if this setting is used to affect the appearance of the of the study/strategy

Overrides:

isDisplaySetting in class SettingDescriptor<BarInfo>

Returns:

true if this setting affects the appearance of the study/strategy

createControl

public javafx.scene.Node createControl(SettingsBase settings,
 boolean readOnly)

Description copied from class: SettingDescriptor

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

Overrides:

createControl in class SettingDescriptor<BarInfo>

Parameters:

settings - settings for the study

readOnly - true if the component should not accept user input

Returns:

component that will accept user input.

getColor

public Color getColor()

Gets the default color of the bar.

getFixedWidth

public Integer getFixedWidth()

Gets the fixed width of the bar.

fromJson

public Object fromJson(Object json)

Overrides:

fromJson in class SettingDescriptor<BarInfo>