com.motivewave.platform.sdk.common.desc

Class IndicatorDescriptor

java.lang.Object

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

com.motivewave.platform.sdk.common.desc.IndicatorDescriptor

public class IndicatorDescriptor
extends SettingDescriptor

Describes an indicator that is displayed on the axis.

Constructor Summary

Constructors

Constructor and Description
IndicatorDescriptor(java.lang.String name, java.lang.String label, java.awt.Color bgColor, java.awt.Color txtColor, boolean showLine, 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	getBackgroundColor() Gets the default background color.
IndicatorInfo	getDefaultValue() Gets the default value as an Indicator Info
java.awt.Color	getTextColor() Gets the default text color.
boolean	isDisplaySetting() Indicates if this setting is used to affect the appearance of the of the study/strategy
boolean	isShowLine() Gets the default show line attribute.

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

IndicatorDescriptor

public IndicatorDescriptor(java.lang.String name,
                   java.lang.String label,
                   java.awt.Color bgColor,
                   java.awt.Color txtColor,
                   boolean showLine,
                   boolean enabled,
                   boolean supportsDisable)

Constructor

Parameters:

name - name of this setting

label - label displayed to the user

bgColor - default background color for the indicator

txtColor - default text color of the indicator

showLine - indicates if the line is shown by default

enabled - indicates if the indicator is enabled by default

supportsDisable - indicates if the user can disable the indicator

Method Detail

getDefaultValue

public IndicatorInfo getDefaultValue()

Gets the default value as an Indicator Info

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.

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

getBackgroundColor

public java.awt.Color getBackgroundColor()

Gets the default background color.

getTextColor

public java.awt.Color getTextColor()

Gets the default text color.

isShowLine

public boolean isShowLine()

Gets the default show line attribute.