java.lang.Object

velox.api.layer1.messages.indicators.Layer1ApiUserMessageModifyScreenSpacePainter

All Implemented Interfaces:: Layer1ApiStrategiesEchoMessagesLayer.StrategyEchoMessageFromLayer

public class Layer1ApiUserMessageModifyScreenSpacePainter
extends java.lang.Object
implements Layer1ApiStrategiesEchoMessagesLayer.StrategyEchoMessageFromLayer

Describes adding or removing a screen-space painter Note that you need to remember fullName. This is a name that will be used to adress your indicator by any external parts. This name will be unique trough all indicators unless you initialize indicators with same owner class and same user name. This field will be initialized in message constructor and can be accessed after

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class Layer1ApiUserMessageModifyScreenSpacePainter.Builder
Builder to build Layer1ApiUserMessageModifyScreenSpacePainter.

Field Summary

Fields
Modifier and Type	Field	Description
`AliasFilter`	`aliasFilter`
`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
`boolean`	`isAdd`
`java.lang.String`	`ownerClassName`	Name of owner strategy class
`java.lang.String`	`ownerUserName`	User friendly name of owner strategy class (if provided via `Layer1StrategyName`)
`ScreenSpacePainterFactory`	`screenSpacePainterFactory`
`java.lang.String`	`userName`	Name that will be visible to user i.e.

Method Summary

Modifier and Type	Method	Description
`void`	`applyNameModifier(java.lang.String modifier)`	Use if you need to distinguish painters with same user names For example, could be when creating painters with same names for different aliases Modifier should be applied before sending this message
`static Layer1ApiUserMessageModifyScreenSpacePainter.Builder`	`builder(java.lang.Class<?> strategyClass, java.lang.String userName)`	Creates builder to build `Layer1ApiUserMessageModifyScreenSpacePainter`.
`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()`

Methods inherited from class java.lang.Object

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

Field Details
- ownerClassName
  
  public final java.lang.String ownerClassName
  
  Name of owner strategy class
- ownerUserName
  
  public final java.lang.String ownerUserName
  
  User friendly name of owner strategy class (if provided via Layer1StrategyName)
- fullName
  
  public 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
- userName
  
  public final java.lang.String userName
  
  Name that will be visible to user i.e. in bottom panel context menu
- isAdd
  
  public final boolean isAdd
- screenSpacePainterFactory
  
  public final ScreenSpacePainterFactory screenSpacePainterFactory
- aliasFilter
  
  public final AliasFilter aliasFilter
Method Details
- applyNameModifier
  
  public void applyNameModifier(java.lang.String modifier)
  
  Use if you need to distinguish painters with same user names For example, could be when creating painters with same names for different aliases Modifier should be applied before sending this message
- predictFullName
  
  public 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
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object
- builder
  
  public static Layer1ApiUserMessageModifyScreenSpacePainter.Builder builder(java.lang.Class<?> strategyClass, java.lang.String userName)
  
  Creates builder to build Layer1ApiUserMessageModifyScreenSpacePainter.
  
  Returns:
  
  created builder

Class Layer1ApiUserMessageModifyScreenSpacePainter

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Method Details