Annotations (Chart FX for Java 8.0 API Specification)

java.lang.Object
- com.softwarefx.chartfx.server.annotation.Annotations

All Implemented Interfaces:

IExtension
```
public class Annotations
extends java.lang.Object
implements IExtension
```
Provides access to the Annotations object.
The Annotations class is used to create the Annotation Extension object. The Annotation Extension object must be added to your charting application if you plan on using any of the Annotation features. Once the Annotation Extension object has been created, the supported members of this class allow you to select the type of annotation list you will create. The annotation list will consist of all the individual annotation objects which will be included in a chart. Once the desired objects have been added to the annotation list and the annotation list has been added to the Annotation Extension object, the Annotation Extension object may be added to your charting application.
Below is an example of creating an Annotation Extension object and adding it to the chart using the Extension method:

Constructor Summary

Constructors
Constructor and Description

Annotations()
Constructs a newly allocated Annotations object

Constructors
Constructor and Description
`Annotations()` Constructs a newly allocated Annotations object

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addClickListener(AnnotationListener value)` Adds a ClickListener to the listener list.
`void`	`addInternalCommandListener(AnnotationCommandListener value)` Adds a InternalCommandListener to the listener list.
`void`	`addUserCommandListener(AnnotationCommandListener value)` Adds a UserCommandListener to the listener list.
`Chart`	`getChart()` Gets or sets the Chart object for the Annotations object.
`com.softwarefx.server.CommandCollection`	`getCommands()` Gets the list of commands associated with the Annotation Extension.
`java.awt.Color`	`getDefaultBorderColor()` Used to set the border color for annotation objects created using the annotation toolbar.
`java.awt.Color`	`getDefaultFillColor()` Used to set the fill color for annotation objects created using the annotation toolbar.
`AnnotationList`	`getList()` Allows you to access the CollectionBase members used modify the annotation list.
`java.lang.Class<?>`	`getNewObjectType()` Allows you to select the type of the object to be created by the next mouse or keyboard input.
`AnnotationListBase`	`getSelectionList()` Allows you to set attributes directly to a selected list of annotation objects.
`AnnotationObject`	`hitTest(int x, int y)` Allows you to simulate a mouse click in a particular x,y position in the chart.
`boolean`	`isDirty()` Returns a boolean specifying if the annotation extension object has been modified.
`boolean`	`isEnableViewState()` Gets or sets a value indicating whether the server object persists its view state.
`void`	`removeClickListener(AnnotationListener value)` Removes a ClickListener from the listener list.
`void`	`removeInternalCommandListener(AnnotationCommandListener value)` Removes a InternalCommandListener from the listener list.
`void`	`removeUserCommandListener(AnnotationCommandListener value)` Removes a UserCommandListener from the listener list.
`void`	`setChart(Chart value)` Gets or sets the Chart object for the Annotations object.
`void`	`setDefaultBorderColor(java.awt.Color value)` Used to set the border color for annotation objects created using the annotation toolbar.
`void`	`setDefaultFillColor(java.awt.Color value)` Used to set the fill color for annotation objects created using the annotation toolbar.
`void`	`setDirty(boolean value)` Returns a boolean specifying if the annotation extension object has been modified.
`void`	`setEnableViewState(boolean value)` Gets or sets a value indicating whether the server object persists its view state.
`void`	`setNewObjectType(java.lang.Class<?> value)` Allows you to select the type of the object to be created by the next mouse or keyboard input.

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

- Constructor Detail
  - Annotations
```
public Annotations()
```
    Constructs a newly allocated Annotations object
- Method Detail
  - getChart
```
public Chart getChart()
```
    Gets or sets the Chart object for the Annotations object.
    
    To configure the attach the Annotation Extension to a chart:
    Java
    Annotations annExt; annExt = new Annotations(); annExt.setChart(chart1);
  - setChart
```
public void setChart(Chart value)
```
    Gets or sets the Chart object for the Annotations object.
    
    To configure the attach the Annotation Extension to a chart:
    Java
    Annotations annExt; annExt = new Annotations(); annExt.setChart(chart1);
    Parameters:
    value -
  - getCommands
```
public com.softwarefx.server.CommandCollection getCommands()
```
    Gets the list of commands associated with the Annotation Extension.
  - getDefaultBorderColor
```
public java.awt.Color getDefaultBorderColor()
```
    Used to set the border color for annotation objects created using the annotation toolbar.
  - setDefaultBorderColor
```
public void setDefaultBorderColor(java.awt.Color value)
```
    Used to set the border color for annotation objects created using the annotation toolbar.
    Parameters:
    value -
  - getDefaultFillColor
```
public java.awt.Color getDefaultFillColor()
```
    Used to set the fill color for annotation objects created using the annotation toolbar.
  - setDefaultFillColor
```
public void setDefaultFillColor(java.awt.Color value)
```
    Used to set the fill color for annotation objects created using the annotation toolbar.
    Parameters:
    value -
  - isDirty
```
public boolean isDirty()
```
    Returns a boolean specifying if the annotation extension object has been modified.
    
    When True is returned the annotation extension has been modified, therefore the extension has been marked 'Dirty'.
    This method allows you to detect if a user has added an annotaton object to the chart via the annotation TooBar. When an object has been added to the annotation extension programmatically by the developer, this method will also return True.
    To determine whether the annotation extension has been marked dirty:
  - setDirty
```
public void setDirty(boolean value)
```
    Returns a boolean specifying if the annotation extension object has been modified.
    
    When True is returned the annotation extension has been modified, therefore the extension has been marked 'Dirty'.
    This method allows you to detect if a user has added an annotaton object to the chart via the annotation TooBar. When an object has been added to the annotation extension programmatically by the developer, this method will also return True.
    To determine whether the annotation extension has been marked dirty:
    Parameters:
    value -
  - isEnableViewState
```
public boolean isEnableViewState()
```
    Gets or sets a value indicating whether the server object persists its view state.
  - setEnableViewState
```
public void setEnableViewState(boolean value)
```
    Gets or sets a value indicating whether the server object persists its view state.
    Parameters:
    value -
  - getList
```
public AnnotationList getList()
```
    Allows you to access the CollectionBase members used modify the annotation list.
  - getNewObjectType
```
public java.lang.Class<?> getNewObjectType()
```
    Allows you to select the type of the object to be created by the next mouse or keyboard input.
  - setNewObjectType
```
public void setNewObjectType(java.lang.Class<?> value)
```
    Allows you to select the type of the object to be created by the next mouse or keyboard input.
    Parameters:
    value -
  - getSelectionList
```
public AnnotationListBase getSelectionList()
```
    Allows you to set attributes directly to a selected list of annotation objects.
  - hitTest
```
public AnnotationObject hitTest(int x,
                       int y)
