SoftwareFX.ChartFX.Annotation
Class AnnotationList

java.lang.Object
  SoftwareFX.ChartFX.Annotation.AnnotationListBase
      SoftwareFX.ChartFX.Annotation.AnnotationList

All Implemented Interfaces:

java.lang.Iterable, java.util.Collection, java.util.Enumeration, java.util.List

public final class AnnotationList
extends AnnotationListBase
implements java.util.List, java.util.Enumeration

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()

Method Summary

boolean	add(AnnotationObject element) Used to add an object to the end of an annotation group or to the entire annotation objects list.
void	add(int index, AnnotationObject element) Used to add an object to the end of an annotation group or to the entire annotation objects list.
void	add(int index, java.lang.Object element) Used to add an object to the end of an annotation group or to the entire annotation objects list.
boolean	add(java.lang.Object element) Used to add an object to the end of an annotation group or to the entire annotation objects list.
boolean	addAll(java.util.Collection elements) Adds all of the elements in the specified collection to the AnnotationList collection.
boolean	addAll(int index, java.util.Collection elements) 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(AnnotationObject element) Determines whether an annotation list or group contains a specific element.
boolean	contains(java.lang.Object element) Determines whether an annotation list or group contains a specific element.
boolean	containsAll(java.util.Collection elements) Returns true if the AnnotationList collection contains all of the elements in the specified collection.
java.util.Enumeration	elements() Returns an enumeration of the values in the AnnotationList .
boolean	equals(AnnotationList element) Compares the specified object with this collection for equality.
boolean	equals(java.lang.Object element) Compares the specified object with this collection for equality.
java.lang.Object	get(int index) Returns the element at the specified position in the AnnotationList.
int	hashCode() Returns the hash code value for this collection.
boolean	hasMoreElements() Tests if this enumeration contains more elements.
int	indexOf(AnnotationObject element) Returns the zero based index of a specific item in a list.
int	indexOf(java.lang.Object element) Returns the zero based index of a specific item in a list.
boolean	isEmpty() Returns true if this collection contains no elements.
java.util.Iterator	iterator() Returns an iterator over the elements in this collection.
int	lastIndexOf(AnnotationObject element) Returns the index in the AnnotationList of the last occurrence of the specified element, or -1 if this list does not contain this element.
int	lastIndexOf(java.lang.Object element) Returns the index in the AnnotationList of the last occurrence of the specified element, or -1 if this list does not contain this element.
java.util.ListIterator	listIterator() Returns a list iterator of the elements in this collection.
java.util.ListIterator	listIterator(int index) Returns a list iterator of the elements in this collection.
java.lang.Object	nextElement() Returns the next element of this enumeration if this enumeration object has at least one more element to provide.
boolean	remove(AnnotationObject element) Removes the first occurrence of a specified annotation object from the selected collection.
java.lang.Object	remove(int index) Removes the first occurrence of a specified annotation object from the selected collection.
boolean	remove(java.lang.Object element) Removes the first occurrence of a specified annotation object from the selected collection.
boolean	removeAll(java.util.Collection elements) Removes all of the elements in the specified collection from the AnnotationList collection.
boolean	retainAll(java.util.Collection elements) Retains only the elements in the AnnotationList collection that are contained in the specified collection.
AnnotationObject	set(int index, AnnotationObject element) Replaces the element at the specified position in the AnnotationList collection with the specified element.
java.lang.Object	set(int index, java.lang.Object element) Replaces the element at the specified position in the AnnotationList collection with the specified element.
int	size() Returns the number of elements in this collection.
java.util.List	subList(int fromIndex, int toIndex) Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
java.lang.Object[]	toArray() Returns an array containing all of the elements in this collection in proper sequence.
java.lang.Object[]	toArray(java.lang.Object[] obj) Returns an array containing all of the elements in this collection in proper sequence.

Methods inherited from class SoftwareFX.ChartFX.Annotation.AnnotationListBase

getItem

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnnotationList

public AnnotationList()

Method Detail

add

public boolean add(java.lang.Object element)

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.

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 java.util.Collection

Specified by:

add in interface java.util.List

Overrides:

add in class AnnotationListBase

Parameters:

element -

See Also:

AnnotationListBase.getItem(int), AnnotationListBase.contains(java.lang.Object), AnnotationListBase.remove(java.lang.Object), AnnotationX, AnnotationList

add

public void add(int index,
                java.lang.Object element)

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.

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 java.util.List

Overrides:

add in class AnnotationListBase

Parameters:

index -

element -

See Also:

AnnotationListBase.getItem(int), AnnotationListBase.contains(java.lang.Object), AnnotationListBase.remove(java.lang.Object), AnnotationX, AnnotationList

