Class Layer1ApiUserMessageModifyIndicator.Builder
java.lang.Object
velox.api.layer1.messages.indicators.Layer1ApiUserMessageModifyIndicator.Builder
- Enclosing class:
- Layer1ApiUserMessageModifyIndicator
public static final class Layer1ApiUserMessageModifyIndicator.Builder
extends java.lang.Object
Builder to build
Layer1ApiUserMessageModifyIndicator
.-
Constructor Summary
Constructors Constructor Description Builder(Layer1ApiUserMessageModifyIndicator message)
-
Method Summary
-
Constructor Details
-
Method Details
-
setIsAdd
- Parameters:
isAdd
- true if message is adding indicator, false if it's removing indicator- Returns:
- this builder
-
setIndicatorColorScheme
public Layer1ApiUserMessageModifyIndicator.Builder setIndicatorColorScheme(IndicatorColorScheme indicatorColorScheme)- Parameters:
indicatorColorScheme
- if not null, indicator colors will be assign according to given color scheme- Returns:
- this builder
-
setColorInterface
public Layer1ApiUserMessageModifyIndicator.Builder setColorInterface(Layer1IndicatorColorInterface colorInterface)- Parameters:
colorInterface
- this will be used to set / get colors described byindicatorColorScheme
- Returns:
-
setIndicatorLineStyle
public Layer1ApiUserMessageModifyIndicator.Builder setIndicatorLineStyle(IndicatorLineStyle indicatorLineStyle)- Parameters:
indicatorLineStyle
- indicator line style, if null default line style will be used- Returns:
- this builder
-
setDefaultTooltipBackgrondColor
public Layer1ApiUserMessageModifyIndicator.Builder setDefaultTooltipBackgrondColor(java.awt.Color defaultTooltipBackgrondColor)- Parameters:
defaultTooltipBackgrondColor
- if user has no settings for this indicator color, this color will be used as default for drawing text background in graph tooltip- Returns:
- this builder
-
setDefaultTooltipTextColor
public Layer1ApiUserMessageModifyIndicator.Builder setDefaultTooltipTextColor(java.awt.Color defaultTooltipTextColor)- Parameters:
defaultTooltipTextColor
- 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 ofsetDefaultTooltipBackgrondColor(Color)
)- Returns:
- this builder
-
setIndicatorDisplayLogic
public Layer1ApiUserMessageModifyIndicator.Builder setIndicatorDisplayLogic(IndicatorDisplayLogic indicatorDisplayLogic)- Parameters:
indicatorDisplayLogic
- can be null, default logic will be applied. If provided logic violates providedindicatorMinMarginPriceOut
,indicatorMaxMarginPriceOut
orminLimitsRange
, limits will be modified to fit into provided arguments- Returns:
- this builder
-
setIndicatorMinMarginPriceOut
public Layer1ApiUserMessageModifyIndicator.Builder setIndicatorMinMarginPriceOut(java.lang.Double indicatorMinMarginPriceOut)- Parameters:
indicatorMinMarginPriceOut
- if not null, indicator's limits will be recalculated when there is less then that amount of indicator range empty space by either border- Returns:
- this builder
-
setIndicatorMaxMarginPriceOut
public Layer1ApiUserMessageModifyIndicator.Builder setIndicatorMaxMarginPriceOut(java.lang.Double indicatorMaxMarginPriceOut)- Parameters:
indicatorMaxMarginPriceOut
- if not null, indicator's limits will be recalculated when there is more then that amount of indicator range empty space by either border- Returns:
- this builder
-
setMinLimitsRange
public Layer1ApiUserMessageModifyIndicator.Builder setMinLimitsRange(java.lang.Double minLimitsRange)- Parameters:
minLimitsRange
- if not null, indicator's limits range (max - min value) can't be less then minLimitsRange- Returns:
- this builder
-
setBoundsInfo
- Parameters:
boundsInfo
- minimum and maximum values of widget, or null if they should be determined on fly can be null to indicate no predetermined bounds- Returns:
- this builder
-
setGraphType
public Layer1ApiUserMessageModifyIndicator.Builder setGraphType(Layer1ApiUserMessageModifyIndicator.GraphType graphType)- Parameters:
graphType
- position of a graph (or NONE). Null will default to NONE- Returns:
- this builder
-
setIsSupportWidget
- Parameters:
isSupportWidget
- true if widget is supported, false if widget is not supported- Returns:
- this builder
-
setIsShowColorSettings
public Layer1ApiUserMessageModifyIndicator.Builder setIsShowColorSettings(boolean isShowColorSettings)- Parameters:
isShowColorSettings
- If true, indicator popup menu (if one exists) will have 'Setting' entry that will open indicator settings dialog
If indicator is ofLayer1ApiUserMessageModifyIndicator.GraphType.BOTTOM
, settings button will be enabled based on this property- Returns:
- this builder
-
setIsEnableSettingsFromConfigPopup
public Layer1ApiUserMessageModifyIndicator.Builder setIsEnableSettingsFromConfigPopup(boolean isEnableSettingsFromConfigPopup)- Parameters:
isEnableSettingsFromConfigPopup
- if true, config popup settings icon will open corresponding strategies dialog tab- Returns:
- this builder
-
setOnlineCalculatable
public Layer1ApiUserMessageModifyIndicator.Builder setOnlineCalculatable(OnlineCalculatable onlineCalculatable)- Parameters:
onlineCalculatable
- if not null, indicator will be calculated for chart online- Returns:
- this builder
-
setAliasFiler
- Parameters:
aliasFilter
- if null, indicator will be displayed for all aliases, otherwise only for ones defined by filter- Returns:
- this builder
-
setWidgetDisplayInfo
public Layer1ApiUserMessageModifyIndicator.Builder setWidgetDisplayInfo(WidgetDisplayInfo widgetDisplayInfo)- Parameters:
widgetDisplayInfo
- information about how widget should display values- Returns:
- this builder
-
setIsLineEnabledByDefault
public Layer1ApiUserMessageModifyIndicator.Builder setIsLineEnabledByDefault(boolean isLineEnabledByDefault)- Parameters:
isLineEnabledByDefault
- true if line should be shown by default when strategy is first added, false otherwise- Returns:
- this builder
-
setIsWidgetEnabledByDefault
public Layer1ApiUserMessageModifyIndicator.Builder setIsWidgetEnabledByDefault(boolean isWidgetEnabledByDefault)- Parameters:
isWidgetEnabledByDefault
- true if widget should be shown by default when strategy is first added, false otherwise- Returns:
- this builder
-
setIndicatorContextMenuInformation
public Layer1ApiUserMessageModifyIndicator.Builder setIndicatorContextMenuInformation(IndicatorContextMenuInformation indicatorContextMenuInformation)- Parameters:
indicatorContextMenuInformation
- information about custom context menus entries- Returns:
- this builder
-
setHorizontalValueLinesInfo
public Layer1ApiUserMessageModifyIndicator.Builder setHorizontalValueLinesInfo(HorizontalValueLinesInfo horizontalValueLinesInfo)- Parameters:
horizontalValueLinesInfo
- information about horizontal lines- Returns:
- this builder
-
build
-
extendFullName
Allows extending full name to register same user name for multiple aliases- Parameters:
suffix
- suffix to add to full name- Returns:
-
setGraphLayerRenderPriority
public Layer1ApiUserMessageModifyIndicator.Builder setGraphLayerRenderPriority(int graphLayerRenderPriority)Determines order of layers rendered on chart for indicator line. Higher value will be rendered later
Can be arbitrary value or one of predefinedLayer1ApiUserMessageModifyIndicator.LayerRenderPriority
values
Default isLayer1ApiUserMessageModifyIndicator.LayerRenderPriority.ABOVE_BBO
- Parameters:
graphLayerRenderPriority
- graph layer render priority- Returns:
-
setGraphLayerRenderPriority
public Layer1ApiUserMessageModifyIndicator.Builder setGraphLayerRenderPriority(Layer1ApiUserMessageModifyIndicator.LayerRenderPriority graphLayerRenderPriority)Determines order of layers rendered on chart for indicator line. Higher value will be rendered later
Can be arbitrary value or one of predefinedLayer1ApiUserMessageModifyIndicator.LayerRenderPriority
values
Default isLayer1ApiUserMessageModifyIndicator.LayerRenderPriority.ABOVE_BBO
- Parameters:
graphLayerRenderPriority
- graph layer render priority- Returns:
-
setIconLayerRanderPriotity
public Layer1ApiUserMessageModifyIndicator.Builder setIconLayerRanderPriotity(int iconLayerRanderPriotity)Determines order of layers rendered on chart for indicator icons. Higher value will be rendered later
Can be arbitrary value or one of predefinedLayer1ApiUserMessageModifyIndicator.LayerRenderPriority
values
Default isLayer1ApiUserMessageModifyIndicator.LayerRenderPriority.TOP
- Parameters:
iconLayerRanderPriotity
- icon layer render priority- Returns:
-
setIconLayerRanderPriotity
public Layer1ApiUserMessageModifyIndicator.Builder setIconLayerRanderPriotity(Layer1ApiUserMessageModifyIndicator.LayerRenderPriority iconLayerRanderPriotity)Determines order of layers rendered on chart for indicator icons. Higher value will be rendered later
Can be arbitrary value or one of predefinedLayer1ApiUserMessageModifyIndicator.LayerRenderPriority
values
Default isLayer1ApiUserMessageModifyIndicator.LayerRenderPriority.TOP
- Parameters:
iconLayerRanderPriotity
- icon layer render priority- Returns:
-