|
Chart FX for Java 6.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectSoftwareFX.ChartFX.Annotation.AnnotationListBase
SoftwareFX.ChartFX.Annotation.AnnotationList
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(SoftwareFX.internal.ChartFX.Annotation.AnnotationList internalObject)
|
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. |
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 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[] internalObject)
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 |
public AnnotationList(SoftwareFX.internal.ChartFX.Annotation.AnnotationList internalObject)
public AnnotationList()
Method Detail |
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.
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
and AnnotationListBase.remove(int)
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.
add
in interface java.util.List
add
in class AnnotationListBase
AnnotationListBase.getItem(int)
,
AnnotationListBase.contains(java.lang.Object)
,
AnnotationListBase#insert
,
AnnotationListBase.remove(int)
,
AnnotationX
,
AnnotationList
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.
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
and AnnotationListBase.remove(int)
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.
add
in interface java.util.List
add
in class AnnotationListBase
AnnotationListBase.getItem(int)
,
AnnotationListBase.contains(java.lang.Object)
,
AnnotationListBase#insert
,
AnnotationListBase.remove(int)
,
AnnotationX
,
AnnotationList
public boolean add(AnnotationObject element)
Used to add an object to the end of an annotation group or to the entire annotation objects list.
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
and AnnotationListBase.remove(int)
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.
add
in class AnnotationListBase
AnnotationListBase.getItem(int)
,
AnnotationListBase.contains(java.lang.Object)
,
AnnotationListBase#insert
,
AnnotationListBase.remove(int)
,
AnnotationX
,
AnnotationList
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.
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
and AnnotationListBase.remove(int)
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.
add
in class AnnotationListBase
AnnotationListBase.getItem(int)
,
AnnotationListBase.contains(java.lang.Object)
,
AnnotationListBase#insert
,
AnnotationListBase.remove(int)
,
AnnotationX
,
AnnotationList
public boolean addAll(java.util.Collection elements)
Adds all of the elements in the specified collection to the AnnotationList collection.
addAll
in interface java.util.List
addAll
in class AnnotationListBase
elements
- Elements to be inserted into this collection.public boolean addAll(int index, java.util.Collection elements)
Adds all of the elements in the specified collection to the AnnotationList collection.
addAll
in interface java.util.List
addAll
in class AnnotationListBase
elements
- Elements to be inserted into this collection.index
- The index of the item to add to the AnnotationList collection.public void clear()
Removes all of the elements from this collection.
clear
in interface java.util.List
clear
in class AnnotationListBase
public boolean contains(java.lang.Object element)
Determines whether an annotation list or group contains a specific element.
This method will return True if the collection contains the specified object; otherwise, False.
contains
in interface java.util.List
contains
in class AnnotationListBase
AnnotationListBase.getItem(int)
,
AnnotationListBase.add(java.lang.Object)
,
AnnotationListBase#insert
,
AnnotationListBase.remove(int)
,
AnnotationX
public boolean contains(AnnotationObject element)
Determines whether an annotation list or group contains a specific element.
This method will return True if the collection contains the specified object; otherwise, False.
contains
in class AnnotationListBase
AnnotationListBase.getItem(int)
,
AnnotationListBase.add(java.lang.Object)
,
AnnotationListBase#insert
,
AnnotationListBase.remove(int)
,
AnnotationX
public boolean containsAll(java.util.Collection elements)
Returns true if the AnnotationList collection contains all of the elements in the specified collection.
containsAll
in interface java.util.List
containsAll
in class AnnotationListBase
elements
- Collection to be checked for containment in this collection.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.
elements
in class AnnotationListBase
public boolean equals(java.lang.Object element)
Compares the specified object with this collection for equality.
equals
in interface java.util.List
equals
in class AnnotationListBase
element
- Object to be compared for equality with this collection.public boolean equals(AnnotationList element)
Compares the specified object with this collection for equality.
element
- Object to be compared for equality with this collection.public java.lang.Object get(int index)
Returns the element at the specified position in the AnnotationList.
get
in interface java.util.List
get
in class AnnotationListBase
index
- Index of element to return.public AnnotationObject getItem(int n)
Allows you to select and assign attributes directly to a specific annotation list item.
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.
getItem
in class AnnotationListBase
n
- Index of the annotation object in the annotation list.AnnotationX.getList(int)
,
AnnotationX
public int hashCode()
Returns the hash code value for this collection.
hashCode
in interface java.util.List
hashCode
in class AnnotationListBase
public boolean hasMoreElements()
Tests if this enumeration contains more elements.
hasMoreElements
in interface java.util.Enumeration
hasMoreElements
in class AnnotationListBase
public int indexOf(java.lang.Object element)
Returns the zero based index of a specific item in a list.
This is useful to find the position of a specific item in the array list.
The AnnotationListBase#copyTo
method allows you to copy elements of this collection into the specified array.
indexOf
in interface java.util.List
indexOf
in class AnnotationListBase
AnnotationListBase.getItem(int)
,
AnnotationListBase#copyTo
public int indexOf(AnnotationObject element)
Returns the zero based index of a specific item in a list.
This is useful to find the position of a specific item in the array list.
The AnnotationListBase#copyTo
method allows you to copy elements of this collection into the specified array.
indexOf
in class AnnotationListBase
AnnotationListBase.getItem(int)
,
AnnotationListBase#copyTo
public boolean isEmpty()
Returns true if this collection contains no elements.
isEmpty
in interface java.util.List
isEmpty
in class AnnotationListBase
public java.util.Iterator iterator()
Returns an iterator over the elements in this collection.
iterator
in interface java.util.List
iterator
in class AnnotationListBase
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.
lastIndexOf
in interface java.util.List
lastIndexOf
in class AnnotationListBase
element
- Element to search for.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.
lastIndexOf
in class AnnotationListBase
element
- Element to search for.public java.util.ListIterator listIterator()
Returns a list iterator of the elements in this collection.
listIterator
in interface java.util.List
listIterator
in class AnnotationListBase
public java.util.ListIterator listIterator(int index)
Returns a list iterator of the elements in this collection.
listIterator
in interface java.util.List
listIterator
in class AnnotationListBase
public java.lang.Object nextElement()
Returns the next element of this enumeration if this enumeration object has at least one more element to provide.
nextElement
in interface java.util.Enumeration
nextElement
in class AnnotationListBase
public java.lang.Object remove(int index)
Removes the first occurrence of a specified annotation object from the selected collection.
The AnnotationListBase.add(java.lang.Object)
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
method.
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.
remove
in interface java.util.List
remove
in class AnnotationListBase
AnnotationListBase.getItem(int)
,
AnnotationListBase.add(java.lang.Object)
,
AnnotationListBase.contains(java.lang.Object)
,
AnnotationListBase#insert
,
AnnotationX
public boolean remove(java.lang.Object element)
Removes the first occurrence of a specified annotation object from the selected collection.
The AnnotationListBase.add(java.lang.Object)
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
method.
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.
remove
in interface java.util.List
remove
in class AnnotationListBase
AnnotationListBase.getItem(int)
,
AnnotationListBase.add(java.lang.Object)
,
AnnotationListBase.contains(java.lang.Object)
,
AnnotationListBase#insert
,
AnnotationX
public boolean remove(AnnotationObject element)
Removes the first occurrence of a specified annotation object from the selected collection.
The AnnotationListBase.add(java.lang.Object)
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
method.
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.
remove
in class AnnotationListBase
AnnotationListBase.getItem(int)
,
AnnotationListBase.add(java.lang.Object)
,
AnnotationListBase.contains(java.lang.Object)
,
AnnotationListBase#insert
,
AnnotationX
public boolean removeAll(java.util.Collection elements)
Removes all of the elements in the specified collection from the AnnotationList collection.
removeAll
in interface java.util.List
removeAll
in class AnnotationListBase
elements
- Elements to be removed from this collection.public boolean retainAll(java.util.Collection elements)
Retains only the elements in the AnnotationList collection that are contained in the specified collection.
retainAll
in interface java.util.List
retainAll
in class AnnotationListBase
elements
- Elements to be retained in this collection.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.
set
in interface java.util.List
set
in class AnnotationListBase
index
- The index of the item to add to the AnnotationList collection.element
- The item to add to the AnnotationList collectionpublic AnnotationObject set(int index, AnnotationObject element)
Replaces the element at the specified position in the AnnotationList collection with the specified element.
set
in class AnnotationListBase
index
- The index of the item to add to the AnnotationList collection.element
- The item to add to the AnnotationList collectionpublic int size()
Returns the number of elements in this collection.
size
in interface java.util.List
size
in class AnnotationListBase
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.
subList
in interface java.util.List
subList
in class AnnotationListBase
fromIndex
- Low endpoint (inclusive) of the subList.toIndex
- High endpoint (exclusive) of the subList.public java.lang.Object[] toArray()
Returns an array containing all of the elements in this collection in proper sequence.
toArray
in interface java.util.List
toArray
in class AnnotationListBase
public java.lang.Object[] toArray(java.lang.Object[] internalObject)
Returns an array containing all of the elements in this collection in proper sequence.
toArray
in interface java.util.List
toArray
in class AnnotationListBase
|
http://www.softwarefx.com | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |