SoftwareFX.ChartFX
Class UserLegendBoxItemCollection

java.lang.Object
  SoftwareFX.ChartFX.UserLegendBoxItemCollection

All Implemented Interfaces:

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

public final class UserLegendBoxItemCollection
extends java.lang.Object
implements java.util.List, java.util.Enumeration

Provides access to the UserLegendBoxItemCollection object.

The UserLegendBoxItemCollection Class allows you as the developer to control the UserLegendBoxItem list by exposing members such as Item, Add, Contains, CopyTo, IndexOf, Insert and Remove. It is recommended to create items using the following method rather than creating a new UserLegendBoxItem objects and adding them using the Add method, however, all other members prove very useful when administering this collection:

UserLegendBoxItem usrLegItem = Chart1.getUserLegendBoxObj().getItem(0);

Once you have a list generated, the members of this Class allow you to control the collection very easily:

Chart1.getUserLegendBoxObj().getItem().clear();

Constructor Summary

UserLegendBoxItemCollection()

Method Summary

void	add(int index, java.lang.Object element) Adds an item to the UserLegendBoxItemCollection list.
void	add(int index, UserLegendBoxItem element) Adds an item to the UserLegendBoxItemCollection list.
boolean	add(java.lang.Object element) Adds an item to the UserLegendBoxItemCollection list.
boolean	add(UserLegendBoxItem element) Adds an item to the UserLegendBoxItemCollection list.
boolean	addAll(java.util.Collection elements) Adds all of the elements in the specified collection to the UserLegendBoxItemCollection collection.
boolean	addAll(int index, java.util.Collection elements) Adds all of the elements in the specified collection to the UserLegendBoxItemCollection collection.
void	clear() Removes all of the elements from this collection.
boolean	contains(java.lang.Object element) Returns a Boolean specifying if the referenced item is included in the UserLegendBoxItemCollection list.
boolean	contains(UserLegendBoxItem element) Returns a Boolean specifying if the referenced item is included in the UserLegendBoxItemCollection list.
boolean	containsAll(java.util.Collection elements) Returns true if the UserLegendBoxItemCollection collection contains all of the elements in the specified collection.
java.util.Enumeration	elements() Returns an enumeration of the values in the UserLegendBoxItemCollection .
boolean	equals(java.lang.Object element) Compares the specified object with this collection for equality.
boolean	equals(UserLegendBoxItemCollection 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 UserLegendBoxItemCollection.
UserLegendBoxItem	getItem(int i) Allows you to select a specific item in the UserLegendBoxItemCollection list as well as access the supported methods of the UserLegendBoxItemCollection class.
int	hashCode() Returns the hash code value for this collection.
boolean	hasMoreElements() Tests if this enumeration contains more elements.
int	indexOf(java.lang.Object element) Returns the zero-based index of a specific item in the UserLegendBoxItemCollection list.
int	indexOf(UserLegendBoxItem element) Returns the zero-based index of a specific item in the UserLegendBoxItemCollection 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(java.lang.Object element) Returns the index in the UserLegendBoxItemCollection of the last occurrence of the specified element, or -1 if this list does not contain this element.
int	lastIndexOf(UserLegendBoxItem element) Returns the index in the UserLegendBoxItemCollection 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.
java.lang.Object	remove(int index) Removes the first occurrence of a specific item from the UserLegendBoxItemCollection list.
boolean	remove(java.lang.Object element) Removes the first occurrence of a specific item from the UserLegendBoxItemCollection list.
boolean	remove(UserLegendBoxItem element) Removes the first occurrence of a specific item from the UserLegendBoxItemCollection list.
boolean	removeAll(java.util.Collection elements) Removes all of the elements in the specified collection from the UserLegendBoxItemCollection collection.
boolean	retainAll(java.util.Collection elements) Retains only the elements in the UserLegendBoxItemCollection collection that are contained in the specified collection.
java.lang.Object	set(int index, java.lang.Object element) Replaces the element at the specified position in the UserLegendBoxItemCollection collection with the specified element.
UserLegendBoxItem	set(int index, UserLegendBoxItem element) Replaces the element at the specified position in the UserLegendBoxItemCollection 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

UserLegendBoxItemCollection

public UserLegendBoxItemCollection()

Method Detail

add

public boolean add(java.lang.Object element)

Adds an item to the UserLegendBoxItemCollection list.

Remarks:

It is not recommended to create a new UserLegendBoxItem due to the fact Chart FX will handle this for you, however this method will allow you to add existing objects into the list again. Here is the recommended way to access a UserLegendBoxItem:

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), indexOf(java.lang.Object), remove(java.lang.Object)

add

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