```
    Allows you to simulate a mouse click in a particular x,y position in the chart.
    You can use this method in conjunction with any of the Chart FX mouse clicks events to check if a particular annotation object is located where the user clicked.
    
    Parameters:
    x - The X position in chart coordinates (pixel value).
    y - The Y position in chart coordinates (pixel value).
  - addClickListener
```
public void addClickListener(AnnotationListener value)
```
    Adds a ClickListener to the listener list.
    Parameters:
    value -
  - removeClickListener
```
public void removeClickListener(AnnotationListener value)
```
    Removes a ClickListener from the listener list.
    Parameters:
    value -
  - addInternalCommandListener
```
public void addInternalCommandListener(AnnotationCommandListener value)
```
    Adds a InternalCommandListener to the listener list.
    
    Parameters:
    value -
  - removeInternalCommandListener
```
public void removeInternalCommandListener(AnnotationCommandListener value)
```
    Removes a InternalCommandListener from the listener list.
    
    Parameters:
    value -
  - addUserCommandListener
```
public void addUserCommandListener(AnnotationCommandListener value)
```
    Adds a UserCommandListener to the listener list.
    
    Parameters:
    value -
  - removeUserCommandListener
```
public void removeUserCommandListener(AnnotationCommandListener value)
```
    Removes a UserCommandListener from the listener list.
    
    Parameters:
    value -

Class Annotations

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Annotations

Method Detail

getChart

setChart

getCommands

getDefaultBorderColor

setDefaultBorderColor

getDefaultFillColor

setDefaultFillColor

isDirty

setDirty

isEnableViewState

setEnableViewState

getList

getNewObjectType

setNewObjectType

getSelectionList

hitTest

addClickListener

removeClickListener

addInternalCommandListener

removeInternalCommandListener

addUserCommandListener

removeUserCommandListener