com.softwarefx.chartfx.server.maps
Class LabelLinkCollection

java.lang.Object
  com.softwarefx.chartfx.server.maps.LabelLinkCollection

All Implemented Interfaces:

Iterable<LabelLink>, Collection<LabelLink>

public class LabelLinkCollection
extends Object
implements Iterable<LabelLink>, Collection<LabelLink>

Provides access to the LabelLinkCollection object

The supported members of the LabelLinkCollection class are used to administer the collection of LabelLink objects. This class is derived from the CollectBase class, therefore, the standard collection members are supported.

Constructor Summary

LabelLinkCollection()

Method Summary

boolean	add(LabelLink o) Used to add a LabelLinks object to the end of the LabelLinkCollection.
boolean	addAll(Collection<? extends LabelLink> c) Adds all of the elements in the specified collection to the LabelLinkCollection collection.
void	clear() Removes all of the elements from this collection.
boolean	contains(Object o) Determines whether the LabelLinkCollection contains a specific element.
boolean	containsAll(Collection<?> c) Returns true if the LabelLinkCollection collection contains all of the elements in the specified collection.
void	copyTo(LabelLink[] array, int index) Copies the entire LabelLinkCollection to a compatible one-dimensional Array, starting at the specified index of the target array.
LabelLink	get(int i) Returns the element at the specified position in the LabelLinkCollection.
Locale	getCulture() Gets the Culture.
com.softwarefx.chartfx.server.maps.MapGallery	getMapGallery() Gets the MapGallery.
int	indexOf(LabelLink labelObj) Searches for the specified Object and returns the zero-based index of the first occurrence within the entire LabelLinkCollection.
void	insert(int index, LabelLink labelObj) Inserts an element into the LabelLinkCollection at the specified index.
boolean	isEmpty() Returns true if this collection contains no elements.
Iterator<LabelLink>	iterator() Returns an iterator over the elements in this collection.
boolean	remove(Object o) Removes the first occurrence of a specific object from the LabelLinkCollection.
boolean	removeAll(Collection<?> c) Removes all of the elements in the specified collection from the LabelLinkCollection collection.
boolean	retainAll(Collection<?> c) Retains only the elements in the LabelLinkCollection collection that are contained in the specified collection.
void	set(int i, LabelLink value) Replaces the element at the specified position in the LabelLinkCollection collection with the specified element.
void	setCulture(Locale value) Allows you to localize the LabelLinkCollection object for a specific language and region.
void	setMapGallery(com.softwarefx.chartfx.server.maps.MapGallery value) Internal Use.
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

LabelLinkCollection

public LabelLinkCollection()

Method Detail

add

public boolean add(LabelLink o)

Used to add a LabelLinks object to the end of the LabelLinkCollection.

Remarks:

You can use the Map.getLabelLinks() property to access the supported members of the LabelLinkCollection class.

Specified by:

add in interface Collection<LabelLink>

Parameters:

o -

See Also:

setCulture(java.util.Locale), contains(java.lang.Object), copyTo(com.softwarefx.chartfx.server.maps.LabelLink[], int), indexOf(com.softwarefx.chartfx.server.maps.LabelLink), insert(int, com.softwarefx.chartfx.server.maps.LabelLink), remove(java.lang.Object)

addAll

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

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

Specified by:

addAll in interface Collection<LabelLink>

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

contains

public boolean contains(Object o)

Determines whether the LabelLinkCollection contains a specific element.

Remarks:

Returns true if the LabelLinkCollection contains the specified LabelLink item; otherwise, false.

Specified by:

contains in interface Collection<LabelLink>

Parameters:

o -

See Also:

copyTo(com.softwarefx.chartfx.server.maps.LabelLink[], int), indexOf(com.softwarefx.chartfx.server.maps.LabelLink), insert(int, com.softwarefx.chartfx.server.maps.LabelLink), remove(java.lang.Object)

containsAll

public boolean containsAll(Collection<?> c)

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

Specified by:

containsAll in interface Collection<LabelLink>

Parameters:

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

copyTo

public void copyTo(LabelLink[] array,
                   int index)

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

Remarks:

The specified array must be of a compatible type.

Parameters:

array - Array that is the destination of the LabelLink objects copied from LabelLinkCollection.

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

See Also:

copyTo(com.softwarefx.chartfx.server.maps.LabelLink[], int), indexOf(com.softwarefx.chartfx.server.maps.LabelLink), insert(int, com.softwarefx.chartfx.server.maps.LabelLink), remove(java.lang.Object)

get

public LabelLink get(int i)

Returns the element at the specified position in the LabelLinkCollection.

Parameters:

i -

getCulture

public Locale getCulture()

Gets the Culture. For more detail see setCulture(java.util.Locale).

getMapGallery

public com.softwarefx.chartfx.server.maps.MapGallery getMapGallery()

Gets the MapGallery. For more detail see setMapGallery(com.softwarefx.chartfx.server.maps.MapGallery).

indexOf

public int indexOf(LabelLink labelObj)

Searches for the specified Object and returns the zero-based index of the first occurrence within the entire LabelLinkCollection.

Remarks:

This method returns a zero-based index of the first occurrence of value within the entire LabelLinkCollection, if found; otherwise, -1.

Parameters:

labelObj - The LabelLink object to locate in the LabelLinkCollection.

See Also:

contains(java.lang.Object), copyTo(com.softwarefx.chartfx.server.maps.LabelLink[], int), insert(int, com.softwarefx.chartfx.server.maps.LabelLink), remove(java.lang.Object)

insert

public void insert(int index,
                   LabelLink labelObj)

Inserts an element into the LabelLinkCollection at the specified index.

Remarks:

Parameters:

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

labelObj - The LabelLink object to insert.

See Also:

contains(java.lang.Object), copyTo(com.softwarefx.chartfx.server.maps.LabelLink[], int), indexOf(com.softwarefx.chartfx.server.maps.LabelLink), remove(java.lang.Object)

isEmpty

public boolean isEmpty()

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface Collection<LabelLink>

iterator

public Iterator<LabelLink> iterator()

Returns an iterator over the elements in this collection.

Specified by:

iterator in interface Iterable<LabelLink>

Specified by:

iterator in interface Collection<LabelLink>

remove

public boolean remove(Object o)

Removes the first occurrence of a specific object from the LabelLinkCollection.

Remarks:

Specified by:

remove in interface Collection<LabelLink>

Parameters:

o -

See Also:

contains(java.lang.Object), copyTo(com.softwarefx.chartfx.server.maps.LabelLink[], int), indexOf(com.softwarefx.chartfx.server.maps.LabelLink), insert(int, com.softwarefx.chartfx.server.maps.LabelLink)

removeAll

public boolean removeAll(Collection<?> c)

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

Specified by:

removeAll in interface Collection<LabelLink>

Parameters:

c - Elements to be removed from this collection.

retainAll

public boolean retainAll(Collection<?> c)

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

Specified by:

retainAll in interface Collection<LabelLink>

Parameters:

c - Elements to be retained in this collection.

set

public void set(int i,
                LabelLink value)

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

Parameters:

i -

value - The item to add to the LabelLinkCollection collection

setCulture

public void setCulture(Locale value)

Allows you to localize the LabelLinkCollection object for a specific language and region.

Remarks:

The Map.setCulture(java.util.Locale) property of the Map class allows you to configure a culture for the entire map, if no attributes are set using this property then Chart FX inherits the current Thread culture.

See Also:

Map.setCulture(java.util.Locale), LabelLink.setCulture(java.util.Locale), Map, LabelLink

setMapGallery

public void setMapGallery(com.softwarefx.chartfx.server.maps.MapGallery value)

Internal Use.

size

public int size()

Returns the number of elements in this collection.

Specified by:

size in interface Collection<LabelLink>

toArray

public Object[] toArray()

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

Specified by:

toArray in interface Collection<LabelLink>

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