SoftwareFX.ChartFX.Map
Class LabelLinkCollection

java.lang.Object
  SoftwareFX.ChartFX.Map.LabelLinkCollection

All Implemented Interfaces:

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

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

Provides access to the LabelLinkCollection object.

The supported members of the LabelLinkCollection class are used to administer the collection of LabelLink objects.

Constructor Summary

LabelLinkCollection()

Method Summary

void	add(int index, LabelLink element) Used to add a LabelLinks object to the end of the LabelLinkCollection.
void	add(int index, java.lang.Object element) Used to add a LabelLinks object to the end of the LabelLinkCollection.
boolean	add(LabelLink element) Used to add a LabelLinks object to the end of the LabelLinkCollection.
boolean	add(java.lang.Object element) Used to add a LabelLinks object to the end of the LabelLinkCollection.
boolean	addAll(java.util.Collection elements) Adds all of the elements in the specified collection to the LabelLinkCollection collection.
boolean	addAll(int index, java.util.Collection elements) 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(LabelLink element) Determines whether the LabelLinkCollection contains a specific element.
boolean	contains(java.lang.Object element) Determines whether the LabelLinkCollection contains a specific element.
boolean	containsAll(java.util.Collection elements) Returns true if the LabelLinkCollection collection contains all of the elements in the specified collection.
java.util.Enumeration	elements() Returns an enumeration of the values in the LabelLinkCollection .
boolean	equals(LabelLinkCollection element) Compares the specified object with this collection for equality.
boolean	equals(java.lang.Object 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 LabelLinkCollection.
java.lang.String	getCulture() Gets the Culture.
LabelLink	getItem(int i) Gets the Item.
int	hashCode() Returns the hash code value for this collection.
boolean	hasMoreElements() Tests if this enumeration contains more elements.
int	indexOf(LabelLink element) Searches for the specified Object and returns the zero-based index of the first occurrence within the entire LabelLinkCollection.
int	indexOf(java.lang.Object element) Searches for the specified Object and returns the zero-based index of the first occurrence within the entire LabelLinkCollection.
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(LabelLink element) Returns the index in the LabelLinkCollection of the last occurrence of the specified element, or -1 if this list does not contain this element.
int	lastIndexOf(java.lang.Object element) Returns the index in the LabelLinkCollection 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 object from the LabelLinkCollection.
boolean	remove(LabelLink element) Removes the first occurrence of a specific object from the LabelLinkCollection.
boolean	remove(java.lang.Object element) Removes the first occurrence of a specific object from the LabelLinkCollection.
boolean	removeAll(java.util.Collection elements) Removes all of the elements in the specified collection from the LabelLinkCollection collection.
boolean	retainAll(java.util.Collection elements) Retains only the elements in the LabelLinkCollection collection that are contained in the specified collection.
LabelLink	set(int index, LabelLink element) Replaces the element at the specified position in the LabelLinkCollection collection with the specified element.
java.lang.Object	set(int index, java.lang.Object element) Replaces the element at the specified position in the LabelLinkCollection collection with the specified element.
void	setCulture(java.lang.String value) Allows you to localize the LabelLinkCollection object for a specific language and region.
void	setItem(int i, LabelLink value) Returns a specific member of the LabelLinkCollection by position.
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

LabelLinkCollection

public LabelLinkCollection()

Method Detail

add

public boolean add(java.lang.Object element)

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.

For more information regarding collection methods, please reference the CollectionBase class in the Java API Reference.

Specified by:

add in interface java.util.Collection

Specified by:

add in interface java.util.List

Parameters:

element -

See Also:

setCulture(java.lang.String), setItem(int, SoftwareFX.ChartFX.Map.LabelLink), contains(java.lang.Object), indexOf(java.lang.Object), remove(java.lang.Object)

add

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

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.

For more information regarding collection methods, please reference the CollectionBase class in the Java API Reference.

Specified by:

add in interface java.util.List

Parameters:

index -

element -

See Also:

setCulture(java.lang.String), setItem(int, SoftwareFX.ChartFX.Map.LabelLink), contains(java.lang.Object), indexOf(java.lang.Object), remove(java.lang.Object)

add

public boolean add(LabelLink element)

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.

For more information regarding collection methods, please reference the CollectionBase class in the Java API Reference.

Parameters:

element -

See Also:

setCulture(java.lang.String), setItem(int, SoftwareFX.ChartFX.Map.LabelLink), contains(java.lang.Object), indexOf(java.lang.Object), remove(java.lang.Object)

add

public void add(int index,
                LabelLink element)

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.

For more information regarding collection methods, please reference the CollectionBase class in the Java API Reference.

Parameters:

index -

element -

See Also:

setCulture(java.lang.String), setItem(int, SoftwareFX.ChartFX.Map.LabelLink), 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 LabelLinkCollection 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 LabelLinkCollection collection.

Specified by:

addAll in interface java.util.List

Parameters:

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

Determines whether the LabelLinkCollection contains a specific element.

Remarks:

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

For more information regarding collection methods, please reference the CollectionBase class in the Java API Reference.

Specified by:

contains in interface java.util.Collection

Specified by:

contains in interface java.util.List

Parameters:

element -

See Also:

indexOf(java.lang.Object), remove(java.lang.Object)

contains

public boolean contains(LabelLink element)

Determines whether the LabelLinkCollection contains a specific element.

Remarks:

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

For more information regarding collection methods, please reference the CollectionBase class in the Java API Reference.

Parameters:

element -

See Also:

indexOf(java.lang.Object), remove(java.lang.Object)

containsAll

public boolean containsAll(java.util.Collection elements)

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

Specified by:

get in interface java.util.List

Parameters:

index - Index of element to return.

getCulture

public java.lang.String getCulture()

Gets the Culture. For more detail see setCulture(java.lang.String).

getItem

public LabelLink getItem(int i)

Gets the Item. For more detail see setItem(int, SoftwareFX.ChartFX.Map.LabelLink).

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)

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.

