public class Layer1ApiUserMessageModifyIndicator extends java.lang.Object implements Layer1ApiStrategiesEchoMessagesLayer.StrategyEchoMessageFromLayer
fullName
. This is a name that will be used to adress
your indicator by any external parts (for example online indicator calculations). This name will be unique trough all indicators
unless you initialize indicators with same owner class and same user name.
This filed will be initialized in message constructor and can be access afterModifier and Type | Class and Description |
---|---|
static class |
Layer1ApiUserMessageModifyIndicator.Builder
Builder to build
Layer1ApiUserMessageModifyIndicator . |
static class |
Layer1ApiUserMessageModifyIndicator.GraphType |
static class |
Layer1ApiUserMessageModifyIndicator.LayerRenderPriority |
Modifier and Type | Field and Description |
---|---|
AliasFilter |
aliasFilter |
BoundsInfo |
boundsInfo |
Layer1IndicatorColorInterface |
colorInterface
This will be used to set / get colors described by
indicatorColorScheme If null, colors will be attempted to retrieve via internal color storage by names provided by indicatorColorScheme |
java.awt.Color |
defaultTooltipBackgrondColor |
java.awt.Color |
defaultTooltipTextColor |
java.lang.String |
fullName
This is a unique indicator name, that will be used to address this indicator from any external part
Do not change this field Use applyNameModifier(String) if you need to generate different full names for same user names |
private static int |
GRAPH_LAYER_RENDER_PRIORITY_DEFAULT |
int |
graphLayerRenderPriority |
Layer1ApiUserMessageModifyIndicator.GraphType |
graphType
Strategies have few options of where graph is displayed, see
Layer1ApiUserMessageModifyIndicator.GraphType Default: Layer1ApiUserMessageModifyIndicator.GraphType.NONE |
HorizontalValueLinesInfo |
horizontalValueLinesInfo |
private static int |
ICON_LAYER_RENDER_PRIORITY_DEFAULT |
int |
iconLayerRanderPriotity |
IndicatorColorScheme |
indicatorColorScheme
Default color scheme has only one main color, named as strategy and used for every value
|
IndicatorContextMenuInformation |
indicatorContextMenuInformation |
IndicatorDisplayLogic |
indicatorDisplayLogic |
IndicatorLineStyle |
indicatorLineStyle
Line style used by indicator
|
java.lang.Double |
indicatorMaxMarginPriceOut |
java.lang.Double |
indicatorMinMarginPriceOut |
boolean |
isAdd |
boolean |
isEnableSettingsFromConfigPopup |
boolean |
isShowColorSettings |
boolean |
isSupportWidget
Some strategies may choose to NOT display themselves as widget
Default: true (widget supported)
|
boolean |
isWidgetEnabledByDefault |
java.lang.Double |
minLimitsRange |
OnlineCalculatable |
onlineCalculatable |
java.lang.String |
ownerClassName
Name of owner strategy class
|
java.lang.String |
ownerUserName
User friendly name of owner strategy class (if provided via
Layer1StrategyName ) |
java.lang.String |
userName
Name that will be visible to user i.e.
|
WidgetDisplayInfo |
widgetDisplayInfo |
Modifier | Constructor and Description |
---|---|
|
Layer1ApiUserMessageModifyIndicator(java.lang.Class<?> strategyClass,
java.lang.String userName,
boolean isAdd)
Note that you need to remember
fullName . |
|
Layer1ApiUserMessageModifyIndicator(java.lang.Class<?> strategyClass,
java.lang.String userName,
boolean isAdd,
IndicatorColorScheme indicatorColorScheme,
Layer1IndicatorColorInterface colorInterface,
IndicatorLineStyle indicatorLineStyle,
java.awt.Color defaultTooltipBackgrondColor,
java.awt.Color defaultTooltipTextColor,
IndicatorDisplayLogic indicatorDisplayLogic,
java.lang.Double indicatorMinMarginPriceOut,
java.lang.Double indicatorMaxMarginPriceOut,
java.lang.Double minLimitsRange,
BoundsInfo boundsInfo,
Layer1ApiUserMessageModifyIndicator.GraphType graphType,
java.lang.Boolean isSupportWidget,
java.lang.Boolean isShowColorSettings,
java.lang.Boolean isEnableSettingsFromConfigPopup,
OnlineCalculatable onlineCalculatable,
AliasFilter aliasFilter)
Note that you need to remember
fullName . |
private |
Layer1ApiUserMessageModifyIndicator(Layer1ApiUserMessageModifyIndicator.Builder builder) |
|
Layer1ApiUserMessageModifyIndicator(Layer1ApiUserMessageModifyIndicator message) |
|
Layer1ApiUserMessageModifyIndicator(Layer1ApiUserMessageModifyIndicator message,
boolean isAdd)
Copy of message with overriden isAdd
|
private |
Layer1ApiUserMessageModifyIndicator(java.lang.String ownerClassName,
java.lang.String ownerUserName,
java.lang.String fullName,
java.lang.String userName,
boolean isAdd,
IndicatorColorScheme indicatorColorScheme,
Layer1IndicatorColorInterface colorInterface,
IndicatorLineStyle indicatorLineStyle,
java.awt.Color defaultTooltipBackgrondColor,
java.awt.Color defaultTooltipTextColor,
IndicatorDisplayLogic indicatorDisplayLogic,
java.lang.Double indicatorMinMarginPriceOut,
java.lang.Double indicatorMaxMarginPriceOut,
java.lang.Double minLimitsRange,
BoundsInfo boundsInfo,
Layer1ApiUserMessageModifyIndicator.GraphType graphType,
java.lang.Boolean isSupportWidget,
java.lang.Boolean isShowColorSettings,
java.lang.Boolean isEnableSettingsFromConfigPopup,
OnlineCalculatable onlineCalculatable,
AliasFilter aliasFilter) |
Modifier and Type | Method and Description |
---|---|
void |
applyNameModifier(java.lang.String modifier)
Use if you need to distinguish strategies with same user names
For example, could be when creating strategies with same names for different aliases
Modifier should be applied before sending this message
|
static Layer1ApiUserMessageModifyIndicator.Builder |
builder(java.lang.Class<?> strategyClass,
java.lang.String userName)
Creates builder to build
Layer1ApiUserMessageModifyIndicator . |
static java.lang.String |
getOwnerUserName(java.lang.Class<?> ownerClass) |
static java.lang.String |
predictFullName(java.lang.Class<?> myClass,
java.lang.String myName)
There is no guarantee that value returned from this method will be the same as indicator's full name
Do not use this method to predict strategy name |
java.lang.String |
toString() |
private static final int GRAPH_LAYER_RENDER_PRIORITY_DEFAULT
private static final int ICON_LAYER_RENDER_PRIORITY_DEFAULT
public final java.lang.String ownerClassName
public final java.lang.String ownerUserName
Layer1StrategyName
)public java.lang.String fullName
applyNameModifier(String)
if you need to generate different full names for same user namespublic final java.lang.String userName
public final boolean isAdd
public final IndicatorColorScheme indicatorColorScheme
public final Layer1IndicatorColorInterface colorInterface
indicatorColorScheme
indicatorColorScheme
public final IndicatorLineStyle indicatorLineStyle
public final java.awt.Color defaultTooltipBackgrondColor
public final java.awt.Color defaultTooltipTextColor
public final IndicatorDisplayLogic indicatorDisplayLogic
public final java.lang.Double indicatorMinMarginPriceOut
public final java.lang.Double indicatorMaxMarginPriceOut
public final java.lang.Double minLimitsRange
public final BoundsInfo boundsInfo
public final Layer1ApiUserMessageModifyIndicator.GraphType graphType
Layer1ApiUserMessageModifyIndicator.GraphType
Layer1ApiUserMessageModifyIndicator.GraphType.NONE
public final boolean isSupportWidget
public final boolean isShowColorSettings
public final boolean isEnableSettingsFromConfigPopup
public final OnlineCalculatable onlineCalculatable
public final AliasFilter aliasFilter
public WidgetDisplayInfo widgetDisplayInfo
public boolean isWidgetEnabledByDefault
public IndicatorContextMenuInformation indicatorContextMenuInformation
public HorizontalValueLinesInfo horizontalValueLinesInfo
public int graphLayerRenderPriority
public int iconLayerRanderPriotity
private Layer1ApiUserMessageModifyIndicator(Layer1ApiUserMessageModifyIndicator.Builder builder)
public Layer1ApiUserMessageModifyIndicator(java.lang.Class<?> strategyClass, java.lang.String userName, boolean isAdd, IndicatorColorScheme indicatorColorScheme, Layer1IndicatorColorInterface colorInterface, IndicatorLineStyle indicatorLineStyle, java.awt.Color defaultTooltipBackgrondColor, java.awt.Color defaultTooltipTextColor, IndicatorDisplayLogic indicatorDisplayLogic, java.lang.Double indicatorMinMarginPriceOut, java.lang.Double indicatorMaxMarginPriceOut, java.lang.Double minLimitsRange, BoundsInfo boundsInfo, Layer1ApiUserMessageModifyIndicator.GraphType graphType, java.lang.Boolean isSupportWidget, java.lang.Boolean isShowColorSettings, java.lang.Boolean isEnableSettingsFromConfigPopup, OnlineCalculatable onlineCalculatable, AliasFilter aliasFilter)
fullName
. This is a name that will be used to adress
your indicator by any external parts (for example online indicator calculations). This name will be unique trough all indicators
unless you initialize indicators with same owner class and same user name.
This filed will be initialized in message constructor and can be access afterstrategyClass
- class of strategy, creating this indicatoruserName
- name that will be visible to user i.e. in bottom panel context menuisAdd
- true if message is adding indicator, false if it's removing indicatorindicatorColorScheme
- if not null, indicator colors will be assign according to given color schemecolorInterface
- this will be used to set / get colors described by indicatorColorScheme
indicatorLineStyle
- indicator line style, if null default line style will be useddefaultTooltipTextColor
- if user has no settings for this indicator color, this color will be used as default
for drawing text in graph tooltip(background will be of defaultGraphColor)indicatorDisplayLogic
- can be null, default logic will be applied. If provided logic violates provided
indicatorMinMarginPriceOut
, indicatorMaxMarginPriceOut
or ,
limits will be modified to fit into provided argumentsindicatorMinMarginPriceOut
- if not null, indicator's limits will be recalculated when there is
less then that amount of indicator range empty space by either borderindicatorMaxMarginPriceOut
- if not null, indicator's limits will be recalculated when there is
more then that amount of indicator range empty space by either borderminLimitsRange
- if not null, indicator's limits range (max - min value) can't be less then minLimitsRangeboundsInfo
- minimum and maximum values of widget
null to indicate no predetermined bounds (will be determined on fly)graphType
- position of a graph (or NONE). Null will default to NONE.isSupportWidget
- true if widget is supported, false if widget is not supportedisShowColorSettings
- (temporary) if false, no color settings will be available via popup menuisEnableSettingsFromConfigPopup
- if true, config popup settings icon will open corresponding strategies dialog tabonlineCalculatable
- if not null, indicator will be calculated for chart onlinealiasFilter
- if null, indicator will be displayed for all aliases, otherwise only for ones defined by filterprivate Layer1ApiUserMessageModifyIndicator(java.lang.String ownerClassName, java.lang.String ownerUserName, java.lang.String fullName, java.lang.String userName, boolean isAdd, IndicatorColorScheme indicatorColorScheme, Layer1IndicatorColorInterface colorInterface, IndicatorLineStyle indicatorLineStyle, java.awt.Color defaultTooltipBackgrondColor, java.awt.Color defaultTooltipTextColor, IndicatorDisplayLogic indicatorDisplayLogic, java.lang.Double indicatorMinMarginPriceOut, java.lang.Double indicatorMaxMarginPriceOut, java.lang.Double minLimitsRange, BoundsInfo boundsInfo, Layer1ApiUserMessageModifyIndicator.GraphType graphType, java.lang.Boolean isSupportWidget, java.lang.Boolean isShowColorSettings, java.lang.Boolean isEnableSettingsFromConfigPopup, OnlineCalculatable onlineCalculatable, AliasFilter aliasFilter)
public Layer1ApiUserMessageModifyIndicator(Layer1ApiUserMessageModifyIndicator message)
public Layer1ApiUserMessageModifyIndicator(Layer1ApiUserMessageModifyIndicator message, boolean isAdd)
public Layer1ApiUserMessageModifyIndicator(java.lang.Class<?> strategyClass, java.lang.String userName, boolean isAdd)
fullName
. This is a name that will be used to adress
your indicator by any external parts (for example online indicator calculations). This name will be unique trough all indicators
unless you initialize indicators with same owner class and same user name.
This filed will be initialized in message constructor and can be access afterstrategyClass
- class of strategy, creating this indicatoruserName
- name that will be visible to user e.g. in bottom panel context menuisAdd
- true if message is adding indicator, false if it's removing indicatorpublic void applyNameModifier(java.lang.String modifier)
public static java.lang.String predictFullName(java.lang.Class<?> myClass, java.lang.String myName)
public static Layer1ApiUserMessageModifyIndicator.Builder builder(java.lang.Class<?> strategyClass, java.lang.String userName)
Layer1ApiUserMessageModifyIndicator
.strategyClass
- class of strategy, creating this indicatoruserName
- name that will be visible to user e.g. in bottom panel context menupublic static java.lang.String getOwnerUserName(java.lang.Class<?> ownerClass)
public java.lang.String toString()
toString
in class java.lang.Object