com.yworks.yfiles.view

Class DefaultSelectionModel<T>

java.lang.Object

com.yworks.yfiles.view.DefaultSelectionModel<T>

Type Parameters:

T - The type of the items to be selected.

All Implemented Interfaces:

IEnumerable<T>, ISelectionModel<T>, Iterable<T>

public class DefaultSelectionModel<T>
extends Object
implements ISelectionModel<T>, IEnumerable<T>

Default implementation of an ISelectionModel that is based on an observable collection to hold the selected elements.

This selection model has a domain that's controlled with a predicate which encompasses the items that can be selected. If that domain changes it is important to delegate item removal events from the domain model to this selection model to ensure that items that have been removed are deselected as well. A convenience event handler exists for that purpose.

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.IEnumerable

EMPTY

Constructor Summary

Constructors

Constructor and Description
DefaultSelectionModel() Creates a default selection model implementation that uses a ObservableCollection to hold the selection.

Method Summary

Modifier and Type	Method and Description
void	addItemSelectionChangedListener(IEventHandler<ItemSelectionChangedEventArgs<T>> itemSelectionChangedEvent) Adds the given listener for the ItemSelectionChanged event that occurs when an item changed its selection state from selected to unselected or vice versa.
void	clear() Clears the selection.
IEnumerator<T>	enumerator() Returns an IEnumerator over a set of elements of type T.
Predicate<T>	getIsInDomain() Gets the predicate which determines whether the queried item should be considered for this selection model.
IObservableCollection<T>	getSelection() Provides an observable collection view over the selected items.
boolean	isSelected(T item) Determines whether an item is selected by checking for the containment in the Selection.
void	itemRemovedFromDomainHandler(Object source, ItemEventArgs<T> evt) Event handler for domain item removal events that removes the item from this model.
protected void	onItemSelectionChanged(T o, boolean selected) Called when an item gets selected or deselected.
void	removeDomainItem(T item) Removes the given item from the selection in response to the item being removed from the domain.
void	removeItemSelectionChangedListener(IEventHandler<ItemSelectionChangedEventArgs<T>> itemSelectionChangedEvent) Removes the given listener for the ItemSelectionChanged event that occurs when an item changed its selection state from selected to unselected or vice versa.
void	setIsInDomain(Predicate<T> value) Sets the predicate which determines whether the queried item should be considered for this selection model.
void	setSelected(T item, boolean selected) Sets the selection state of the item.
int	size() Returns the number of selected items.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yworks.yfiles.utils.IEnumerable

concat, concat, create, create, iterator, parallelStream, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DefaultSelectionModel

public DefaultSelectionModel()

Creates a default selection model implementation that uses a ObservableCollection to hold the selection.

Method Detail

addItemSelectionChangedListener

public final void addItemSelectionChangedListener(IEventHandler<ItemSelectionChangedEventArgs<T>> itemSelectionChangedEvent)

Description copied from interface: ISelectionModel

Adds the given listener for the ItemSelectionChanged event that occurs when an item changed its selection state from selected to unselected or vice versa.

Specified by:

addItemSelectionChangedListener in interface ISelectionModel<T>

Parameters:

itemSelectionChangedEvent - The listener to add.

See Also:

ISelectionModel.setSelected(java.lang.Object, boolean), ISelectionModel.removeItemSelectionChangedListener(IEventHandler)

clear

public void clear()

Description copied from interface: ISelectionModel

Clears the selection.

This is a convenience method that will set the selection state of all elements to unselected.

Specified by:

clear in interface ISelectionModel<T>

See Also:

ISelectionModel.addItemSelectionChangedListener(IEventHandler)

enumerator

public final IEnumerator<T> enumerator()

Description copied from interface: IEnumerable

Returns an IEnumerator over a set of elements of type T.

Specified by:

enumerator in interface IEnumerable<T>

Returns:

an IEnumerator.

getIsInDomain

public final Predicate<T> getIsInDomain()

Gets the predicate which determines whether the queried item should be considered for this selection model.

Returns:

The IsInDomain.

See Also:

setIsInDomain(Predicate)

getSelection

public final IObservableCollection<T> getSelection()

Provides an observable collection view over the selected items.

Returns:

The Selection.

isSelected

public boolean isSelected(T item)

Determines whether an item is selected by checking for the containment in the Selection.

Specified by:

isSelected in interface ISelectionModel<T>

Parameters:

item - The item to check

Returns:

Whether the item is selected.

itemRemovedFromDomainHandler

public final void itemRemovedFromDomainHandler(Object source,
                                               ItemEventArgs<T> evt)

Event handler for domain item removal events that removes the item from this model.

This method is intended to be used to delegate item removal events from the respective domain collection:

This method calls removeDomainItem(Object) with Item.

Parameters:

source - The instance that raised the event.

evt - The event arguments.

onItemSelectionChanged

protected void onItemSelectionChanged(T o,
                                      boolean selected)

Called when an item gets selected or deselected.

Triggers the ItemSelectionChanged event.

Parameters:

o - The item.

selected - Whether or not the item is selected after the change.

removeDomainItem

public void removeDomainItem(T item)

Removes the given item from the selection in response to the item being removed from the domain.

Parameters:

item - The item to remove from the considered items.

removeItemSelectionChangedListener

public final void removeItemSelectionChangedListener(IEventHandler<ItemSelectionChangedEventArgs<T>> itemSelectionChangedEvent)

Description copied from interface: ISelectionModel

Removes the given listener for the ItemSelectionChanged event that occurs when an item changed its selection state from selected to unselected or vice versa.

Specified by:

removeItemSelectionChangedListener in interface ISelectionModel<T>

Parameters:

itemSelectionChangedEvent - The listener to remove.

See Also:

ISelectionModel.setSelected(java.lang.Object, boolean), ISelectionModel.addItemSelectionChangedListener(IEventHandler)

setIsInDomain

public final void setIsInDomain(Predicate<T> value)

Sets the predicate which determines whether the queried item should be considered for this selection model.

Parameters:

value - The IsInDomain to set.

See Also:

getIsInDomain()

setSelected

public void setSelected(T item,
                        boolean selected)

Sets the selection state of the item.

Specified by:

setSelected in interface ISelectionModel<T>

Parameters:

item - The item to set the selection state for.

selected - Whether to select the object.

size

public int size()

Description copied from interface: ISelectionModel

Returns the number of selected items.

Specified by:

size in interface ISelectionModel<T>

Returns:

The Count.