SoftwareFX.ChartFX.Statistical
Class StudyConstant

java.lang.Object
  SoftwareFX.ChartFX.Statistical.Study
      SoftwareFX.ChartFX.Statistical.StudyInteractive
          SoftwareFX.ChartFX.Statistical.StudyConstant

public final class StudyConstant
extends StudyInteractive

Provides access to the StudyConstant object.

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

Constructor Summary

StudyConstant(int studyType, int id)

Method Summary

java.awt.Color	getColor() Gets the Color.
java.lang.Object[]	getConstantLines() Returns the collection of ConstantLines associated with a StudyConstant object.
int	getLineStyle() Gets the LineStyle.
int	getLineWidth() Gets the LineWidth.
java.lang.String	getText() Gets the Text.
boolean	isShowLabel() Gets the ShowLabel.
void	setColor(java.awt.Color value) Gets or sets the color for a selected StudyConstant object.
void	setLineStyle(int value) Gets or sets the line style for a selected StudyConstant object.
void	setLineWidth(int value) Gets or sets the line width for a selected StudyConstant object.
void	setShowLabel(boolean value) Gets or sets a value indicating whether configured text will be displayed for the StudyConstant object.
void	setText(java.lang.String value) Gets or sets the string used for the selected StudyConstant's title.

Methods inherited from class SoftwareFX.ChartFX.Statistical.StudyInteractive

getAxis, isInteractive, isVisible, setAxis, setInteractive, setVisible

Methods inherited from class SoftwareFX.ChartFX.Statistical.Study

createStudyAnalysis, createStudyAnalysisMulti, createStudyDistributionFormula, createStudyTest, createStudyTestMulti, getDecimals, getID, getValue, isBold, isIndented, setBold, setDecimals, setIndented, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

StudyConstant

public StudyConstant(int studyType,
                     int id)

Method Detail

getColor

public java.awt.Color getColor()

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

getConstantLines

public java.lang.Object[] getConstantLines()

Returns the collection of ConstantLines associated with a StudyConstant object.

Remarks:

All the useful visual attributes have been exposed in the Study class. However, this could be useful for quickly assigning attributes to the entire collection of stripes at one time.

See Also:

Study

getLineStyle

public int getLineStyle()

Gets the LineStyle. For more detail see setLineStyle(int).

getLineWidth

public int getLineWidth()

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

getText

public java.lang.String getText()

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

Overrides:

getText in class Study

isShowLabel

public boolean isShowLabel()

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

setColor

public void setColor(java.awt.Color value)

Gets or 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:

StudyConstant sc1 = (StudyConstant) statistics1.getStudies().addAnalysis(Analysis.MEAN);


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

See Also:

setLineStyle(int), setLineWidth(int), Statistics.getStudies(), StudiesCollection.add(java.lang.Object), StudiesCollection, Statistics

setLineStyle

public void setLineStyle(int value)

Gets or 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:

StudyConstant sc1 = (StudyConstant) statistics1.getStudies().addAnalysis(Analysis.MEAN);


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(java.lang.Object), StudiesCollection, Statistics

setLineWidth

public void setLineWidth(int value)

Gets or 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:

StudyConstant sc1 = (StudyConstant) statistics1.getStudies().addAnalysis(Analysis.MEAN);


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

See Also:

setColor(java.awt.Color), setLineStyle(int), Statistics.getStudies(), StudiesCollection.add(java.lang.Object), StudiesCollection, Statistics

setShowLabel

public void setShowLabel(boolean value)

Gets or 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:

StudyConstant sc1 = (StudyConstant) statistics1.getStudies().AddAnalysis(Analysis.MEAN);


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(java.lang.String value)

Gets or 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:

StudyConstant sc1 = (StudyConstant) statistics1.getStudies().addAnalysis(Analysis.MEAN);


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