Class Layer1ApiUserMessageModifyScreenSpacePainter
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 buildLayer1ApiUserMessageModifyScreenSpacePainter
. -
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
UseapplyNameModifier(String)
if you need to generate different full names for same user namesboolean
isAdd
java.lang.String
ownerClassName
Name of owner strategy classjava.lang.String
ownerUserName
User friendly name of owner strategy class (if provided viaLayer1StrategyName
)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 messagestatic Layer1ApiUserMessageModifyScreenSpacePainter.Builder
builder(java.lang.Class<?> strategyClass, java.lang.String userName)
Creates builder to buildLayer1ApiUserMessageModifyScreenSpacePainter
.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 namejava.lang.String
toString()
-
Field Details
-
ownerClassName
public final java.lang.String ownerClassNameName of owner strategy class -
ownerUserName
public final java.lang.String ownerUserNameUser friendly name of owner strategy class (if provided viaLayer1StrategyName
) -
fullName
public java.lang.String fullNameThis is a unique indicator name, that will be used to address this indicator from any external part
Do not change this field
UseapplyNameModifier(String)
if you need to generate different full names for same user names -
userName
public final java.lang.String userNameName that will be visible to user i.e. in bottom panel context menu -
isAdd
public final boolean isAdd -
screenSpacePainterFactory
-
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 classjava.lang.Object
-
builder
public static Layer1ApiUserMessageModifyScreenSpacePainter.Builder builder(java.lang.Class<?> strategyClass, java.lang.String userName)Creates builder to buildLayer1ApiUserMessageModifyScreenSpacePainter
.- Returns:
- created builder
-