add

public boolean add(AnnotationObject element)

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.

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.

Overrides:

add in class AnnotationListBase

Parameters:

element -

See Also:

AnnotationListBase.getItem(int), AnnotationListBase.contains(java.lang.Object), AnnotationListBase.remove(java.lang.Object), AnnotationX, AnnotationList

add

public void add(int index,
                AnnotationObject element)

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.

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.

Overrides:

add in class AnnotationListBase

Parameters:

index -

element -

See Also:

AnnotationListBase.getItem(int), AnnotationListBase.contains(java.lang.Object), AnnotationListBase.remove(java.lang.Object), AnnotationX, AnnotationList

addAll

public boolean addAll(java.util.Collection elements)

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

Specified by:

addAll in interface java.util.Collection

Specified by:

addAll in interface java.util.List

Overrides:

addAll in class AnnotationListBase

Parameters:

elements - Elements to be inserted into this collection.

addAll

public boolean addAll(int index,
                      java.util.Collection elements)

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

Specified by:

addAll in interface java.util.List

Overrides:

addAll in class AnnotationListBase

Parameters:

index - The index of the item to add to the AnnotationList collection.

elements - Elements to be inserted into this collection.

clear

public void clear()

Removes all of the elements from this collection.

Specified by:

clear in interface java.util.Collection

Specified by:

clear in interface java.util.List

Overrides:

clear in class AnnotationListBase

contains

public boolean contains(java.lang.Object element)

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 java.util.Collection

Specified by:

contains in interface java.util.List

Overrides:

contains in class AnnotationListBase

Parameters:

element -

See Also:

AnnotationListBase.getItem(int), AnnotationListBase.add(java.lang.Object), AnnotationListBase.remove(java.lang.Object), AnnotationX

contains

public boolean contains(AnnotationObject element)

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.

Overrides:

contains in class AnnotationListBase

Parameters:

element -

See Also:

AnnotationListBase.getItem(int), AnnotationListBase.add(java.lang.Object), AnnotationListBase.remove(java.lang.Object), AnnotationX

containsAll

public boolean containsAll(java.util.Collection elements)

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

Specified by:

containsAll in interface java.util.Collection

Specified by:

containsAll in interface java.util.List

Overrides:

containsAll in class AnnotationListBase

Parameters:

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

elements

public java.util.Enumeration elements()

Returns an enumeration of the values in the AnnotationList . Use the Enumeration methods on the returned object to fetch the elements sequentially.

Overrides:

elements in class AnnotationListBase

equals

public boolean equals(java.lang.Object element)

Compares the specified object with this collection for equality.

Specified by:

equals in interface java.util.Collection

Specified by:

equals in interface java.util.List

Overrides:

equals in class AnnotationListBase

Parameters:

element - Object to be compared for equality with this collection.

equals

public boolean equals(AnnotationList element)

Compares the specified object with this collection for equality.

Parameters:

element - Object to be compared for equality with this collection.

get

public java.lang.Object get(int index)

Returns the element at the specified position in the AnnotationList.

Specified by:

get in interface java.util.List

Overrides:

get in class AnnotationListBase

Parameters:

index - Index of element to return.

hashCode

public int hashCode()

Returns the hash code value for this collection.

Specified by:

hashCode in interface java.util.Collection

Specified by:

hashCode in interface java.util.List

Overrides:

hashCode in class AnnotationListBase

hasMoreElements

public boolean hasMoreElements()

Tests if this enumeration contains more elements.

Specified by:

hasMoreElements in interface java.util.Enumeration

Overrides:

hasMoreElements in class AnnotationListBase

indexOf

public int indexOf(java.lang.Object element)

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.

Specified by:

indexOf in interface java.util.List

Overrides:

indexOf in class AnnotationListBase

Parameters:

element -

See Also:

AnnotationListBase.getItem(int)

indexOf

public int indexOf(AnnotationObject element)

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.

Overrides:

indexOf in class AnnotationListBase

Parameters:

element -

See Also:

AnnotationListBase.getItem(int)

isEmpty

public boolean isEmpty()

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface java.util.Collection

Specified by:

isEmpty in interface java.util.List

Overrides:

isEmpty in class AnnotationListBase

iterator

public java.util.Iterator iterator()

Returns an iterator over the elements in this collection.

Specified by:

iterator in interface java.lang.Iterable

Specified by:

iterator in interface java.util.Collection

Specified by:

iterator in interface java.util.List

Overrides:

iterator in class AnnotationListBase

lastIndexOf

public int lastIndexOf(java.lang.Object element)

Returns the index in the AnnotationList of the last occurrence of the specified element, or -1 if this list does not contain this element.

Specified by:

lastIndexOf in interface java.util.List

