Package com.simsilica.lemur.list

Class SelectionModel

java.lang.Object

java.util.AbstractCollection<Integer>

java.util.AbstractSet<Integer>

com.simsilica.lemur.core.VersionedSet<Integer>

com.simsilica.lemur.list.SelectionModel

All Implemented Interfaces:

VersionedObject<Set<Integer>>, Iterable<Integer>, Collection<Integer>, Set<Integer>

public class SelectionModel
extends VersionedSet<Integer>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SelectionModel.SelectionMode

Constructor Summary

Constructors

Constructor	Description
SelectionModel()

Method Summary

Modifier and Type	Method	Description
boolean	add(Integer selection)
VersionedReference<Integer>	createSelectionReference()	For single-selections, this will hold the currently selected value.
Integer	getSelection()	Returns the single selection if there is only one selected item or null if there is no selection or more than one item is selected.
SelectionModel.SelectionMode	getSelectionMode()
protected void	incrementVersion()
void	setSelection(Integer selection)	Sets the currently selected single value regardless of selection mode.
void	setSelectionMode(SelectionModel.SelectionMode mode)
protected void	updateSelected()

Methods inherited from class com.simsilica.lemur.core.VersionedSet

createReference, getObject, getVersion, iterator, size

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, clear, contains, containsAll, isEmpty, remove, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

addAll, clear, contains, containsAll, isEmpty, remove, retainAll, spliterator, toArray, toArray

Constructor Details

SelectionModel

public SelectionModel()

Method Details

createSelectionReference

public VersionedReference<Integer> createSelectionReference()

For single-selections, this will hold the currently selected value.

setSelectionMode

public void setSelectionMode(SelectionModel.SelectionMode mode)

getSelectionMode

public SelectionModel.SelectionMode getSelectionMode()

getSelection

public Integer getSelection()

Returns the single selection if there is only one selected item or null if there is no selection or more than one item is selected.

setSelection

public void setSelection(Integer selection)

Sets the currently selected single value regardless of selection mode. This clears the set before adding the selection. Also, if the specified selection is less than 0 then the selection is simply cleared.

add

public boolean add(Integer selection)

Specified by:

add in interface Collection<Integer>

Specified by:

add in interface Set<Integer>

Overrides:

add in class VersionedSet<Integer>

incrementVersion

protected void incrementVersion()

Overrides:

incrementVersion in class VersionedSet<Integer>

updateSelected

protected void updateSelected()