com.softwarefx.chartfx.server.statistical
Class StudyCustom

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

All Implemented Interfaces:

IStudy

public class StudyCustom
extends StudyInteractive
implements IStudy

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, String text)

Method Summary

Color	getColor() Gets the Color.
void	setColor(Color value) Sets the color for a selected StudyCustom object.

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

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

Constructor Detail

StudyCustom

public StudyCustom(int id,
                   String text)

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

setColor

public void setColor(Color value)

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:

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