com.softwarefx.chartfx.server.statistical
Class StudyConstant

java.lang.Object
  com.softwarefx.chartfx.server.statistical.Study
      com.softwarefx.chartfx.server.statistical.StudyInteractive
          com.softwarefx.chartfx.server.statistical.StudyConstant

All Implemented Interfaces:

IStudy

public class StudyConstant
extends StudyInteractive
implements IStudy

Provides access to the StudyConstant object

This class is specifically used to control attributes of studies that utilize a ConstantLine object.

Constructor Summary

StudyConstant(StudyType studyType, int id)

Method Summary

Color	getColor() Gets the Color.
DashStyle	getLineStyle() Gets the LineStyle.
int	getLineWidth() Gets the LineWidth.
String	getText() Gets the Text.
boolean	isShowLabel() Gets the ShowLabel.
void	setColor(Color value) Sets the color for a selected StudyConstant object.
void	setLineStyle(DashStyle value) Sets the line style for a selected StudyConstant object.
void	setLineWidth(int value) Sets the line width for a selected StudyConstant object.
void	setShowLabel(boolean value) Sets a value indicating whether configured text will be displayed for the StudyConstant object.
void	setText(String value) Sets the string used for the selected StudyConstant's title.

Methods inherited from class com.softwarefx.chartfx.server.statistical.StudyInteractive

getAxis, isInteractive, isVisible, setAxis, setInteractive, setVisible

Methods inherited from class com.softwarefx.chartfx.server.statistical.Study

createStudy, createStudy, createStudy, createStudy, createStudy, getDecimals, getID, getValue, getValue, isBold, isIndented, setBold, setDecimals, setIndented, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.softwarefx.chartfx.server.statistical.IStudy

getValue, isBold, isIndented, isInteractive, isVisible, setBold, setIndented, setVisible

Constructor Detail

StudyConstant

public StudyConstant(StudyType studyType,
                     int id)

Method Detail

getColor

public Color getColor()

Gets the Color. For more detail see setColor(java.awt.Color).

Specified by:

getColor in interface IStudy

Overrides:

getColor in class Study

getLineStyle

public DashStyle getLineStyle()

Gets the LineStyle. For more detail see setLineStyle(com.softwarefx.DashStyle).

getLineWidth

public int getLineWidth()

Gets the LineWidth. For more detail see setLineWidth(int).

getText

public String getText()

Gets the Text. For more detail see setText(java.lang.String).

Specified by:

getText in interface IStudy

Overrides:

getText in class Study

isShowLabel

public boolean isShowLabel()

Gets the ShowLabel. For more detail see setShowLabel(boolean).

setColor

public void setColor(Color value)

Sets the color for a selected StudyConstant object.

Remarks:

You can obtain the StudyConstant object for a selected study when adding the study to the Studies collection as follows:

The setLineStyle(com.softwarefx.DashStyle) and setLineWidth(int) are used to control the style and width for the StudyConstant object.

See Also:

setLineStyle(com.softwarefx.DashStyle), setLineWidth(int), Statistics.getStudies(), StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), StudiesCollection, Statistics

setLineStyle

public void setLineStyle(DashStyle value)

Sets the line style for a selected StudyConstant object.

Remarks:

You can obtain the StudyConstant object for a selected study when adding the study to the Studies collection as follows:

You can set the color and width for the selected StudyConstant object using the setColor(java.awt.Color) and setLineWidth(int) properties, respectively.

See Also:

setColor(java.awt.Color), setLineWidth(int), Statistics.getStudies(), StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), StudiesCollection, Statistics

setLineWidth

public void setLineWidth(int value)

Sets the line width for a selected StudyConstant object.

Remarks:

You can obtain the StudyConstant object for a selected study when adding the study to the Studies collection as follows:

You can set the color and style for the selected StudyConstant object using the setColor(java.awt.Color) and setLineStyle(com.softwarefx.DashStyle) properties, respectively.

See Also:

setColor(java.awt.Color), setLineStyle(com.softwarefx.DashStyle), Statistics.getStudies(), StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), StudiesCollection, Statistics

setShowLabel

public void setShowLabel(boolean value)

Sets a value indicating whether configured text will be displayed for the StudyConstant object.

Remarks:

You can obtain the StudyConstant object for a selected study when adding the study to the Studies collection as follows:

The setText(java.lang.String) property may be used to get or set a text string for a given StudyConstant object.

See Also:

setText(java.lang.String)

setText

public void setText(String value)

Sets the string used for the selected StudyConstant's title.

Remarks:

You can obtain the StudyConstant object for a selected study when adding the study to the Studies collection as follows:

The setShowLabel(boolean) property is used to show or hide the configured constant line label of a selected StudyConstant object.

The Study class exposes other attributes that may be used to customize text for study text displayed in the legend and chart.

Overrides:

setText in class Study

See Also:

setShowLabel(boolean), Study