de.javagl.selection

Interface SelectionModel<T>

Type Parameters:

T - The type of the elements

public interface SelectionModel<T>

Interface describing a selection model

Method Summary

Modifier and Type	Method and Description
void	addSelectionListener(SelectionListener<T> selectionListener) Add the given SelectionListener to be informed about changes in this selection model
void	addToSelection(Collection<? extends T> elements) Adds the given elements to this selection
void	addToSelection(T element) Adds the given element to this selection
void	clear() Removes all elements from this selection
Set<T>	getSelection() Returns an unmodifiable view on the set of currently selected elements
boolean	isSelected(T element) Returns whether the given element is currently selected
void	removeFromSelection(Collection<? extends T> elements) Remove the given elements from this selection
void	removeFromSelection(T element) Removes the given element from this selection
void	removeSelectionListener(SelectionListener<T> selectionListener) Remove the given SelectionListener
void	setSelection(Collection<? extends T> elements) Sets the given elements to be the selection of this model.

Method Detail

addToSelection

void addToSelection(T element)

Adds the given element to this selection

Parameters:

element - The element to add

removeFromSelection

void removeFromSelection(T element)

Removes the given element from this selection

Parameters:

element - The element to remove

addToSelection

void addToSelection(Collection<? extends T> elements)

Adds the given elements to this selection

Parameters:

elements - The elements to add

removeFromSelection

void removeFromSelection(Collection<? extends T> elements)

Remove the given elements from this selection

Parameters:

elements - The elements to remove

setSelection

void setSelection(Collection<? extends T> elements)

Sets the given elements to be the selection of this model.

This will cause a single SelectionEvent to be fired. The removed elements and added elements of this event will precisely describe the state change: When the initial selection is {0,1,2,3}, and this method is called with the set {2,3,4,5}, then the removed elements of the resulting event will be {0,1}, and the added elements will be {4,5}.

Parameters:

elements - The elements to select

clear

void clear()

Removes all elements from this selection

isSelected

boolean isSelected(T element)

Returns whether the given element is currently selected

Parameters:

element - The element

Returns:

Whether the element is selected

getSelection

Set<T> getSelection()

Returns an unmodifiable view on the set of currently selected elements

Returns:

The currently selected elements

addSelectionListener

void addSelectionListener(SelectionListener<T> selectionListener)

Add the given SelectionListener to be informed about changes in this selection model

Parameters:

selectionListener - The SelectionListener to add

removeSelectionListener

void removeSelectionListener(SelectionListener<T> selectionListener)

Remove the given SelectionListener

Parameters:

selectionListener - The SelectionListener to remove