Package velox.api.layer1.messages.indicators

Class Layer1ApiUserMessageModifyIndicator.Builder

java.lang.Object

velox.api.layer1.messages.indicators.Layer1ApiUserMessageModifyIndicator.Builder

Enclosing class:

Layer1ApiUserMessageModifyIndicator

public static final class Layer1ApiUserMessageModifyIndicator.Builder
extends Object

Builder to build Layer1ApiUserMessageModifyIndicator.

Constructor Summary

Constructors

Constructor	Description
Builder(Layer1ApiUserMessageModifyIndicator message)

Method Summary

Modifier and Type	Method	Description
Layer1ApiUserMessageModifyIndicator	build()
Layer1ApiUserMessageModifyIndicator.Builder	extendFullName(String suffix)	Allows extending full name to register same user name for multiple aliases
Layer1ApiUserMessageModifyIndicator.Builder	setAliasFiler(AliasFilter aliasFilter)
Layer1ApiUserMessageModifyIndicator.Builder	setBoundsInfo(BoundsInfo boundsInfo)
Layer1ApiUserMessageModifyIndicator.Builder	setColorInterface(Layer1IndicatorColorInterface colorInterface)
Layer1ApiUserMessageModifyIndicator.Builder	setDefaultTooltipBackgrondColor(Color defaultTooltipBackgrondColor)
Layer1ApiUserMessageModifyIndicator.Builder	setDefaultTooltipTextColor(Color defaultTooltipTextColor)
Layer1ApiUserMessageModifyIndicator.Builder	setGraphLayerRenderPriority(int graphLayerRenderPriority)	Determines order of layers rendered on chart for indicator line.
Layer1ApiUserMessageModifyIndicator.Builder	setGraphLayerRenderPriority(Layer1ApiUserMessageModifyIndicator.LayerRenderPriority graphLayerRenderPriority)	Determines order of layers rendered on chart for indicator line.
Layer1ApiUserMessageModifyIndicator.Builder	setGraphType(Layer1ApiUserMessageModifyIndicator.GraphType graphType)
Layer1ApiUserMessageModifyIndicator.Builder	setHorizontalValueLinesInfo(HorizontalValueLinesInfo horizontalValueLinesInfo)
Layer1ApiUserMessageModifyIndicator.Builder	setIconLayerRanderPriotity(int iconLayerRanderPriotity)	Determines order of layers rendered on chart for indicator icons.
Layer1ApiUserMessageModifyIndicator.Builder	setIconLayerRanderPriotity(Layer1ApiUserMessageModifyIndicator.LayerRenderPriority iconLayerRanderPriotity)	Determines order of layers rendered on chart for indicator icons.
Layer1ApiUserMessageModifyIndicator.Builder	setIndicatorColorScheme(IndicatorColorScheme indicatorColorScheme)
Layer1ApiUserMessageModifyIndicator.Builder	setIndicatorContextMenuInformation(IndicatorContextMenuInformation indicatorContextMenuInformation)
Layer1ApiUserMessageModifyIndicator.Builder	setIndicatorDisplayLogic(IndicatorDisplayLogic indicatorDisplayLogic)
Layer1ApiUserMessageModifyIndicator.Builder	setIndicatorLineStyle(IndicatorLineStyle indicatorLineStyle)
Layer1ApiUserMessageModifyIndicator.Builder	setIndicatorMaxMarginPriceOut(Double indicatorMaxMarginPriceOut)
Layer1ApiUserMessageModifyIndicator.Builder	setIndicatorMinMarginPriceOut(Double indicatorMinMarginPriceOut)
Layer1ApiUserMessageModifyIndicator.Builder	setIsAdd(boolean isAdd)
Layer1ApiUserMessageModifyIndicator.Builder	setIsEnableSettingsFromConfigPopup(boolean isEnableSettingsFromConfigPopup)
Layer1ApiUserMessageModifyIndicator.Builder	setIsLineEnabledByDefault(boolean isLineEnabledByDefault)
Layer1ApiUserMessageModifyIndicator.Builder	setIsShowColorSettings(boolean isShowColorSettings)
Layer1ApiUserMessageModifyIndicator.Builder	setIsSupportWidget(boolean isSupportWidget)
Layer1ApiUserMessageModifyIndicator.Builder	setIsWidgetEnabledByDefault(boolean isWidgetEnabledByDefault)
Layer1ApiUserMessageModifyIndicator.Builder	setMinLimitsRange(Double minLimitsRange)
Layer1ApiUserMessageModifyIndicator.Builder	setOnlineCalculatable(OnlineCalculatable onlineCalculatable)
Layer1ApiUserMessageModifyIndicator.Builder	setWidgetDisplayInfo(WidgetDisplayInfo widgetDisplayInfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder(Layer1ApiUserMessageModifyIndicator message)

Method Details

setIsAdd

public Layer1ApiUserMessageModifyIndicator.Builder setIsAdd(boolean isAdd)

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 by indicatorColorScheme

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(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(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 of setDefaultTooltipBackgrondColor(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 provided Layer1ApiUserMessageModifyIndicator.indicatorMinMarginPriceOut, Layer1ApiUserMessageModifyIndicator.indicatorMaxMarginPriceOut or Layer1ApiUserMessageModifyIndicator.minLimitsRange, limits will be modified to fit into provided arguments

Returns:

this builder

setIndicatorMinMarginPriceOut

public Layer1ApiUserMessageModifyIndicator.Builder setIndicatorMinMarginPriceOut(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(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(Double minLimitsRange)

Parameters:

minLimitsRange - if not null, indicator's limits range (max - min value) can't be less then minLimitsRange

Returns:

this builder

setBoundsInfo

public Layer1ApiUserMessageModifyIndicator.Builder setBoundsInfo(BoundsInfo boundsInfo)

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

public Layer1ApiUserMessageModifyIndicator.Builder setIsSupportWidget(boolean isSupportWidget)

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 of Layer1ApiUserMessageModifyIndicator.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

public Layer1ApiUserMessageModifyIndicator.Builder setAliasFiler(AliasFilter aliasFilter)

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

public Layer1ApiUserMessageModifyIndicator build()

extendFullName

public Layer1ApiUserMessageModifyIndicator.Builder extendFullName(String suffix)

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 predefined Layer1ApiUserMessageModifyIndicator.LayerRenderPriority values
Default is Layer1ApiUserMessageModifyIndicator.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 predefined Layer1ApiUserMessageModifyIndicator.LayerRenderPriority values
Default is Layer1ApiUserMessageModifyIndicator.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 predefined Layer1ApiUserMessageModifyIndicator.LayerRenderPriority values
Default is Layer1ApiUserMessageModifyIndicator.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 predefined Layer1ApiUserMessageModifyIndicator.LayerRenderPriority values
Default is Layer1ApiUserMessageModifyIndicator.LayerRenderPriority.TOP

Parameters:

iconLayerRanderPriotity - icon layer render priority

Returns: