com.motivewave.platform.sdk.common.desc

Class BarDescriptor

java.lang.Object

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

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

public class BarDescriptor
extends SettingDescriptor

Describes a vertical bar.

Constructor Summary

Constructors

Constructor and Description
BarDescriptor(java.lang.String name, java.lang.String label, java.awt.Color color, boolean enabled, boolean supportsDisable) Constructor.
BarDescriptor(java.lang.String name, java.lang.String label, java.awt.Color color, java.lang.Integer fixedWidth, boolean enabled, boolean supportsDisable) 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.awt.Color	getColor() Gets the default color of the bar.
BarInfo	getDefaultValue() Gets the default value as a BarInfo.
java.lang.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

getGridWidth, getLabel, getName, isAllowUserDefaults, 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

BarDescriptor

public BarDescriptor(java.lang.String name,
             java.lang.String label,
             java.awt.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(java.lang.String name,
             java.lang.String label,
             java.awt.Color color,
             java.lang.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 Detail

getDefaultValue

public BarInfo getDefaultValue()

Gets the default value as a BarInfo.

Overrides:

getDefaultValue in class SettingDescriptor

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

Returns:

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

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.

getColor

public java.awt.Color getColor()

Gets the default color of the bar.

getFixedWidth

public java.lang.Integer getFixedWidth()

Gets the fixed width of the bar.