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

Constructors

Constructor and Description
StudyConstant(StudyType studyType, int id) Provides access to the StudyConstant object

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Color	getColor() Gets or sets the color for a selected StudyConstant object.
java.util.Collection<CustomGridLine>	getCustomGridLines() Returns the collection of CustomGridLines associated with a StudyConstant object.
DashStyle	getLineStyle() Gets or sets the line style for a selected StudyConstant object.
int	getLineWidth() Gets or sets the line width for a selected StudyConstant object.
java.lang.String	getText() Gets or sets the string used for the selected StudyConstant's title.
boolean	isShowLabel() Gets or sets a value indicating whether configured text will be displayed for the StudyConstant object.
void	resetColor() Set the property Color to its default value.
void	resetLineStyle() Set the property LineStyle to its default value.
void	resetLineWidth() Set the property LineWidth to its default value.
void	resetShowLabel() Set the property ShowLabel to its default value.
void	setColor(java.awt.Color value) Gets or sets the color for a selected StudyConstant object.
void	setLineStyle(DashStyle 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 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, getValue, getValue, isBold, isIndented, resetBold, resetDecimals, resetIndented, resetText, 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(StudyType studyType,
             int id)

Provides access to the StudyConstant object

Parameters:

studyType -

id -

Method Detail

getColor

public java.awt.Color getColor()

Gets or sets the color for a selected StudyConstant object.

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

• The setLineStyle and setLineWidth are used to control the style and width for the StudyConstant object.

To set the color to blue for a selected StudyConstant object:

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 StudyConstant object.

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

• The setLineStyle and setLineWidth are used to control the style and width for the StudyConstant object.

To set the color to blue for a selected StudyConstant object:

Parameters:

value -

See Also:

resetColor

getCustomGridLines

public java.util.Collection<CustomGridLine> getCustomGridLines()

Returns the collection of CustomGridLines associated with a StudyConstant object.

getLineStyle

public DashStyle getLineStyle()

Gets or sets the line style for a selected StudyConstant object.

• 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 and setLineWidth methods, respectively.

To configure the LineStyle for a selected StudyConstant object:

See Also:

resetLineStyle

setLineStyle

public void setLineStyle(DashStyle value)

Gets or sets the line style for a selected StudyConstant object.

• 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 and setLineWidth methods, respectively.

To configure the LineStyle for a selected StudyConstant object:

Parameters:

value -

See Also:

resetLineStyle

getLineWidth

public int getLineWidth()

Gets or sets the line width for a selected StudyConstant object.

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 and setLineStyle methods, respectively.

To configure the LineWidth for a selected StudyConstant object:

See Also:

resetLineWidth

setLineWidth

public void setLineWidth(int value)

Gets or sets the line width for a selected StudyConstant object.

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 and setLineStyle methods, respectively.

To configure the LineWidth for a selected StudyConstant object:

Parameters:

value -

See Also:

resetLineWidth

isShowLabel

public boolean isShowLabel()

Gets or sets a value indicating whether configured text will be displayed for the StudyConstant object.

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

The setText method may be used to get or set a text string for a given StudyConstant object.

To configire a StudyConstant object to display configured labels:

See Also:

resetShowLabel

setShowLabel

public void setShowLabel(boolean value)

Gets or sets a value indicating whether configured text will be displayed for the StudyConstant object.

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

The setText method may be used to get or set a text string for a given StudyConstant object.

To configire a StudyConstant object to display configured labels:

Parameters:

value -

See Also:

resetShowLabel

getText

public java.lang.String getText()

Gets or sets the string used for the selected StudyConstant's title.

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

The isShowLabel method 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.

To set a label for a StudyConstant object:

Specified by:

getText in interface IStudy

Overrides:

getText in class Study

See Also:

resetText

setText

public void setText(java.lang.String value)

Gets or sets the string used for the selected StudyConstant's title.

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

The isShowLabel method 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.

To set a label for a StudyConstant object:

Overrides:

setText in class Study

Parameters:

value -

See Also:

resetText

resetColor

public void resetColor()

Set the property Color to its default value.

See Also:

setColor

resetLineStyle

public void resetLineStyle()

Set the property LineStyle to its default value.

See Also:

setLineStyle

resetLineWidth

public void resetLineWidth()

Set the property LineWidth to its default value.

See Also:

setLineWidth

resetShowLabel

public void resetShowLabel()

Set the property ShowLabel to its default value.

See Also:

isShowLabel