For more information regarding collection methods, please reference the CollectionBase class in the Java API Reference.

Specified by:

indexOf in interface java.util.List

Parameters:

element -

See Also:

contains(java.lang.Object), remove(java.lang.Object)

indexOf

public int indexOf(LabelLink element)

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.

For more information regarding collection methods, please reference the CollectionBase class in the Java API Reference.

Parameters:

element -

See Also:

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 LabelLinkCollection 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(LabelLink element)

Returns the index in the LabelLinkCollection 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 object from the LabelLinkCollection.

Remarks:

For more information regarding collection methods, please reference the CollectionBase class in the Java API Reference.

Specified by:

remove in interface java.util.Collection

Specified by:

remove in interface java.util.List

Parameters:

element -

See Also:

contains(java.lang.Object), indexOf(java.lang.Object)

remove

public java.lang.Object remove(int index)

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

Remarks:

For more information regarding collection methods, please reference the CollectionBase class in the Java API Reference.

Specified by:

remove in interface java.util.List

Parameters:

index -

See Also:

contains(java.lang.Object), indexOf(java.lang.Object)

remove

public boolean remove(LabelLink element)

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

Remarks:

For more information regarding collection methods, please reference the CollectionBase class in the Java API Reference.

Parameters:

element -

See Also:

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 LabelLinkCollection 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 LabelLinkCollection 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 LabelLinkCollection collection with the specified element.

Specified by:

set in interface java.util.List

Parameters:

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

element - The item to add to the LabelLinkCollection collection

set

public LabelLink set(int index,
                     LabelLink element)

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

Parameters:

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

element - The item to add to the LabelLinkCollection collection

setCulture

public void setCulture(java.lang.String value)

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

Remarks:

If no attributes are set using this property then Chart FX inherits the system culture.

When setting this property, you may need the Language Code and/or Country Code constants for the desired culture. For more information, please refer to the java.util.Locale documentation.

Example:

map1.getLabelLinks()getItem(0).setCulture("es-ES");


See Also:

LabelLink.setCulture(java.lang.String), Map, LabelLink

setItem

public void setItem(int i,
                    LabelLink value)

Returns a specific member of the LabelLinkCollection by position.

Remarks:

If Index doesn't match any existing member of the collection, an error occurs.

See Also:

Map.getLabelLinks()

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