com.motivewave.platform.sdk.common.desc

Class ShadeDescriptor

java.lang.Object

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

com.motivewave.platform.sdk.common.desc.ShadeDescriptor

public class ShadeDescriptor
extends SettingDescriptor

Describes information to shade an area between two lines/paths.

Constructor Summary

Constructors

Constructor and Description
ShadeDescriptor(java.lang.String name, java.lang.String label, java.lang.String lineKey1, double value, Enums.ShadeType type, java.awt.Color color) Constructor.
ShadeDescriptor(java.lang.String name, java.lang.String label, java.lang.String lineKey1, double value, Enums.ShadeType type, java.awt.Color color, boolean enabled, boolean supportsDisable) Constructor
ShadeDescriptor(java.lang.String name, java.lang.String label, java.lang.String lineKey1, java.lang.String lineKey2, Enums.ShadeType type, java.awt.Color color) Constructor.
ShadeDescriptor(java.lang.String name, java.lang.String label, java.lang.String lineKey1, java.lang.String lineKey2, Enums.ShadeType type, java.awt.Color color, 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 for the shade.
ShadeInfo	getDefaultValue() Gets the default value as a ShadeInfo
java.lang.String	getLineKey1() Gets the setting key for the first line.
java.lang.String	getLineKey2() Gets the setting key for the first line.
Enums.ShadeType	getShadeType() Gets the type of shade to apply.
double	getValue() Gets the absolute value to shade above or below.
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

ShadeDescriptor

public ShadeDescriptor(java.lang.String name,
               java.lang.String label,
               java.lang.String lineKey1,
               java.lang.String lineKey2,
               Enums.ShadeType type,
               java.awt.Color color)

Constructor.

Parameters:

name -

label -

lineKey1 -

lineKey2 -

type -

color -

ShadeDescriptor

public ShadeDescriptor(java.lang.String name,
               java.lang.String label,
               java.lang.String lineKey1,
               double value,
               Enums.ShadeType type,
               java.awt.Color color)

Constructor.

Parameters:

name -

label -

lineKey1 -

value -

type -

color -

ShadeDescriptor

public ShadeDescriptor(java.lang.String name,
               java.lang.String label,
               java.lang.String lineKey1,
               java.lang.String lineKey2,
               Enums.ShadeType type,
               java.awt.Color color,
               boolean enabled,
               boolean supportsDisable)

Constructor

Parameters:

name -

label -

lineKey1 -

lineKey2 -

type -

color -

enabled -

supportsDisable -

ShadeDescriptor

public ShadeDescriptor(java.lang.String name,
               java.lang.String label,
               java.lang.String lineKey1,
               double value,
               Enums.ShadeType type,
               java.awt.Color color,
               boolean enabled,
               boolean supportsDisable)

Constructor

Parameters:

name -

label -

lineKey1 -

value -

type -

color -

enabled -

supportsDisable -

Method Detail

getDefaultValue

public ShadeInfo getDefaultValue()

Gets the default value as a ShadeInfo

Overrides:

getDefaultValue in class SettingDescriptor

Returns:

default value for the setting

getColor

public java.awt.Color getColor()

Gets the default color for the shade.

getLineKey1

public java.lang.String getLineKey1()

Gets the setting key for the first line.

getLineKey2

public java.lang.String getLineKey2()

Gets the setting key for the first line.

getShadeType

public Enums.ShadeType getShadeType()

Gets the type of shade to apply.

getValue

public double getValue()

Gets the absolute value to shade above or below.

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.