SoftwareFX.ChartFX.Annotation
Class AnnotationListBase

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AnnotationList

public abstract class AnnotationListBase
extends java.lang.Object
implements java.util.List, java.util.Enumeration

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 AnnotationX class.

Constructor Summary

AnnotationListBase()

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 AnnotationListBase collection.
boolean	addAll(int index, java.util.Collection elements) Adds all of the elements in the specified collection to the AnnotationListBase 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 AnnotationListBase collection contains all of the elements in the specified collection.
java.util.Enumeration	elements() Returns an enumeration of the values in the AnnotationListBase .
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 AnnotationListBase.
AnnotationObject	getItem(int n) Allows you to select and assign attributes directly to a specific annotation list item.
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 AnnotationListBase 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 AnnotationListBase 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 AnnotationListBase collection.
boolean	retainAll(java.util.Collection elements) Retains only the elements in the AnnotationListBase collection that are contained in the specified collection.
AnnotationObject	set(int index, AnnotationObject element) Replaces the element at the specified position in the AnnotationListBase collection with the specified element.
java.lang.Object	set(int index, java.lang.Object element) Replaces the element at the specified position in the AnnotationListBase 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 java.lang.Object

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

Constructor Detail

AnnotationListBase

public AnnotationListBase()

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

Parameters:

element -

See Also:

getItem(int), contains(java.lang.Object), 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

Parameters:

index -

element -

See Also:

getItem(int), contains(java.lang.Object), 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.

Parameters:

element -

See Also:

getItem(int), contains(java.lang.Object), 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.

Parameters:

index -

element -

See Also:

getItem(int), contains(java.lang.Object), 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 AnnotationListBase collection.

Specified by:

addAll in interface java.util.Collection

Specified by:

addAll in interface java.util.List

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

Specified by:

addAll in interface java.util.List

Parameters:

index - The index of the item to add to the AnnotationListBase 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

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

Parameters:

element -

See Also:

getItem(int), add(java.lang.Object), 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.

Parameters:

element -

See Also:

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

containsAll

public boolean containsAll(java.util.Collection elements)

Returns true if the AnnotationListBase 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

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 AnnotationListBase . Use the Enumeration methods on the returned object to fetch the elements sequentially.

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 java.lang.Object

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

Specified by:

get in interface java.util.List

Parameters:

index - Index of element to return.

getItem

public AnnotationObject getItem(int n)

Allows you to select and assign attributes directly to a specific annotation list item.

Remarks:

You will need to use the List property of the AnnotationX class to access this property.

Using the Item property allows you to single out specific annotation objects that have been added to the annotation list.

Items may be added and removed from the annotation list using the supported methods.

See Also:

AnnotationX.getList(int), AnnotationX

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 java.lang.Object

hasMoreElements

public boolean hasMoreElements()

Tests if this enumeration contains more elements.

Specified by:

hasMoreElements in interface java.util.Enumeration

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

Parameters:

element -

See Also:

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.

Parameters:

element -

See Also:

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

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

lastIndexOf

public int lastIndexOf(java.lang.Object element)

Returns the index in the AnnotationListBase 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

Parameters:

element - Element to search for.

lastIndexOf

public int lastIndexOf(AnnotationObject element)

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

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

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

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

remove

public boolean remove(java.lang.Object element)

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

Remarks:

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

The 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

Parameters:

element -

See Also:

getItem(int), add(java.lang.Object), 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 add(java.lang.Object) method may be used to add annotation objects to a selected annotation list or group.

The 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

Parameters:

index -

See Also:

getItem(int), add(java.lang.Object), 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 add(java.lang.Object) method may be used to add annotation objects to a selected annotation list or group.

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

Parameters:

element -

See Also:

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

removeAll

public boolean removeAll(java.util.Collection elements)

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

Specified by:

removeAll in interface java.util.Collection

Specified by:

removeAll in interface java.util.List

Parameters:

elements - Elements to be removed from this collection.

retainAll

public boolean retainAll(java.util.Collection elements)

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

Specified by:

retainAll in interface java.util.Collection

Specified by:

retainAll in interface java.util.List

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 AnnotationListBase collection with the specified element.

Specified by:

set in interface java.util.List

Parameters:

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

element - The item to add to the AnnotationListBase collection

set

public AnnotationObject set(int index,
                            AnnotationObject element)

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

Parameters:

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

element - The item to add to the AnnotationListBase 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

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

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

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