SoftwareFX.ChartFX.Annotation
Class AnnotationX

java.lang.Object
  SoftwareFX.ChartFX.Annotation.AnnotationX

public final class AnnotationX
extends java.lang.Object

Provides access to the AnnotationX object.

The AnnotationX 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 property:

SoftwareFX.ChartFX.Annotation.AnnotationX annot = new SoftwareFX.ChartFX.Annotation.AnnotationX();

chart1.getExtensions().add(annot);

Constructor Summary

AnnotationX()

Method Summary

Command	getCommand(int nID) Deprecated. You should use getCommands() instead.
CommandBar	getCommands() Gets the list of commands associated with the Annotation Extension.
java.awt.Color	getDefaultBorderColor() Gets the DefaultBorderColor.
java.awt.Color	getDefaultFillColor() Gets the DefaultFillColor.
AnnotationList	getList() Allows you to access the CollectionBase members used modify the annotation list.
AnnotationObject	getList(int n) Deprecated. You should use getList() instead.
ToolBar	getToolBarObj() Allows you to assign supported attributes directly the annotation ToolBar object.
int	getToolBarObj(int n) Deprecated. You should use getToolBarObj() instead.
boolean	isDirty() Gets the Dirty.
boolean	isEnabled() Gets the Enabled.
boolean	isToolBar() Gets the ToolBar.
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	setEnabled(boolean value) Used to allow/prevent the user from interacting with objects you add programmatically.
void	setToolBar(boolean value) Used to show and hide the annotation toolbar in the chart area.
void	setToolBarObj(int n, int value) Deprecated. You should use getToolBarObj() instead.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnnotationX

public AnnotationX()

Method Detail

getCommand

public Command getCommand(int nID)

Deprecated. You should use getCommands() instead.

getCommands

public CommandBar getCommands()

Gets the list of commands associated with the Annotation Extension.

Remarks:

Customizing the Annotation Toolbar works exactly like customizing the Chart FX toolbar. Please see the Customizing Tools section in the Programmer's Guide for a more detailed explaination of this process.

When customizing the Annotation Toolbar, you may reference the pre-defined annotation commands. To do so, you will access the AnnCommandID enumeration located at the following namespace:

SoftwareFX.ChartFX.Annotation.AnnCommandID

See Also:

Command

getDefaultBorderColor

public java.awt.Color getDefaultBorderColor()

Gets the DefaultBorderColor. For more detail see setDefaultBorderColor(java.awt.Color).

getDefaultFillColor

public java.awt.Color getDefaultFillColor()

Gets the DefaultFillColor. For more detail see setDefaultFillColor(java.awt.Color).

getList

public AnnotationObject getList(int n)

Deprecated. You should use getList() instead.

getList

public AnnotationList getList()

Allows you to access the CollectionBase members used modify the annotation list.

Remarks:

Using this property, you will have access to add and remove items from the annotation list. You can also count the number of current items on the list.

This property is used to create the annotation lists. Once the annotation list has been created and applied to the chart, you can see the annotation objects in the chart area.

getToolBarObj

public int getToolBarObj(int n)

Deprecated. You should use getToolBarObj() instead.

getToolBarObj

public ToolBar getToolBarObj()

Allows you to assign supported attributes directly the annotation ToolBar object.

Remarks:

The setToolBar(boolean) property is used to display the Annotation ToolBar. However, when enabling the Annoation ToolBar, you must first set setEnabled(boolean) to True for the Annotation Extension object before the extension is added to the Chart.

AnnotationX annotx = new AnnotationX();
annotx.Enabled = true;
chart1.Extensions.Add(annotx);
annotx.ToolBar = true;


This property may be used to set visual attributes as well as adding custom and predefined commands to the Annotation ToolBar.

For supported members of the Annotation ToolBar, please refer to the supported properties of the ToolBar class.

See Also:

setToolBar(boolean), setEnabled(boolean), ToolBar

isDirty

public boolean isDirty()

Gets the Dirty. For more detail see setDirty(boolean).

isEnabled

public boolean isEnabled()

Gets the Enabled. For more detail see setEnabled(boolean).

isToolBar

public boolean isToolBar()

Gets the ToolBar. For more detail see setToolBar(boolean).

setDefaultBorderColor

public void setDefaultBorderColor(java.awt.Color value)

Used to set the border color for annotation objects created using the annotation toolbar.

Remarks:

Setting this property to a color will instruct Chart FX to use the configured color as the border color for all objects created using the annotation toolbar.

You setDefaultFillColor(java.awt.Color) allows you to configure the fill color for all annotation objects created using the annotation toolbar.

The setToolBar(boolean) property is used to display the annotation toolbar in the chart. You must create the annotation extension object, set the enabled attribute to true, and add the annotation extension to the chart. At this point you may set the setToolBar(boolean) Property to True to make the toolbar visible.

See Also:

setDefaultFillColor(java.awt.Color), setToolBar(boolean)

setDefaultFillColor

public void setDefaultFillColor(java.awt.Color value)

Used to set the fill color for annotation objects created using the annotation toolbar.

Remarks:

Setting this property to a color will instruct Chart FX to use the configured color as the fill color for all objects created using the annotation toolbar.

You setDefaultBorderColor(java.awt.Color) allows you to configure the border color for all annotation objects created using the annotation toolbar.

The setToolBar(boolean) property is used to display the annotation toolbar in the chart. You must create the annotation extension object, set the enabled attribute to true, and add the annotation extension to the chart. At this point you may set the setToolBar(boolean) Property to True to make the toolbar visible.

See Also:

setDefaultBorderColor(java.awt.Color), setToolBar(boolean), setEnabled(boolean)

setDirty

public void setDirty(boolean value)

Returns a boolean specifying if the annotation extension object has been modified.

Remarks:

When True is returned the annotation extension has been modified, therefore the extension has been marked 'Dirty'.

This get property 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 property will also return True.

See Also:

getList(int)

setEnabled

public void setEnabled(boolean value)

Used to allow/prevent the user from interacting with objects you add programmatically.

Remarks:

When set to true, users are allowed to interact with annotation objects created programmatically. When set to false, users do not have access.

The setToolBar(boolean) property is used to display the annotation toolbar in the chart. You must create the annotation extension object, set the enabled attribute to true, and add the annotation extension to the chart. At this point you may set the setToolBar(boolean) Property to True to make the toolbar visible.

See Also:

AnnotationObject.setAllowModify(boolean), AnnotationObject.setAllowMove(boolean), setToolBar(boolean), AnnotationObject

setToolBar

public void setToolBar(boolean value)

Used to show and hide the annotation toolbar in the chart area.

Remarks:

You will need to add the annotation extension to your projects using the ChartCore.getExtensions() property of the Chart class.

The setEnabled(boolean) property controls if the user is able to interact with objects you add programmatically. It also must be set to True in order to display the annotation toolbar.

The setToolBar(boolean) property is used to display the annotation toolbar in the chart. You must create the annotation extension object, set the setEnabled(boolean) attribute to true, and add the annotation extension to the chart. At this point you may set the setToolBar(boolean) Property to True to make the toolbar visible.

AnnotationX annotx = new AnnotationX();
annotx.setEnabled(true);
chart1.getExtensions().add(annotx);
annotx.setToolBar(true);


See Also:

ChartCore.getExtensions(), setEnabled(boolean), Chart

setToolBarObj

public void setToolBarObj(int n,
                          int value)

Deprecated. You should use getToolBarObj() instead.