Overrides:

lastIndexOf in class AnnotationListBase

Parameters:

element - Element to search for.

lastIndexOf

public int lastIndexOf(AnnotationObject element)

Returns the index in the AnnotationList of the last occurrence of the specified element, or -1 if this list does not contain this element.

Overrides:

lastIndexOf in class AnnotationListBase

Parameters:

element - Element to search for.

listIterator

public java.util.ListIterator listIterator()

Returns a list iterator of the elements in this collection.

Specified by:

listIterator in interface java.util.List

Overrides:

listIterator in class AnnotationListBase

listIterator

public java.util.ListIterator listIterator(int index)

Returns a list iterator of the elements in this collection.

Specified by:

listIterator in interface java.util.List

Overrides:

listIterator in class AnnotationListBase

Parameters:

index -

nextElement

public java.lang.Object nextElement()

Returns the next element of this enumeration if this enumeration object has at least one more element to provide.

Specified by:

nextElement in interface java.util.Enumeration

Overrides:

nextElement in class AnnotationListBase

remove

public boolean remove(java.lang.Object element)

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

Remarks:

The AnnotationListBase.add(java.lang.Object) method may be used to add annotation objects to a selected annotation list or group.

The AnnotationListBase.contains(java.lang.Object) method will allow you to determine if a specific annotation object has been added to a group or list.

Specified by:

remove in interface java.util.Collection

Specified by:

remove in interface java.util.List

Overrides:

remove in class AnnotationListBase

Parameters:

element -

See Also:

AnnotationListBase.getItem(int), AnnotationListBase.add(java.lang.Object), AnnotationListBase.contains(java.lang.Object), AnnotationX

remove

public java.lang.Object remove(int index)

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

Remarks:

The AnnotationListBase.add(java.lang.Object) method may be used to add annotation objects to a selected annotation list or group.

The AnnotationListBase.contains(java.lang.Object) method will allow you to determine if a specific annotation object has been added to a group or list.

Specified by:

remove in interface java.util.List

Overrides:

remove in class AnnotationListBase

Parameters:

index -

See Also:

AnnotationListBase.getItem(int), AnnotationListBase.add(java.lang.Object), AnnotationListBase.contains(java.lang.Object), AnnotationX

remove

public boolean remove(AnnotationObject element)

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

Remarks:

The AnnotationListBase.add(java.lang.Object) method may be used to add annotation objects to a selected annotation list or group.

The AnnotationListBase.contains(java.lang.Object) method will allow you to determine if a specific annotation object has been added to a group or list.

Overrides:

remove in class AnnotationListBase

Parameters:

element -

See Also:

AnnotationListBase.getItem(int), AnnotationListBase.add(java.lang.Object), AnnotationListBase.contains(java.lang.Object), AnnotationX

removeAll

public boolean removeAll(java.util.Collection elements)

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

Specified by:

removeAll in interface java.util.Collection

Specified by:

removeAll in interface java.util.List

Overrides:

removeAll in class AnnotationListBase

Parameters:

elements - Elements to be removed from this collection.

retainAll

public boolean retainAll(java.util.Collection elements)

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

Specified by:

retainAll in interface java.util.Collection

Specified by:

retainAll in interface java.util.List

Overrides:

retainAll in class AnnotationListBase

Parameters:

elements - Elements to be retained in this collection.

set

public java.lang.Object set(int index,
                            java.lang.Object element)

Replaces the element at the specified position in the AnnotationList collection with the specified element.

Specified by:

set in interface java.util.List

Overrides:

set in class AnnotationListBase

Parameters:

index - The index of the item to add to the AnnotationList collection.

element - The item to add to the AnnotationList collection

set

public AnnotationObject set(int index,
                            AnnotationObject element)

Replaces the element at the specified position in the AnnotationList collection with the specified element.

Overrides:

set in class AnnotationListBase

Parameters:

index - The index of the item to add to the AnnotationList collection.

element - The item to add to the AnnotationList collection

size

public int size()

Returns the number of elements in this collection.

Specified by:

size in interface java.util.Collection

Specified by:

size in interface java.util.List

Overrides:

size in class AnnotationListBase

subList

public java.util.List subList(int fromIndex,
                              int toIndex)

Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.

Specified by:

subList in interface java.util.List

Overrides:

subList in class AnnotationListBase

Parameters:

fromIndex - Low endpoint (inclusive) of the subList.

toIndex - High endpoint (exclusive) of the subList.

toArray

public java.lang.Object[] toArray()

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

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.List

Overrides:

toArray in class AnnotationListBase

toArray

public java.lang.Object[] toArray(java.lang.Object[] obj)

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

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.List

Overrides:

toArray in class AnnotationListBase