org.jminor.common.model

Interface FilteredModel<T>

Type Parameters:

T - the type of data in the model.

All Known Subinterfaces:

EntityComboBoxModel, EntityTableModel<E>, FilteredComboBoxModel<T>, FilteredTableModel<R,C,T>

All Known Implementing Classes:

AbstractFilteredTableModel, BooleanComboBoxModel, FXEntityListModel, ItemComboBoxModel, ObservableEntityList, SwingEntityComboBoxModel, SwingEntityTableModel, SwingFilteredComboBoxModel, SwingPropertyComboBoxModel

public interface FilteredModel<T>

Specifies a data model that can be filtered to hide some or all of the items it contains.

Method Summary

Modifier and Type	Method and Description
void	addFilteringListener(EventListener listener)
boolean	contains(T item, boolean includeFiltered) Returns true if this model contains the given item, visible or filtered.
void	filterContents() Filters the table according to the condition returned by getFilterCondition().
java.util.List<T>	getAllItems()
FilterCondition<T>	getFilterCondition() Returns the filter condition defined by this model, null if no filter condition has been set.
int	getFilteredItemCount()
java.util.List<T>	getFilteredItems()
int	getVisibleItemCount()
java.util.List<T>	getVisibleItems()
boolean	isFiltered(T item) Returns true if the given item is being filtered in this model, that is, is not visible
boolean	isVisible(T item) Returns true if the given item is visible, that is, not filtered in this model
void	removeFilteringListener(EventListener listener)
void	setFilterCondition(FilterCondition<T> filterCondition) Sets the filter condition and filters the model

Method Detail

addFilteringListener

void addFilteringListener(EventListener listener)

Parameters:

listener - a listener notified each time this model is filtered

removeFilteringListener

void removeFilteringListener(EventListener listener)

Parameters:

listener - the listener to remove

filterContents

void filterContents()

Filters the table according to the condition returned by getFilterCondition(). If no filter condition is specified this method does nothing. This method does not interfere with the internal ordering of the visible items.

See Also:

getFilterCondition(), setFilterCondition(FilterCondition), addFilteringListener(EventListener)

getFilterCondition

FilterCondition<T> getFilterCondition()

Returns the filter condition defined by this model, null if no filter condition has been set.

Returns:

the filter condition

setFilterCondition

void setFilterCondition(FilterCondition<T> filterCondition)

Sets the filter condition and filters the model

Parameters:

filterCondition - the FilterCondition to use, null if no filtering should be performed

getVisibleItems

java.util.List<T> getVisibleItems()

Returns:

an unmodifiable view of the visible items

getFilteredItems

java.util.List<T> getFilteredItems()

Returns:

an unmodifiable view of the filtered items

getAllItems

java.util.List<T> getAllItems()

Returns:

all visible and filtered items in this table model

getVisibleItemCount

int getVisibleItemCount()

Returns:

the number of currently visible items

getFilteredItemCount

int getFilteredItemCount()

Returns:

the number of currently filtered items

contains

boolean contains(T item,
                 boolean includeFiltered)

Returns true if this model contains the given item, visible or filtered.

Parameters:

item - the item

includeFiltered - if true then the filtered items are included

Returns:

true if this model contains the item

isVisible

boolean isVisible(T item)

Returns true if the given item is visible, that is, not filtered in this model

Parameters:

item - the item

Returns:

true if the given item is visible

isFiltered

boolean isFiltered(T item)

Returns true if the given item is being filtered in this model, that is, is not visible

Parameters:

item - the item

Returns:

true if the given item is filtered