com.yworks.yfiles.view

Interface ISelectionModel<T>

Type Parameters:

T - The type of items contained in the selection's domain.

All Superinterfaces:

IEnumerable<T>, Iterable<T>

All Known Subinterfaces:

IGraphSelection, IStripeSelection

All Known Implementing Classes:

DefaultSelectionModel, GraphSelection, StripeSelection

public interface ISelectionModel<T>
extends IEnumerable<T>

An interface that models the selection state of a set of items.

This interface extends the Iterable interface for convenient enumeration of the selected items. Use the CollectionExtensions.getEnumerator(Iterable) to get all selected items.

Field Summary

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

EMPTY

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.
boolean	isSelected(T item) Determines whether an item is currently selected.
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	setSelected(T item, boolean selected) Sets the selection state of an item.
int	size() Returns the number of selected items.

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

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

addItemSelectionChangedListener

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.

Parameters:

itemSelectionChangedEvent - The listener to add.

See Also:

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

clear

void clear()

Clears the selection.

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

See Also:

addItemSelectionChangedListener(IEventHandler)

isSelected

boolean isSelected(T item)

Determines whether an item is currently selected.

Parameters:

item - The item to check.

Returns:

Whether it is currently selected.

removeItemSelectionChangedListener

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.

Parameters:

itemSelectionChangedEvent - The listener to remove.

See Also:

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

setSelected

void setSelected(T item,
                 boolean selected)

Sets the selection state of an item.

If the state changes, this will trigger the ItemSelectionChanged event.

Parameters:

item - The item to set the selection state for.

selected - Whether to select the object.

size

int size()

Returns the number of selected items.

Returns:

The Count.