Package velox.api.layer1.messages.indicators

Class IndicatorLineStyle

java.lang.Object

velox.api.layer1.messages.indicators.IndicatorLineStyle

public class IndicatorLineStyle
extends java.lang.Object

This class allows you to specify how the indicator line will look.

There are two parts: mainLine (3 fields) and rightLine (3 fields). Main line is the part to the left of timeline and rightLine is part to the right.

Each part is described by 3 parts,

• mask - single short int (2 bytes) where each bit can be 1 (line is present) or 0 (line is not present). e.g. 0xF0F0 (binary 1111000011110000) will make line look like repeated "---- ---- " segments
• multiplier - scales the mask describing how many pixels each bit represents
• lineWidth - just a width of the line in pixels

Field Summary

Fields

Modifier and Type	Field	Description
static IndicatorLineStyle	DEFAULT	Similar to most lines in Bookmap
short	mainLineStyleMask	Mask for the main line style.
short	mainLineStyleMultiplier	Multiplier for the main line style.
int	mainLineWidth	Main line width.
static IndicatorLineStyle	NONE	No line.
short	rightLineStyleMask	Mask for the right line style.
short	rightLineStyleMultiplier	Multiplier for the right line style.
int	rightLineWidth	Right line width.
static IndicatorLineStyle	SHORT_DASHES	Short dashes of the same style both to the left and to the right of timeline
static IndicatorLineStyle	SHORT_DASHES_WIDE_LEFT_NARROW_RIGHT	Mostly a demo to show how to configure more complex style.

Constructor Summary

Constructors

Constructor	Description
IndicatorLineStyle()	Creates default line style (similar to most lines in Bookmap)
IndicatorLineStyle(short mainLineStyleMask, short mainLineStyleMultiplier, int mainLineWidth, short rightLineStyleMask, short rightLineStyleMultiplier, int rightLineWidth)	Creates a custom line style.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final IndicatorLineStyle DEFAULT

Similar to most lines in Bookmap

NONE

public static final IndicatorLineStyle NONE

No line. Use if you want to display icons only

SHORT_DASHES

public static final IndicatorLineStyle SHORT_DASHES

Short dashes of the same style both to the left and to the right of timeline

SHORT_DASHES_WIDE_LEFT_NARROW_RIGHT

public static final IndicatorLineStyle SHORT_DASHES_WIDE_LEFT_NARROW_RIGHT

Mostly a demo to show how to configure more complex style.

mainLineStyleMask

public final short mainLineStyleMask

Mask for the main line style. see this for more information

mainLineStyleMultiplier

public final short mainLineStyleMultiplier

Multiplier for the main line style. see this for more information

mainLineWidth

public final int mainLineWidth

Main line width. see this for more information

rightLineStyleMask

public final short rightLineStyleMask

Mask for the right line style. see this for more information

rightLineStyleMultiplier

public final short rightLineStyleMultiplier

Multiplier for the right line style. see this for more information

rightLineWidth

public final int rightLineWidth

Right line width. see this for more information

Constructor Details

IndicatorLineStyle

public IndicatorLineStyle()

Creates default line style (similar to most lines in Bookmap)

IndicatorLineStyle

public IndicatorLineStyle(short mainLineStyleMask, short mainLineStyleMultiplier, int mainLineWidth, short rightLineStyleMask, short rightLineStyleMultiplier, int rightLineWidth)

Creates a custom line style. See descriptions for individual fields and this class documentation for parameter descriptions.