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 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

Constructors

Constructor and Description
StudyCustom(int id, java.lang.String text) Provides access to the StudyCustom object

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Color	getColor() Gets or sets the color for a selected StudyCustom object.
void	resetColor() Set the property Color to its default value.
void	setColor(java.awt.Color value) Gets or sets the color for a selected StudyCustom object.

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

getAxis, isInteractive, isVisible, resetInteractive, resetVisible, setAxis, setInteractive, setVisible

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

createAnalysisMultiStudy, createAnalysisStudy, createDistributionFormulaStudy, createTestMultiStudy, createTestStudy, getDecimals, getID, getText, getValue, getValue, isBold, isIndented, resetBold, resetDecimals, resetIndented, resetText, 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)

Provides access to the StudyCustom object

Parameters:

id -

text -

Method Detail

getColor

public java.awt.Color getColor()

Gets or sets the color for a selected StudyCustom object.

• The setStudies method of the Statistics class exposes the members of the StudiesCollection class. Using the addTitle 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 isInteractive (true), the checkbox for the study will display the color configured using this method when selected.
• The setValue method allows you to configure a string as the result for the StudyCustom object.
• The isIndented method allows you to control if the selected study's title will be indented or not.

To configure the Color for a StudyCustom object to red:

Specified by:

getColor in interface IStudy

Overrides:

getColor in class Study

See Also:

resetColor

setColor

public void setColor(java.awt.Color value)

Gets or sets the color for a selected StudyCustom object.

• The setStudies method of the Statistics class exposes the members of the StudiesCollection class. Using the addTitle 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 isInteractive (true), the checkbox for the study will display the color configured using this method when selected.
• The setValue method allows you to configure a string as the result for the StudyCustom object.
• The isIndented method allows you to control if the selected study's title will be indented or not.

To configure the Color for a StudyCustom object to red:

Parameters:

value -

See Also:

resetColor

resetColor

public void resetColor()

Set the property Color to its default value.

See Also:

setColor