SoftwareFX.ChartFX.Statistical
Class StudyCustom

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

public final class StudyCustom
extends StudyInteractive

Provides access to the StudyCustom object.

This class is specifically used to control attributes of custom studies the developer has added to the extension. The AddTitle method of the Studies collection returns this type of object.

Constructor Summary

StudyCustom(int id, java.lang.String text)

Method Summary

java.awt.Color	getColor() Gets the Color.
void	setColor(java.awt.Color value) Gets or sets the color for a selected StudyCustom object.

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, getText, getValue, isBold, isIndented, setBold, setDecimals, setIndented, setText, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

StudyCustom

public StudyCustom(int id,
                   java.lang.String text)

Method Detail

getColor

public java.awt.Color getColor()

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

setColor

public void setColor(java.awt.Color value)

Gets or sets the color for a selected StudyCustom object.

Remarks:

The Statistics.getStudies() property of the Statistics class exposes the members of the StudiesCollection class. Using the StudiesCollection.addTitle(java.lang.String) method, you can add a CustomStudy to the LegendBox. To obtain a StudyCustom object, the following code could be implemented:

StudyCustom sc1 = (StudyCustom) statistics1.getStudies().addTitle("Custom Study 1");
sc1.setBold(true);
sc1.setValue(100);
sc1.setInteractive(true);
sc1.setIndented(false);
sc1.setColor(java.awt.Color.PINK);


If a StudyCustom object is set to be StudyInteractive.setInteractive(boolean) (true), the checkbox for the study will display the color configured using this property when selected.

The Study.setValue(double) property allows you to configure a string as the result for the StudyCustom object.

The Study.setIndented(boolean) property allows you to control if the selected study's title will be indented or not.

See Also:

Statistics.getStudies(), StudyInteractive.setInteractive(boolean), Study.setValue(double), Study.setIndented(boolean), StudiesCollection.addTitle(java.lang.String), StudiesCollection, Statistics