com.softwarefx.chartfx.server.annotation
Class AnnotationList

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

All Implemented Interfaces:

Iterable<Object>, Collection<Object>

public class AnnotationList
extends AnnotationListBase
implements Iterable<Object>, Collection<Object>

Provides access to the AnnotationList object.

The Annotation list consists of all the individual annotation objects that you would like to include in your charting application. Once all the desired annotation objects have been added to the list, the annotation extension object may be added to the chart using the Extensions property.

The AnnotationList Class supports or supplies access to all the properties and methods used to create, modify and maintain the annotation list.

Constructor Summary

AnnotationList()

AnnotationList(Annotations annotations)

Method Summary

boolean	add(Object o) Used to add an object to the end of an annotation group or to the entire annotation objects list.
boolean	addAll(Collection<? extends Object> c) Adds all of the elements in the specified collection to the AnnotationList collection.
void	clear() Removes all of the elements from this collection.
boolean	contains(Object o) Determines whether an annotation list or group contains a specific element.
boolean	containsAll(Collection<?> c) Returns true if the AnnotationList collection contains all of the elements in the specified collection.
int	getCurrentObjectIndex() Get the index of the current object in the Annotation list.
boolean	isEmpty() Returns true if this collection contains no elements.
Iterator<Object>	iterator() Returns an iterator over the elements in this collection.
boolean	remove(Object o) Removes the first occurrence of a specified annotation object from the selected collection.
boolean	removeAll(Collection<?> c) Removes all of the elements in the specified collection from the AnnotationList collection.
boolean	retainAll(Collection<?> c) Retains only the elements in the AnnotationList collection that are contained in the specified collection.
int	size() Returns the number of elements in this collection.
Object[]	toArray() Returns an array containing all of the elements in this collection in proper sequence.
<T> T[]	toArray(T[] a) Returns an array containing all of the elements in this collection in proper sequence.

Methods inherited from class com.softwarefx.chartfx.server.annotation.AnnotationListBase

add, contains, copyTo, get, hitTest, indexOf, insert, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode

Constructor Detail

AnnotationList

public AnnotationList()

AnnotationList

public AnnotationList(Annotations annotations)

Method Detail

add

public boolean add(Object o)

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 AnnotationListBase.insert(int, com.softwarefx.chartfx.server.annotation.AnnotationObject) and AnnotationListBase.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.

Specified by:

add in interface Collection<Object>

Parameters:

o -

See Also:

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

addAll

public boolean addAll(Collection<? extends Object> c)

Adds all of the elements in the specified collection to the AnnotationList collection.

Specified by:

addAll in interface Collection<Object>

Parameters:

c - Elements to be inserted into this collection.

clear

public void clear()

Removes all of the elements from this collection.

Specified by:

clear in interface Collection<Object>

contains

public boolean contains(Object o)

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.

Specified by:

contains in interface Collection<Object>

Parameters:

o -

See Also:

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

containsAll

public boolean containsAll(Collection<?> c)

Returns true if the AnnotationList collection contains all of the elements in the specified collection.

Specified by:

containsAll in interface Collection<Object>

Parameters:

c - Collection to be checked for containment in this collection.

getCurrentObjectIndex

public int getCurrentObjectIndex()

Get the index of the current object in the Annotation list.

Remarks:

Use the CurrentObjectIndex to get the zero-base index of the current object in the Annotation List.

isEmpty

public boolean isEmpty()

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface Collection<Object>

iterator

public Iterator<Object> iterator()

Returns an iterator over the elements in this collection.

Specified by:

iterator in interface Iterable<Object>

Specified by:

iterator in interface Collection<Object>

remove

public boolean remove(Object o)

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

Remarks:

The AnnotationListBase.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 AnnotationListBase.insert(int, com.softwarefx.chartfx.server.annotation.AnnotationObject) method.

The AnnotationListBase.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.

Specified by:

remove in interface Collection<Object>

Parameters:

o -

See Also:

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

removeAll

public boolean removeAll(Collection<?> c)

Removes all of the elements in the specified collection from the AnnotationList collection.

Specified by:

removeAll in interface Collection<Object>

Parameters:

c - Elements to be removed from this collection.

retainAll

public boolean retainAll(Collection<?> c)

Retains only the elements in the AnnotationList collection that are contained in the specified collection.

Specified by:

retainAll in interface Collection<Object>

Parameters:

c - Elements to be retained in this collection.

size

public int size()

Returns the number of elements in this collection.

Specified by:

size in interface Collection<Object>

toArray

public Object[] toArray()

Returns an array containing all of the elements in this collection in proper sequence.

Specified by:

toArray in interface Collection<Object>

toArray

public <T> T[] toArray(T[] a)

Returns an array containing all of the elements in this collection in proper sequence.

Specified by:

toArray in interface Collection<Object>