SoftwareFX.ChartFX
Class PaneCollection

java.lang.Object
  SoftwareFX.ChartFX.DisplayBaseCollection
      SoftwareFX.ChartFX.PaneCollection

All Implemented Interfaces:

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

public final class PaneCollection
extends DisplayBaseCollection
implements java.util.List, java.util.Enumeration

Provides access to the PaneCollection object.

The PaneCollection class is comprised of all the chart pane objects created in the chart. The supported members of this class allow you some control over the collection of items as well as access to specific panes.

Constructor Summary

PaneCollection()

Method Summary

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

removeAt

Methods inherited from class java.lang.Object

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

Constructor Detail

PaneCollection

public PaneCollection()

Method Detail

add

public boolean add(java.lang.Object element)

Appends the specified element to the PaneCollection collection.

Specified by:

add in interface java.util.Collection

Specified by:

add in interface java.util.List

Parameters:

element - The item to add to the PaneCollection collection.

add

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

Appends the specified element to the PaneCollection collection.

Specified by:

add in interface java.util.List

Parameters:

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

element - The item to add to the PaneCollection collection.

add

public boolean add(Pane element)

Appends the specified element to the PaneCollection collection.

Parameters:

element - The item to add to the PaneCollection collection.

add

public void add(int index,
                Pane element)

Appends the specified element to the PaneCollection collection.

Parameters:

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

element - The item to add to the PaneCollection collection.

addAll

public boolean addAll(java.util.Collection elements)

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

Specified by:

addAll in interface java.util.List

Parameters:

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

elements - Elements to be inserted into this collection.

clear

public void clear()

Removes all panes from the collection.

Remarks:

You can use the Clear method to remove the entire collection of panes from a parent chart.

Specified by:

clear in interface java.util.Collection

Specified by:

clear in interface java.util.List

Overrides:

clear in class DisplayBaseCollection

See Also:

getItem(int), hitTest(int, int), indexOf(java.lang.Object)

contains

public boolean contains(java.lang.Object element)

Returns true if the PaneCollection contains the specified element.

Specified by:

contains in interface java.util.Collection

Specified by:

contains in interface java.util.List

Parameters:

element - Element whose presence in this collection is to be tested.

contains

public boolean contains(Pane element)

Returns true if the PaneCollection contains the specified element.

Parameters:

element - Element whose presence in this collection is to be tested.

containsAll

public boolean containsAll(java.util.Collection elements)

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

Overrides:

elements in class DisplayBaseCollection

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(PaneCollection 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 PaneCollection.

Specified by:

get in interface java.util.List

Parameters:

index - Index of element to return.

getItem

public Pane getItem(int n)

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

Remarks:

The Item property is used to select an specific item in collections. Using VB, you can use this property as follows:

Chart.Panes.Item(0).InsideColor = Color.Red

Using C#, this property is only available by using an index on the collection (Panes):

Chart.Panes[0].InsideColor = Color.Red;

The Item property is used to select an specific item in collections, for example:

chart1.getPanes().getItem(0).setInsideColor(java.awt.Color.RED);


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

Overrides:

hasMoreElements in class DisplayBaseCollection

hitTest

public int hitTest(int x,
                   int y)

Returns the index of the pane that corresponds to the x,y coordinate.

Remarks:

If no pane is hit based on the configured coordinates a value of -1 is returned.

The ChartCore.getPanes() property is used to obtain the PaneCollection.

Parameters:

x - X pixel coordinate.

y - Y pixel coordinate.

See Also:

ChartCore.getPanes(), Chart

indexOf

public int indexOf(java.lang.Object element)

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

Remarks:

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

Specified by:

indexOf in interface java.util.List

Overrides:

indexOf in class DisplayBaseCollection

Parameters:

element -

See Also:

getItem(int), clear(), hitTest(int, int)

indexOf

public int indexOf(Pane element)

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

Remarks:

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

Parameters:

element -

See Also:

getItem(int), clear(), hitTest(int, 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 PaneCollection 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(Pane element)

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

Overrides:

nextElement in class DisplayBaseCollection

remove

public boolean remove(java.lang.Object element)

Removes the specified element from the PaneCollection collection.

Specified by:

remove in interface java.util.Collection

Specified by:

remove in interface java.util.List

Parameters:

element - The item to remove from the PaneCollection collection.

remove

public java.lang.Object remove(int index)

Removes the specified element from the PaneCollection collection.

Specified by:

remove in interface java.util.List

Parameters:

index - The index of the item to remove from the PaneCollection collection.

remove

public boolean remove(Pane element)

Removes the specified element from the PaneCollection collection.

Parameters:

element - The item to remove from the PaneCollection collection.

removeAll

public boolean removeAll(java.util.Collection elements)

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

Specified by:

set in interface java.util.List

Parameters:

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

element - The item to add to the PaneCollection collection

set

public Pane set(int index,
                Pane element)

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

Parameters:

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

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

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

Overrides:

toArray in class DisplayBaseCollection