com.motivewave.platform.sdk.common

Class LineInfo

java.lang.Object

com.motivewave.platform.sdk.common.LineInfo

All Implemented Interfaces:

java.lang.Cloneable

public class LineInfo
extends java.lang.Object
implements java.lang.Cloneable

Describes a horizontal line that is to be displayed in a Study.

Constructor Summary

Constructors

Constructor and Description
LineInfo(double value, java.awt.Color lineColor, float width, float[] dash) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
LineInfo	clone() Creates a clone (copy) of this object.
boolean	equals(java.lang.Object o) Compares the give object with this object and returns true if they are equal.
float[]	getDash() Gets the dash style for the line (null for a solid line)
java.awt.Color	getLineColor() Gets the color of the line (null if default line color)
java.awt.Stroke	getSelectedStroke() Gets the stroke for drawing the line when the study is selected.
java.awt.Stroke	getStroke() Gets the stroke for drawing the line.
double	getValue() Gets the y value (real value) for drawing this line.
float	getWidth() Gets the width of the line (null for a solid line)
java.lang.String	toString() Gets string representation of this LineInfo object

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LineInfo

public LineInfo(double value,
        java.awt.Color lineColor,
        float width,
        float[] dash)

Constructor.

Parameters:

value - y value for the horizontal line

lineColor - color of the line

width - width of the line

dash - dash style (null for solid line)

Method Detail

getValue

public double getValue()

Gets the y value (real value) for drawing this line.

Returns:

the y value (real value) for drawing this line.

getLineColor

public java.awt.Color getLineColor()

Gets the color of the line (null if default line color)

Returns:

the color of the line (null if default line color)

getDash

public float[] getDash()

Gets the dash style for the line (null for a solid line)

Returns:

the dash style for the line (null for a solid line)

getWidth

public float getWidth()

Gets the width of the line (null for a solid line)

Returns:

the width of the line (null for a solid line)

getStroke

public java.awt.Stroke getStroke()

Gets the stroke for drawing the line.

Returns:

stroke used to draw the line

getSelectedStroke

public java.awt.Stroke getSelectedStroke()

Gets the stroke for drawing the line when the study is selected.

Returns:

stroke used to draw the line when it is selected by the user

clone

public LineInfo clone()

Creates a clone (copy) of this object.

Overrides:

clone in class java.lang.Object

Returns:

clone of this object

equals

public boolean equals(java.lang.Object o)

Compares the give object with this object and returns true if they are equal.

Overrides:

equals in class java.lang.Object

Returns:

true if the given object equals this BarInfo

toString

public java.lang.String toString()

Gets string representation of this LineInfo object

Overrides:

toString in class java.lang.Object

Returns:

string representation