jfxtras.icalendarfx.utilities

Interface Orderer

All Known Implementing Classes:

OrdererBase

public interface Orderer

Provides a framework to maintain the sort order of VChild elements

See Also:

VCalendar, VComponent, Property, RecurrenceRule

Method Summary

Modifier and Type	Method and Description
java.util.Map<VChild,java.lang.Integer>	elementSortOrderMap() <p>Sort order map for VChild elements of a VParent.</p>
void	registerSortOrderProperty(javafx.beans.property.ObjectProperty<? extends VChild> property) <p>Register an ObjectProperty with the Orderer.</p> <p>Enables maintaining automatic sort order.</p>
void	registerSortOrderProperty(javafx.collections.ObservableList<? extends VChild> list) <p>Register an ObservableList with the Orderer.</p> <p>Enables maintaining automatic sort order.</p>
<T extends VChild> void	replaceList(javafx.collections.ObservableList<T> oldList, javafx.collections.ObservableList<T> newList) <p>Replace the elements in the oldList with those in newList.
java.util.List<java.lang.String>	sortedContent() <p>The list of sorted content text for VChild elements.
void	unregisterSortOrderProperty(javafx.beans.property.ObjectProperty<? extends VChild> property) Unregister an ObjectProperty with the Orderer
void	unregisterSortOrderProperty(javafx.collections.ObservableList<? extends VChild> list) Unregister an ObservableList with the Orderer

Method Detail

elementSortOrderMap

java.util.Map<VChild,java.lang.Integer> elementSortOrderMap()

<p>Sort order map for VChild elements of a VParent.</p>

<p>The map key is a VChild. The map value is its sort order.</p>

<p>Under normal conditions, this map shouldn’t be modified. Only modify it when you want to force a specific sort order.</p>

Returns:

the sort order map

sortedContent

java.util.List<java.lang.String> sortedContent()

<p>The list of sorted content text for VChild elements.

Returns:

See Also:

VElement.toContent()

registerSortOrderProperty

void registerSortOrderProperty(javafx.collections.ObservableList<? extends VChild> list)

<p>Register an ObservableList with the Orderer.</p> <p>Enables maintaining automatic sort order.</p>

Parameters:

list - ObservableList from a property containing an ObservableList

unregisterSortOrderProperty

void unregisterSortOrderProperty(javafx.collections.ObservableList<? extends VChild> list)

Unregister an ObservableList with the Orderer

registerSortOrderProperty

void registerSortOrderProperty(javafx.beans.property.ObjectProperty<? extends VChild> property)

<p>Register an ObjectProperty with the Orderer.</p> <p>Enables maintaining automatic sort order.</p>

Parameters:

list - the property to be registered

unregisterSortOrderProperty

void unregisterSortOrderProperty(javafx.beans.property.ObjectProperty<? extends VChild> property)

Unregister an ObjectProperty with the Orderer

replaceList

<T extends VChild> void replaceList(javafx.collections.ObservableList<T> oldList,
                                    javafx.collections.ObservableList<T> newList)

<p>Replace the elements in the oldList with those in newList. Copies sort order values from the elements of oldList when newList items are added to the elementSortOrderMap.</p>

<p>If the number of elements in oldList is less than or equal to the number of elements in the newList then all the elements in the newList get the sort order of the elements in the oldList, in the same order they are found in the map.</p>

<p>If the number of elements in the oldList is greater than the number of elements in the newList then only the number of elements in the oldList have their sort order copied to the newList elements. Remaining newList elements will get new sort order values when they are added.</p>

Parameters:

<T> - class of VChild in the lists

oldList -

newList -