com.softwarefx.chartfx.server.annotation
Class AnnotationListBase

java.lang.Object
  com.softwarefx.chartfx.server.annotation.AnnotationListBase

Direct Known Subclasses:

AnnotationList, SelectionList

public abstract class AnnotationListBase
extends Object

Provides access to the AnnotationListBase object.

The AnnotationListBase Class is the base Class for the annotation list object. The supported members of this Class are inherited by the AnnotationList Class and should be accessed through the List property of Annotations Class .

To access the item property of this class:

com.softwarefx.chartfx.server.annotation.Annotations annot = new com.softwarefx.chartfx.server.annotation.Annotations();

chart1.getExtensions().add(annot);

annot.getList().get(0).getBorder().setColor(java.awt.Color.yellow);

Constructor Summary

AnnotationListBase()

Method Summary

void	add(AnnotationObject annObj) Used to add an object to the end of an annotation group or to the entire annotation objects list.
boolean	contains(AnnotationObject annObj) Determines whether an annotation list or group contains a specific element.
void	copyTo(AnnotationObject[] array, int index) Copies the elements of this collection into the specified array.
AnnotationObject	get(int n) Returns the element at the specified position in the AnnotationListBase.
AnnotationObject	hitTest(com.softwarefx.chartfx.server.annotation.AnnotationListBase.HitTest_Point_Enum_r _p_) Allows you to simulate a mouse click in a particular x,y position in the chart and returns a flag specifying the hit type.
int	indexOf(AnnotationObject annObject) Returns the zero based index of a specific item in a list.
void	insert(int index, AnnotationObject annObj) Inserts an element into the selected annotation collection at the specified index.
void	remove(AnnotationObject annObj) Removes the first occurrence of a specified annotation object from the selected collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationListBase

public AnnotationListBase()

Method Detail

add

public void add(AnnotationObject annObj)

Used to add an object to the end of an annotation group or to the entire annotation objects list.

Remarks:

This method allows you to add annotation objects to the annotation list, SelectionList, annotation groups, etc.

Other supported members of the AnnotationListBase Class allow you insert(int, com.softwarefx.chartfx.server.annotation.AnnotationObject) and remove(com.softwarefx.chartfx.server.annotation.AnnotationObject) annotation objects from an annotation list or group.

Before you can add any annotation objects to the annotation list, you must first create the annotation list object. Once created you may begin adding individual annotation objects to the list.

Parameters:

annObj - Annotation object to add.

See Also:

contains(com.softwarefx.chartfx.server.annotation.AnnotationObject), insert(int, com.softwarefx.chartfx.server.annotation.AnnotationObject), remove(com.softwarefx.chartfx.server.annotation.AnnotationObject), Annotations, AnnotationList

contains

public boolean contains(AnnotationObject annObj)

Determines whether an annotation list or group contains a specific element.

Remarks:

This method will return True if the collection contains the specified object; otherwise, False.

Parameters:

annObj - The annotation object to locate in the Collection.

See Also:

add(com.softwarefx.chartfx.server.annotation.AnnotationObject), insert(int, com.softwarefx.chartfx.server.annotation.AnnotationObject), remove(com.softwarefx.chartfx.server.annotation.AnnotationObject), Annotations

copyTo

public void copyTo(AnnotationObject[] array,
                   int index)

Copies the elements of this collection into the specified array.

Remarks:

This method allows you to copy a collection into an array object.

The IndexOf method allows you to determine the index of a specific item in the list.

Parameters:

array - The array to copy data to.

index - The count of elements to copy.

See Also:

indexOf(com.softwarefx.chartfx.server.annotation.AnnotationObject)

get

public AnnotationObject get(int n)

Returns the element at the specified position in the AnnotationListBase.

Parameters:

n - Index of element to return.

hitTest

public AnnotationObject hitTest(com.softwarefx.chartfx.server.annotation.AnnotationListBase.HitTest_Point_Enum_r _p_)

Allows you to simulate a mouse click in a particular x,y position in the chart and returns a flag specifying the hit type.

Remarks:

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:

_p_ -

See Also:

Chart

indexOf

public int indexOf(AnnotationObject annObject)

Returns the zero based index of a specific item in a list.

Remarks:

This is useful to find the position of a specific item in the array list.

The copyTo(com.softwarefx.chartfx.server.annotation.AnnotationObject[], int) method allows you to copy elements of this collection into the specified array.

Parameters:

annObject - Annotation object to determine the index of.

See Also:

copyTo(com.softwarefx.chartfx.server.annotation.AnnotationObject[], int)

insert

public void insert(int index,
                   AnnotationObject annObj)

Inserts an element into the selected annotation collection at the specified index.

Remarks:

The add(com.softwarefx.chartfx.server.annotation.AnnotationObject) method is used to add an annotation object to the end of a list or group. The Insert method allows you to insert the object at a specified index.

The get(int) property may be used to access an annotation object by index from a selected collection.

The contains(com.softwarefx.chartfx.server.annotation.AnnotationObject) method allows you to find if a particular annotation object is included in a selected collection.

Parameters:

index - Collection index to insert annotation object.

annObj - Annotation object to insert.

See Also:

add(com.softwarefx.chartfx.server.annotation.AnnotationObject), contains(com.softwarefx.chartfx.server.annotation.AnnotationObject), Annotations

remove

public void remove(AnnotationObject annObj)

Removes the first occurrence of a specified annotation object from the selected collection.

Remarks:

The add(com.softwarefx.chartfx.server.annotation.AnnotationObject) method may be used to add annotation objects to a selected annotation list or group. You may also insert an object at a specified index value using the insert(int, com.softwarefx.chartfx.server.annotation.AnnotationObject) method.

The contains(com.softwarefx.chartfx.server.annotation.AnnotationObject) method will allow you to determine if a specific annotation object has been added to a group or list.

Parameters:

annObj - Annotation object to remove.

See Also:

add(com.softwarefx.chartfx.server.annotation.AnnotationObject), contains(com.softwarefx.chartfx.server.annotation.AnnotationObject), insert(int, com.softwarefx.chartfx.server.annotation.AnnotationObject), Annotations