Study (Chart FX for Java 8.0 API Specification)

java.lang.Object
- com.softwarefx.chartfx.server.statistical.Study

All Implemented Interfaces:

IStudy

Direct Known Subclasses:

StudyInteractive, StudyTest
```
public class Study
extends java.lang.Object
implements IStudy
```
Provides access to the Study object
The Study class provides developers with an API to control general attributes consistent with all the supported studies of the Chart FX Statistical Extention. These members may be used to customize statistic studies in the chart. All study specific classes are derived from this class.

Constructor Summary

Constructors
Constructor and Description

Study(StudyType studyType, int id)
Provides access to the Study object

Constructors
Constructor and Description
`Study(StudyType studyType, int id)` Provides access to the Study object

Method Summary

Methods
Modifier and Type	Method and Description
`static Study`	`createAnalysisMultiStudy(AnalysisMulti analysis)` Used to create a study without adding the study to the StudiesCollection.
`static Study`	`createAnalysisStudy(Analysis analysis)` Used to create a study without adding the study to the StudiesCollection.
`static StudyFormula`	`createDistributionFormulaStudy(DistributionFormula distribution)` Used to create a study without adding the study to the StudiesCollection.
`static StudyTest`	`createTestMultiStudy(TestMulti test)` Used to create a study without adding the study to the StudiesCollection.
`static StudyTest`	`createTestStudy(Test test)` Used to create a study without adding the study to the StudiesCollection.
`java.awt.Color`	`getColor()` Description goes here
`int`	`getDecimals()` Gets or sets the number of decimal spaces displayed for a study.
`int`	`getID()` Returns the Id of a study object.
`java.lang.String`	`getText()` Gets or sets the string used for the selected study's title.
`double`	`getValue()` Description goes here
`java.lang.String`	`getValue(int series)` Description goes here
`boolean`	`isBold()` Gets or sets a value indicating whether the selected study's title will be bold.
`boolean`	`isIndented()` Gets or sets a value indicating whether the selected study's title will indent.
`boolean`	`isInteractive()` Description goes here
`boolean`	`isVisible()` Description goes here
`void`	`resetBold()` Set the property Bold to its default value.
`void`	`resetDecimals()` Set the property Decimals to its default value.
`void`	`resetIndented()` Set the property Indented to its default value.
`void`	`resetText()` Set the property Text to its default value.
`void`	`setBold(boolean value)` Gets or sets a value indicating whether the selected study's title will be bold.
`void`	`setDecimals(int value)` Gets or sets the number of decimal spaces displayed for a study.
`void`	`setIndented(boolean value)` Gets or sets a value indicating whether the selected study's title will indent.
`void`	`setText(java.lang.String value)` Gets or sets the string used for the selected study's title.
`void`	`setValue(double value)` Gets or sets the value for a StudyCustom object.
`void`	`setVisible(boolean value)` Description goes here

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Study
```
public Study(StudyType studyType,
     int id)
```
    Provides access to the Study object
    
    Parameters:
    studyType -
    id -
- Method Detail
  - isBold
```
public boolean isBold()
```
    Gets or sets a value indicating whether the selected study's title will be bold.
    - The setStudies method of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies method may also be used to obain the entire StudiesCollection.
    - The setText method allows you to customize the text for a selected study's title.
    - The isIndented method allows you to control if the selected study's title will be indented or not.
    To set the first study of the StudiesCollection to have a bold title:
    Specified by:
    
    isBold in interface IStudy
    
    See Also:
    resetBold
  - setBold
```
public void setBold(boolean value)
```
    Gets or sets a value indicating whether the selected study's title will be bold.
    - The setStudies method of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies method may also be used to obain the entire StudiesCollection.
    - The setText method allows you to customize the text for a selected study's title.
    - The isIndented method allows you to control if the selected study's title will be indented or not.
    To set the first study of the StudiesCollection to have a bold title:
    Specified by:
    
    setBold in interface IStudy
    
    Parameters:
    value -
    See Also:
    resetBold
  - getColor
```
public java.awt.Color getColor()
```
    Description goes here
    
    Specified by:
    
    getColor in interface IStudy
  - getDecimals
```
public int getDecimals()
```
    Gets or sets the number of decimal spaces displayed for a study.
    - The setStudies method of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies method may also be used to obain the entire StudiesCollection.
    - The setText method allows you to customize the text for a selected study's title.
    - The isBold method allows you to display the study's title bold or in non-bold font.
    To set the number of decimal places to 9:
    See Also:
    resetDecimals
  - setDecimals
```
public void setDecimals(int value)
```
    Gets or sets the number of decimal spaces displayed for a study.
    - The setStudies method of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies method may also be used to obain the entire StudiesCollection.
    - The setText method allows you to customize the text for a selected study's title.
    - The isBold method allows you to display the study's title bold or in non-bold font.
    To set the number of decimal places to 9:
    Parameters:
    value -
    See Also:
    resetDecimals
  - getID
```
public int getID()
```
    Returns the Id of a study object.
  - isIndented
