to.etc.domui.component.tbl

Class InstanceSelectionModel<T>

java.lang.Object

to.etc.domui.component.tbl.AbstractSelectionModel<T>

to.etc.domui.component.tbl.InstanceSelectionModel<T>

All Implemented Interfaces:

Iterable<T>, IAcceptable<T>, ISelectionModel<T>

public class InstanceSelectionModel<T>
extends AbstractSelectionModel<T>
implements Iterable<T>, IAcceptable<T>

This is a selection model that selects simple instances. It allows both single and multiple selections. It collects the selected instances in a set, so the instances should have well-defined equals and hashcode meaning either the Object versions or properly implemented ones.

Author:

Frits Jalvingh Created on Feb 17, 2011

Constructor Summary

Constructors

Constructor and Description
InstanceSelectionModel(boolean multiSelect)
InstanceSelectionModel(boolean multiSelect, IAcceptable<T> acceptable)

Method Summary

Modifier and Type	Method and Description
boolean	acceptable(T value) Return T to allow an instance to become selected.
void	clearSelection() Clear all selections, then call the listeners to report the change.
T	getSelected() Only usable for a non-multiselect, this returns the selected item or null.
Set<T>	getSelectedSet()
int	getSelectionCount() Return the #of instances currently selected.
boolean	isMultiSelect() T if this model can handle multiple selections.
boolean	isSelected(T rowinstance) Return T if this instance is actually selected.
Iterator<T>	iterator()
void	selectAll(ITableModel<T> in) This must add all (recoverable) items in the model and add them as selected as efficiently as possible.
void	setInstanceSelected(T rowinstance, boolean on) Set or clear an instance's selected state.
void	setSelectedSet(Collection<T> in)

Methods inherited from class to.etc.domui.component.tbl.AbstractSelectionModel

addListener, callChanged, callSelectionAllChanged, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

InstanceSelectionModel

public InstanceSelectionModel(boolean multiSelect)

InstanceSelectionModel

public InstanceSelectionModel(boolean multiSelect,
                              @Nullable
                              IAcceptable<T> acceptable)

Method Detail

isMultiSelect

public final boolean isMultiSelect()

Description copied from interface: ISelectionModel

T if this model can handle multiple selections.

Specified by:

isMultiSelect in interface ISelectionModel<T>

Returns:

getSelectionCount

public int getSelectionCount()

Description copied from interface: ISelectionModel

Return the #of instances currently selected.

Specified by:

getSelectionCount in interface ISelectionModel<T>

Returns:

acceptable

public boolean acceptable(@Nonnull
                          T value)

Description copied from interface: IAcceptable

Return T to allow an instance to become selected.

Specified by:

acceptable in interface IAcceptable<T>

Returns:

isSelected

public boolean isSelected(@Nonnull
                          T rowinstance)

Description copied from interface: ISelectionModel

Return T if this instance is actually selected.

Specified by:

isSelected in interface ISelectionModel<T>

Returns:

setInstanceSelected

public void setInstanceSelected(@Nonnull
                                T rowinstance,
                                boolean on)
                         throws Exception

Description copied from interface: ISelectionModel

Set or clear an instance's selected state. When changed the model will call the listeners to report the change.

Specified by:

setInstanceSelected in interface ISelectionModel<T>

Throws:

Exception

clearSelection

public void clearSelection()
                    throws Exception

Description copied from interface: ISelectionModel

Clear all selections, then call the listeners to report the change.

Specified by:

clearSelection in interface ISelectionModel<T>

Throws:

Exception

selectAll

public void selectAll(ITableModel<T> in)
               throws Exception

Description copied from interface: ISelectionModel

This must add all (recoverable) items in the model and add them as selected as efficiently as possible. It is NEVER called directly, but always through a ISelectionAllHandler, so that "select all" can be forbidden.

Specified by:

selectAll in interface ISelectionModel<T>

Throws:

Exception

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

getSelectedSet

@Nonnull
public Set<T> getSelectedSet()

getSelected

@Nullable
public T getSelected()

Only usable for a non-multiselect, this returns the selected item or null.

Returns:

setSelectedSet

public void setSelectedSet(@Nonnull
                           Collection<T> in)
                    throws Exception

Throws:

Exception