jfxtras.icalendarfx.utilities

Class OrdererBase

java.lang.Object

jfxtras.icalendarfx.utilities.OrdererBase

All Implemented Interfaces:

Orderer

public class OrdererBase
extends java.lang.Object
implements Orderer

Base class to maintain a sort order of VChild elements of a VParent

See Also:

VParent, VCalendar, VComponentBase, PropertyBase, RecurrenceRule2

Constructor Summary

Constructors

Constructor and Description
OrdererBase(VParent aParent) Create an OrdererBase for the VParent parameter

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OrdererBase

public OrdererBase(VParent aParent)

Create an OrdererBase for the VParent parameter

Method Detail

elementSortOrderMap

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

Description copied from interface: Orderer

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

Specified by:

elementSortOrderMap in interface Orderer

Returns:

the sort order map

registerSortOrderProperty

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

Description copied from interface: Orderer

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

Specified by:

registerSortOrderProperty in interface Orderer

Parameters:

list - ObservableList from a property containing an ObservableList

unregisterSortOrderProperty

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

Description copied from interface: Orderer

Unregister an ObservableList with the Orderer

Specified by:

unregisterSortOrderProperty in interface Orderer

registerSortOrderProperty

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

Description copied from interface: Orderer

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

Specified by:

registerSortOrderProperty in interface Orderer

unregisterSortOrderProperty

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

Description copied from interface: Orderer

Unregister an ObjectProperty with the Orderer

Specified by:

unregisterSortOrderProperty in interface Orderer

sortedContent

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

Description copied from interface: Orderer

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

Specified by:

sortedContent in interface Orderer

Returns:

See Also:

VElement.toContent()

replaceList

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

Description copied from interface: Orderer

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

Specified by:

replaceList in interface Orderer