Chart FX 7 for Java Server

com.softwarefx.chartfx.server
Class CustomLegendItemCollection

java.lang.Object
  extended by com.softwarefx.chartfx.server.LabelAwareCollection
      extended by com.softwarefx.chartfx.server.PointAttributesAwareCollection
          extended by com.softwarefx.chartfx.server.CustomLegendItemCollection
All Implemented Interfaces:
ILegendBoxItem, ILegendBoxItemCollection, Iterable<CustomLegendItem>, Collection<CustomLegendItem>

public class CustomLegendItemCollection
extends PointAttributesAwareCollection
implements ILegendBoxItem, ILegendBoxItemCollection, Iterable<CustomLegendItem>, Collection<CustomLegendItem>

Provides access to the CustomLegendItemCollection object.


Constructor Summary
CustomLegendItemCollection()
           
 
Method Summary
 boolean add(CustomLegendItem o)
          Appends the specified element to the CustomLegendItemCollection collection.
 boolean addAll(Collection<? extends CustomLegendItem> c)
          Adds all of the elements in the specified collection to the CustomLegendItemCollection collection.
 void clear()
          Removes all of the elements from this collection.
 boolean contains(Object o)
          Returns true if the CustomLegendItemCollection contains the specified element.
 boolean containsAll(Collection<?> c)
          Returns true if the CustomLegendItemCollection collection contains all of the elements in the specified collection.
 void copyTo(CustomLegendItem[] items, int index)
          Copies the entire Collection to a compatible one-dimensional Array, starting at the specified index of the target array.
 CustomLegendItem get(int index)
          Returns the element at the specified position in the CustomLegendItemCollection.
 int indexOf(CustomLegendItem item)
          Returns the index in the CustomLegendItemCollection of the first occurrence of the specified element, or -1 if this list does not contain this element.
 void insert(int index, CustomLegendItem item)
          Inserts an element into the ArrayList at the specified index.
 boolean isEmpty()
          Returns true if this collection contains no elements.
 Iterator<CustomLegendItem> iterator()
          Returns an iterator over the elements in this collection.
 boolean remove(Object o)
          Removes the specified element from the CustomLegendItemCollection collection.
 boolean removeAll(Collection<?> c)
          Removes all of the elements in the specified collection from the CustomLegendItemCollection collection.
 boolean retainAll(Collection<?> c)
          Retains only the elements in the CustomLegendItemCollection 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.LabelAwareCollection
removeAt
 
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

CustomLegendItemCollection

public CustomLegendItemCollection()
Method Detail

add

public boolean add(CustomLegendItem o)

Appends the specified element to the CustomLegendItemCollection collection.

Specified by:
add in interface Collection<CustomLegendItem>
Parameters:
o - The item to add to the CustomLegendItemCollection collection.

addAll

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

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

Specified by:
addAll in interface Collection<CustomLegendItem>
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<CustomLegendItem>
Overrides:
clear in class LabelAwareCollection

contains

public boolean contains(Object o)

Returns true if the CustomLegendItemCollection contains the specified element.

Specified by:
contains in interface Collection<CustomLegendItem>
Parameters:
o - Element whose presence in this collection is to be tested.

containsAll

public boolean containsAll(Collection<?> c)

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

Specified by:
containsAll in interface Collection<CustomLegendItem>
Parameters:
c - Collection to be checked for containment in this collection.

copyTo

public void copyTo(CustomLegendItem[] items,
                   int index)

Copies the entire Collection to a compatible one-dimensional Array, starting at the specified index of the target array.

Parameters:
items - The one-dimensional Array that is the destination of the elements copied from CustomLegendItemCollection. The Array must have zero-based indexing.
index - The zero-based index in array at which copying begins.

get

public CustomLegendItem get(int index)

Returns the element at the specified position in the CustomLegendItemCollection.

Parameters:
index - Index of element to return.

indexOf

public int indexOf(CustomLegendItem item)

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

Parameters:
item - Element to search for.

insert

public void insert(int index,
                   CustomLegendItem item)

Inserts an element into the ArrayList at the specified index.

Parameters:
index - The zero-based index at which position should be inserted.
item - The item to insert.

isEmpty

public boolean isEmpty()

Returns true if this collection contains no elements.

Specified by:
isEmpty in interface Collection<CustomLegendItem>

iterator

public Iterator<CustomLegendItem> iterator()

Returns an iterator over the elements in this collection.

Specified by:
iterator in interface Iterable<CustomLegendItem>
Specified by:
iterator in interface Collection<CustomLegendItem>

remove

public boolean remove(Object o)

Removes the specified element from the CustomLegendItemCollection collection.

Specified by:
remove in interface Collection<CustomLegendItem>
Parameters:
o - The item to remove from the CustomLegendItemCollection collection.

removeAll

public boolean removeAll(Collection<?> c)

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

Specified by:
removeAll in interface Collection<CustomLegendItem>
Parameters:
c - Elements to be removed from this collection.

retainAll

public boolean retainAll(Collection<?> c)

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

Specified by:
retainAll in interface Collection<CustomLegendItem>
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<CustomLegendItem>

toArray

public Object[] toArray()

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

Specified by:
toArray in interface Collection<CustomLegendItem>

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<CustomLegendItem>

http://www.softwarefx.com

2008 Software FX, Inc. All Rights Reserved. Chart FX is a registered trademark of Software FX, Inc
All other names are trademarks or registered trademarks of their respective owners.