SoftwareFX.ChartFX
Class ConditionalAttributesCollection

java.lang.Object
  SoftwareFX.ChartFX.DisplayBaseCollection
      SoftwareFX.ChartFX.ConditionalAttributesCollection

All Implemented Interfaces:

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

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

Provides access to the ConditionalAttributesCollection object.

Derived from the DisplayBaseCollection, this class provides the developer with members to control and maintain the conditional attributes collection. Standard collection members are supported as well as a set of additional members. These class members are used to apply conditional attributes to the chart as well as overriding default behaviors to improve performance.

For more information, please view the individual member pages of this class.

Constructor Summary

ConditionalAttributesCollection()

Method Summary

boolean	add(ConditionalAttributes element) Appends the specified element to the ConditionalAttributesCollection collection.
void	add(int index, ConditionalAttributes element) Appends the specified element to the ConditionalAttributesCollection collection.
void	add(int index, java.lang.Object element) Appends the specified element to the ConditionalAttributesCollection collection.
boolean	add(java.lang.Object element) Appends the specified element to the ConditionalAttributesCollection collection.
boolean	addAll(java.util.Collection elements) Adds all of the elements in the specified collection to the ConditionalAttributesCollection collection.
boolean	addAll(int index, java.util.Collection elements) Adds all of the elements in the specified collection to the ConditionalAttributesCollection collection.
void	clear() Removes all of the elements from this collection.
boolean	contains(ConditionalAttributes element) Returns true if the ConditionalAttributesCollection contains the specified element.
boolean	contains(java.lang.Object element) Returns true if the ConditionalAttributesCollection contains the specified element.
boolean	containsAll(java.util.Collection elements) Returns true if the ConditionalAttributesCollection collection contains all of the elements in the specified collection.
java.util.Enumeration	elements() Returns an enumeration of the values in the ConditionalAttributesCollection .
boolean	equals(ConditionalAttributesCollection 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 ConditionalAttributesCollection.
ConditionalAttributes	getItem(int n) Gets and Sets the element at the specified position in the ConditionalAttributesCollection.
int	hashCode() Returns the hash code value for this collection.
boolean	hasMoreElements() Tests if this enumeration contains more elements.
int	indexOf(ConditionalAttributes element) Returns the index in the ConditionalAttributesCollection of the first occurrence of the specified element, or -1 if this list does not contain this element.
int	indexOf(java.lang.Object element) Returns the index in the ConditionalAttributesCollection of the first occurrence of the specified element, or -1 if this list does not contain this element.
boolean	isEmpty() Returns true if this collection contains no elements.
boolean	isUserLegend() Gets the UserLegend.
java.util.Iterator	iterator() Returns an iterator over the elements in this collection.
int	lastIndexOf(ConditionalAttributes element) Returns the index in the ConditionalAttributesCollection 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 ConditionalAttributesCollection 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.
void	recalculate() Used to instruct Chart FX to re-apply the configured conditional attributes to the chart.
void	refreshLegend() Used to instruct Chart FX to re-apply the configured conditional attributes to the legends.
boolean	remove(ConditionalAttributes element) Removes the specified element from the ConditionalAttributesCollection collection.
java.lang.Object	remove(int index) Removes the specified element from the ConditionalAttributesCollection collection.
boolean	remove(java.lang.Object element) Removes the specified element from the ConditionalAttributesCollection collection.
boolean	removeAll(java.util.Collection elements) Removes all of the elements in the specified collection from the ConditionalAttributesCollection collection.
void	resumeUpdate() Resumes the automatic behavior of re-applying Conditional attributes when data is modified in the chart.
boolean	retainAll(java.util.Collection elements) Retains only the elements in the ConditionalAttributesCollection collection that are contained in the specified collection.
ConditionalAttributes	set(int index, ConditionalAttributes element) Replaces the element at the specified position in the ConditionalAttributesCollection collection with the specified element.
java.lang.Object	set(int index, java.lang.Object element) Replaces the element at the specified position in the ConditionalAttributesCollection collection with the specified element.
void	setUserLegend(boolean value) Gets or sets a value indicating whether conditional attributes should be applied to the UserLegend.
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.
void	suspendUpdate() Suspends the automatic behavior of re-applying Conditional attributes when data is modified in the chart.
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

ConditionalAttributesCollection

public ConditionalAttributesCollection()

Method Detail

add

public boolean add(java.lang.Object element)

Appends the specified element to the ConditionalAttributesCollection 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 ConditionalAttributesCollection collection.

add

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

Appends the specified element to the ConditionalAttributesCollection collection.

Specified by:

add in interface java.util.List

Parameters:

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

element - The item to add to the ConditionalAttributesCollection collection.

add

public boolean add(ConditionalAttributes element)

Appends the specified element to the ConditionalAttributesCollection collection.

Parameters:

element - The item to add to the ConditionalAttributesCollection collection.

add

public void add(int index,
                ConditionalAttributes element)

Appends the specified element to the ConditionalAttributesCollection collection.

Parameters:

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

element - The item to add to the ConditionalAttributesCollection collection.

addAll

public boolean addAll(java.util.Collection elements)

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

Specified by:

addAll in interface java.util.List

Parameters:

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

Overrides:

clear in class DisplayBaseCollection

contains

public boolean contains(java.lang.Object element)

Returns true if the ConditionalAttributesCollection 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(ConditionalAttributes element)

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

Specified by:

get in interface java.util.List

Parameters:

index - Index of element to return.

getItem

public ConditionalAttributes getItem(int n)

Gets and Sets the element at the specified position in the ConditionalAttributesCollection.

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

indexOf

public int indexOf(java.lang.Object element)

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

Specified by:

indexOf in interface java.util.List

Overrides:

indexOf in class DisplayBaseCollection

Parameters:

element - Element to search for.

indexOf

public int indexOf(ConditionalAttributes element)

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

Parameters:

element - Element to search for.

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

isUserLegend

public boolean isUserLegend()

Gets the UserLegend. For more detail see setUserLegend(boolean).

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 ConditionalAttributesCollection 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(ConditionalAttributes element)

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

recalculate

public void recalculate()

Used to instruct Chart FX to re-apply the configured conditional attributes to the chart.

Remarks:

When data values are modified, the configured conditional attributes are automatically applied to the chart. However, if the values of the Conditional Attributes themselves are modified, this method must be called to re-apply the attributes with new settings to the chart.

To improve performance, the refreshLegend() method has been implemented to allow devlopers to re-apply conditional attributes to the legends rather than the entire chart. This may be useful when no data is modified in a chart, only the labels or colors used in legends.

The suspendUpdate() and resumeUpdate() methods may be utilized to override the default behavior to re-apply Conditional Attributes when the chart's data array is modified.

See Also:

refreshLegend(), suspendUpdate(), resumeUpdate()

refreshLegend

public void refreshLegend()

Used to instruct Chart FX to re-apply the configured conditional attributes to the legends.

Remarks:

When data values are modified, the configured conditional attributes are automatically applied to the chart. However, if the values of the Conditional Attributes themselves are modified, this method must be called to re-apply the attributes with new settings to the legends.

To improve performance, the RefreshLegend method has been implemented to allow devlopers to re-apply conditional attributes to the legends rather than the entire chart (recalculate()). This may be useful when no data is modified in a chart, only the labels or colors used in legends.

The suspendUpdate() and resumeUpdate() methods may be utilized to override the default behavior to re-apply Conditional Attributes when the chart's data array is modified.

See Also:

recalculate(), resumeUpdate(), suspendUpdate()

remove

public boolean remove(java.lang.Object element)

Removes the specified element from the ConditionalAttributesCollection 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 ConditionalAttributesCollection collection.

remove

public java.lang.Object remove(int index)

Removes the specified element from the ConditionalAttributesCollection collection.

Specified by:

remove in interface java.util.List

Parameters:

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

remove

public boolean remove(ConditionalAttributes element)

Removes the specified element from the ConditionalAttributesCollection collection.

Parameters:

element - The item to remove from the ConditionalAttributesCollection collection.

removeAll

public boolean removeAll(java.util.Collection elements)

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

resumeUpdate

public void resumeUpdate()

Resumes the automatic behavior of re-applying Conditional attributes when data is modified in the chart.

Remarks:

When the chart's data array is modified (chart values change), the automatic behavior of configured ConditionalAttributes are to be re-applied to the chart. Using the suspendUpdate() method, developers can disable this default behavior. Using the ResumeUpdate method, developers may resume automatic updates by Chart FX.

If you plan on modifiying a large number of data values in a chart, you may wish to call the suspendUpdate()
method until this processing is complete. This allows for improved performance.

Developers may always force this update by calling the recalculate() method.

See Also:

suspendUpdate(), recalculate()

retainAll

public boolean retainAll(java.util.Collection elements)

Retains only the elements in the ConditionalAttributesCollection 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 ConditionalAttributesCollection collection with the specified element.

Specified by:

set in interface java.util.List

Parameters:

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

element - The item to add to the ConditionalAttributesCollection collection

set

public ConditionalAttributes set(int index,
                                 ConditionalAttributes element)

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

Parameters:

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

element - The item to add to the ConditionalAttributesCollection collection

setUserLegend

public void setUserLegend(boolean value)

Gets or sets a value indicating whether conditional attributes should be applied to the UserLegend.

Remarks:

When this property is set to false, conditional attributes will not be applied to the UserLegendBox object.

The refreshLegend() method is used to instruct Chart FX to re-apply the configured conditional attributes to the legends only. The recalculate() method may be used to re-apply conditional attributes to the entire chart.

See Also:

recalculate(), refreshLegend()

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.

suspendUpdate

public void suspendUpdate()

Suspends the automatic behavior of re-applying Conditional attributes when data is modified in the chart.

Remarks:

When the chart's data array is modified (chart values change), the automatic behavior of configured ConditionalAttributes are to be re-applied to the chart. Using the SuspendUpdate method, developers can disable this default behavior. Using the resumeUpdate() method, developers may resume automatic updates by Chart FX.

If you plan on modifiying a large number of data values in a chart, you may wish to call the SuspendUpdate
method until this processing is complete. This allows for improved performance.

Developers may always force this update by calling the recalculate() method.

See Also:

recalculate(), resumeUpdate()

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