com.softwarefx.chartfx.server
Class PaneCollection

java.lang.Object
  com.softwarefx.chartfx.server.PaneCollection

All Implemented Interfaces:

Iterable<Pane>, Collection<Pane>

public class PaneCollection
extends Object
implements Iterable<Pane>, Collection<Pane>

Provides access to the PaneCollection object.

Charts may support multiple Pane objects. The PaneCollection is a collection of all the pane objects for a chart.

Constructor Summary

PaneCollection()

Method Summary

boolean	add(Pane o) Appends the specified element to the PaneCollection collection.
boolean	addAll(Collection<? extends Pane> c) Adds all of the elements in the specified collection to the PaneCollection collection.
void	addRange(Pane[] items) Adds an array of objects to the PaneCollection collection.
void	clear() Removes all of the elements from this collection.
boolean	contains(Object o) Returns true if the PaneCollection contains the specified element.
boolean	containsAll(Collection<?> c) Returns true if the PaneCollection collection contains all of the elements in the specified collection.
void	copyTo(Pane[] items, int index) Copies the entire Collection to a compatible one-dimensional Array, starting at the specified index of the target array.
Pane	get(int index) Returns the element at the specified position in the PaneCollection.
Pane	hitTest(int x, int y) Returns the Pane for a specific X, Y coordinate.
void	insert(int index, Pane pane) Inserts an element into the ArrayList at the specified index.
boolean	isEmpty() Returns true if this collection contains no elements.
Iterator<Pane>	iterator() Returns an iterator over the elements in this collection.
boolean	remove(Object o) Removes the specified element from the PaneCollection collection.
boolean	removeAll(Collection<?> c) Removes all of the elements in the specified collection from the PaneCollection collection.
void	removeAt(int index) Removes the element in the specified position from the PaneCollection collection.
boolean	retainAll(Collection<?> c) Retains only the elements in the PaneCollection 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 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode

Constructor Detail

PaneCollection

public PaneCollection()

Method Detail

add

public boolean add(Pane o)

Appends the specified element to the PaneCollection collection.

Specified by:

add in interface Collection<Pane>

Parameters:

o - The item to add to the PaneCollection collection.

addAll

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

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

Specified by:

addAll in interface Collection<Pane>

Parameters:

c - Elements to be inserted into this collection.

addRange

public void addRange(Pane[] items)

Adds an array of objects to the PaneCollection collection.

Parameters:

items - An array of objects to add to the collection.

clear

public void clear()

Removes all of the elements from this collection.

Specified by:

clear in interface Collection<Pane>

contains

public boolean contains(Object o)

Returns true if the PaneCollection contains the specified element.

Specified by:

contains in interface Collection<Pane>

Parameters:

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

containsAll

public boolean containsAll(Collection<?> c)

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

Specified by:

containsAll in interface Collection<Pane>

Parameters:

c - Collection to be checked for containment in this collection.

copyTo

public void copyTo(Pane[] 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 PaneCollection. The Array must have zero-based indexing.

index - The zero-based index in array at which copying begins.

get

public Pane get(int index)

Returns the element at the specified position in the PaneCollection.

Parameters:

index - Index of element to return.

hitTest

public Pane hitTest(int x,
                    int y)

Returns the Pane for a specific X, Y coordinate.

Parameters:

x - An integer specifying the X coordinate where you want to simulate the mouse click.

y - An integer specifying the Y coordinate where you want to simulate the mouse click.

insert

public void insert(int index,
                   Pane pane)

Inserts an element into the ArrayList at the specified index.

Parameters:

index - The zero-based index at which position should be inserted.

pane -

isEmpty

public boolean isEmpty()

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface Collection<Pane>

iterator

public Iterator<Pane> iterator()

Returns an iterator over the elements in this collection.

Specified by:

iterator in interface Iterable<Pane>

Specified by:

iterator in interface Collection<Pane>

remove

public boolean remove(Object o)

Removes the specified element from the PaneCollection collection.

Specified by:

remove in interface Collection<Pane>

Parameters:

o - The item to remove from the PaneCollection collection.

removeAll

public boolean removeAll(Collection<?> c)

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

Specified by:

removeAll in interface Collection<Pane>

Parameters:

c - Elements to be removed from this collection.

removeAt

public void removeAt(int index)

Removes the element in the specified position from the PaneCollection collection.

Parameters:

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

retainAll

public boolean retainAll(Collection<?> c)

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

Specified by:

retainAll in interface Collection<Pane>

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

toArray

public Object[] toArray()

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

Specified by:

toArray in interface Collection<Pane>

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