```
public boolean isIndented()
```
    Gets or sets a value indicating whether the selected study's title will indent.
    - The setStudies method of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies method may also be used to obain the entire StudiesCollection.
    - The setText method allows you to customize the text for a selected study's title.
    - The isBold method allows you to display the study's title bold or in non-bold font.
    To indent the 2nd study of the StudiesCollection:
    Specified by:
    
    isIndented in interface IStudy
    
    See Also:
    resetIndented
  - setIndented
```
public void setIndented(boolean value)
```
    Gets or sets a value indicating whether the selected study's title will indent.
    - The setStudies method of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies method may also be used to obain the entire StudiesCollection.
    - The setText method allows you to customize the text for a selected study's title.
    - The isBold method allows you to display the study's title bold or in non-bold font.
    To indent the 2nd study of the StudiesCollection:
    Specified by:
    
    setIndented in interface IStudy
    
    Parameters:
    value -
    See Also:
    resetIndented
  - isInteractive
```
public boolean isInteractive()
```
    Description goes here
    
    Specified by:
    
    isInteractive in interface IStudy
  - getText
```
public java.lang.String getText()
```
    Gets or sets the string used for the selected study's title.
    - The setStudies method of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies method may also be used to obain the entire StudiesCollection.
    - The isBold method allows you to display the study's title bold or in non-bold font.
    - The isIndented method allows you to control if the selected study's title will be indented or not.
    To set the text for the first study in the StudiesCollection:
    Specified by:
    
    getText in interface IStudy
    
    See Also:
    resetText
  - setText
```
public void setText(java.lang.String value)
```
    Gets or sets the string used for the selected study's title.
    - The setStudies method of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies method may also be used to obain the entire StudiesCollection.
    - The isBold method allows you to display the study's title bold or in non-bold font.
    - The isIndented method allows you to control if the selected study's title will be indented or not.
    To set the text for the first study in the StudiesCollection:
    Parameters:
    value -
    See Also:
    resetText
  - getValue
```
public double getValue()
```
    Description goes here
  - setValue
```
public void setValue(double value)
```
    Gets or sets the value for a StudyCustom object.
    Parameters:
    value -
  - isVisible
```
public boolean isVisible()
```
    Description goes here
    
    Specified by:
    
    isVisible in interface IStudy
  - setVisible
```
public void setVisible(boolean value)
```
    Description goes here
    
    Specified by:
    
    setVisible in interface IStudy
    
    Parameters:
    value -
  - createAnalysisMultiStudy
```
public static Study createAnalysisMultiStudy(AnalysisMulti analysis)
```
    Used to create a study without adding the study to the StudiesCollection.
    
    This method is used to create a selected study without adding it to the StudiesCollection object. The Add method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.
    To create an Analysis study (Upper Quartile):
    Parameters:
    analysis - Create an AnalysisMulti study.
  - createAnalysisStudy
```
public static Study createAnalysisStudy(Analysis analysis)
```
    Used to create a study without adding the study to the StudiesCollection.
    
    This method is used to create a selected study without adding it to the StudiesCollection object. The Add method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.
    To create an Analysis study (Upper Quartile):
    Parameters:
    analysis - Create a Analysis study.
  - createDistributionFormulaStudy
```
public static StudyFormula createDistributionFormulaStudy(DistributionFormula distribution)
```
    Used to create a study without adding the study to the StudiesCollection.
    
    This method is used to create a selected study without adding it to the StudiesCollection object. The Add method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.
    To create an Analysis study (Upper Quartile):
    Parameters:
    distribution - Create a DistributionFormula study.
  - createTestMultiStudy
```
public static StudyTest createTestMultiStudy(TestMulti test)
```
    Used to create a study without adding the study to the StudiesCollection.
    
    This method is used to create a selected study without adding it to the StudiesCollection object. The Add method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.
    To create an Analysis study (Upper Quartile):
    Parameters:
    test - Create a TestMulti study.
  - createTestStudy
```
public static StudyTest createTestStudy(Test test)
```
    Used to create a study without adding the study to the StudiesCollection.
    
    This method is used to create a selected study without adding it to the StudiesCollection object. The Add method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.
    To create an Analysis study (Upper Quartile):
    Parameters:
    test -
  - getValue
```
public java.lang.String getValue(int series)
```
    Description goes here
    
    Specified by:
    
    getValue in interface IStudy
    
    Parameters:
    series -
  - resetBold
```
public void resetBold()
```
    Set the property Bold to its default value.
    
    See Also:
    isBold
  - resetDecimals
```
public void resetDecimals()
```
    Set the property Decimals to its default value.
    
    See Also:
    setDecimals
  - resetIndented
```
public void resetIndented()
```
    Set the property Indented to its default value.
    
    See Also:
    isIndented
  - resetText
```
public void resetText()
```
    Set the property Text to its default value.
    
    See Also:
    setText

Class Study

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Study

Method Detail

isBold

setBold

getColor

getDecimals

setDecimals

getID

isIndented

setIndented

isInteractive

getText

setText

getValue

setValue

isVisible

setVisible

createAnalysisMultiStudy

createAnalysisStudy

createDistributionFormulaStudy

createTestMultiStudy

createTestStudy

getValue

resetBold

resetDecimals

resetIndented

resetText