Adds an item to the UserLegendBoxItemCollection list.

Remarks:

It is not recommended to create a new UserLegendBoxItem due to the fact Chart FX will handle this for you, however this method will allow you to add existing objects into the list again. Here is the recommended way to access a UserLegendBoxItem:

Specified by:

add in interface java.util.List

Parameters:

index -

element -

See Also:

getItem(int), contains(java.lang.Object), indexOf(java.lang.Object), remove(java.lang.Object)

add

public boolean add(UserLegendBoxItem element)

Adds an item to the UserLegendBoxItemCollection list.

Remarks:

It is not recommended to create a new UserLegendBoxItem due to the fact Chart FX will handle this for you, however this method will allow you to add existing objects into the list again. Here is the recommended way to access a UserLegendBoxItem:

Parameters:

element -

See Also:

getItem(int), contains(java.lang.Object), indexOf(java.lang.Object), remove(java.lang.Object)

add

public void add(int index,
                UserLegendBoxItem element)

Adds an item to the UserLegendBoxItemCollection list.

Remarks:

It is not recommended to create a new UserLegendBoxItem due to the fact Chart FX will handle this for you, however this method will allow you to add existing objects into the list again. Here is the recommended way to access a UserLegendBoxItem:

Parameters:

index -

element -

See Also:

getItem(int), contains(java.lang.Object), indexOf(java.lang.Object), remove(java.lang.Object)

addAll

public boolean addAll(java.util.Collection elements)

Adds all of the elements in the specified collection to the UserLegendBoxItemCollection 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 UserLegendBoxItemCollection collection.

Specified by:

addAll in interface java.util.List

Parameters:

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

Returns a Boolean specifying if the referenced item is included in the UserLegendBoxItemCollection list.

Remarks:

This method is useful if you want to find out if a selected item exists in the UserLegendBoxItemCollection list.

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), indexOf(java.lang.Object), remove(java.lang.Object)

contains

public boolean contains(UserLegendBoxItem element)

Returns a Boolean specifying if the referenced item is included in the UserLegendBoxItemCollection list.

Remarks:

This method is useful if you want to find out if a selected item exists in the UserLegendBoxItemCollection list.

Parameters:

element -

See Also:

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

containsAll

public boolean containsAll(java.util.Collection elements)

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

equals

public boolean equals(UserLegendBoxItemCollection 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 UserLegendBoxItemCollection.

Specified by:

get in interface java.util.List

Parameters:

index - Index of element to return.

getItem

public UserLegendBoxItem getItem(int i)

Allows you to select a specific item in the UserLegendBoxItemCollection list as well as access the supported methods of the UserLegendBoxItemCollection class.

Remarks:

This property should be used to create items for the UserLegendBox as follows:

It may also be used to access the supported methods of the UserLegendBoxItemCollection class:

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 the UserLegendBoxItemCollection list.

Remarks:

The Contains method allows you to obtain a Boolean specifying whether a selected item exists in the UserLegendBoxItemCollection list.

Specified by:

indexOf in interface java.util.List

Parameters:

element -

See Also:

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

indexOf

public int indexOf(UserLegendBoxItem element)

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

Remarks:

The Contains method allows you to obtain a Boolean specifying whether a selected item exists in the UserLegendBoxItemCollection list.

Parameters:

element -

See Also:

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

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 UserLegendBoxItemCollection 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(UserLegendBoxItem element)

Returns the index in the UserLegendBoxItemCollection 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 specific item from the UserLegendBoxItemCollection list.

Remarks:

The Add and Insert methods may be used to populate the UserLegendBoxItemCollection 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), indexOf(java.lang.Object)

remove

public java.lang.Object remove(int index)

Removes the first occurrence of a specific item from the UserLegendBoxItemCollection list.

Remarks:

The Add and Insert methods may be used to populate the UserLegendBoxItemCollection list.

Specified by:

remove in interface java.util.List

Parameters:

index -

See Also:

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

remove

public boolean remove(UserLegendBoxItem element)

Removes the first occurrence of a specific item from the UserLegendBoxItemCollection list.

Remarks:

The Add and Insert methods may be used to populate the UserLegendBoxItemCollection list.

Parameters:

element -

See Also:

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

removeAll

public boolean removeAll(java.util.Collection elements)

Removes all of the elements in the specified collection from the UserLegendBoxItemCollection 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 UserLegendBoxItemCollection 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 UserLegendBoxItemCollection collection with the specified element.

Specified by:

set in interface java.util.List

Parameters:

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

element - The item to add to the UserLegendBoxItemCollection collection

set

public UserLegendBoxItem set(int index,
                             UserLegendBoxItem element)

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

Parameters:

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

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