org.jminor.swing.common.model.combobox

Class SwingFilteredComboBoxModel<T>

java.lang.Object

org.jminor.swing.common.model.combobox.SwingFilteredComboBoxModel<T>

Type Parameters:

T - the type of values in this combo box model

All Implemented Interfaces:

javax.swing.ComboBoxModel<T>, javax.swing.ListModel<T>, FilteredComboBoxModel<T>, FilteredModel<T>, Refreshable

Direct Known Subclasses:

ItemComboBoxModel, SwingEntityComboBoxModel, SwingPropertyComboBoxModel

public class SwingFilteredComboBoxModel<T>
extends java.lang.Object
implements FilteredComboBoxModel<T>, javax.swing.ComboBoxModel<T>

A default FilteredComboBoxModel implementation.

Constructor Summary

Constructors

Constructor and Description
SwingFilteredComboBoxModel() Instantiates a new SwingFilteredComboBoxModel, without a nullValueString.
SwingFilteredComboBoxModel(T nullValue) Instantiates a new SwingFilteredComboBoxModel, without a nullValueString.
SwingFilteredComboBoxModel(T nullValue, java.util.Comparator<T> sortComparator) Instantiates a new SwingFilteredComboBoxModel with the given nullValueString.

Method Summary

Modifier and Type	Method and Description
void	addFilteringListener(EventListener listener)
void	addItem(T item) Adds the given item to this model, respecting the sorting order if specified
void	addListDataListener(javax.swing.event.ListDataListener listener)
void	addSelectionListener(EventDataListener<T> listener)
protected boolean	allowSelectionChange(T itemToSelect)
void	clear() Clears all data from this refreshable instance
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().
protected void	fireContentsChanged() Fires a ListDataEvent.CONTENTS_CHANGED event on all registered listeners
java.util.List<T>	getAllItems()
T	getElementAt(int index)
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()
T	getNullValue()
T	getSelectedItem()
T	getSelectedValue()
int	getSize()
java.util.Comparator<T>	getSortComparator()
int	getVisibleItemCount()
java.util.List<T>	getVisibleItems()
protected java.util.List<T>	initializeContents()
boolean	isCleared()
boolean	isFiltered(T item) Returns true if the given item is being filtered in this model, that is, is not visible
boolean	isFilterSelectedItem() Specifies whether or not filtering can change the selected item, if true then the selected item is set to null when the currently selected item is filtered from the model, otherwise the selected item can potentially represent a value which is not currently visible in the model.
boolean	isNullValueSelected() Returns true if the value representing null is selected, false if no such value has been specified or if it is not selected.
boolean	isSelectionEmpty()
boolean	isVisible(T item) Returns true if the given item is visible, that is, not filtered in this model
void	refresh() Performs a refresh, reloading the relevant data
void	removeFilteringListener(EventListener listener)
void	removeItem(T item) Removes the given item from this model
void	removeListDataListener(javax.swing.event.ListDataListener listener)
void	removeSelectionListener(EventDataListener listener)
void	setContents(java.util.Collection<T> contents) Resets the contents of this model using the values found in contents, if contents is null then the model is considered to be cleared.
void	setFilterCondition(FilterCondition<T> filterCondition) Sets the filter condition and filters the model
void	setFilterSelectedItem(boolean value) Specifies whether or not filtering can change the selected item, if true then the selected item is set to null when the currently selected item is filtered from the model, otherwise the selected item can potentially represent a value which is not currently visible in the model.
void	setNullValue(T nullValue) Sets the value which should represent a null value, a refresh is required for it to show up
void	setSelectedItem(java.lang.Object anItem)
void	setSortComparator(java.util.Comparator<T> sortComparator) Sets the Comparator used when sorting the items visible in this model and sorts the model accordingly.
protected T	translateSelectionItem(java.lang.Object item)

Methods inherited from class java.lang.Object

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

Constructor Detail

SwingFilteredComboBoxModel

public SwingFilteredComboBoxModel()

Instantiates a new SwingFilteredComboBoxModel, without a nullValueString. The model contents are sorted automatically.

SwingFilteredComboBoxModel

public SwingFilteredComboBoxModel(T nullValue)

Instantiates a new SwingFilteredComboBoxModel, without a nullValueString. The model contents are sorted automatically with a default collation based comparator.

Parameters:

nullValue - a value representing a null value, which is shown at the top of the item list

SwingFilteredComboBoxModel

public SwingFilteredComboBoxModel(T nullValue,
                                  java.util.Comparator<T> sortComparator)

Instantiates a new SwingFilteredComboBoxModel with the given nullValueString.

Parameters:

nullValue - a value representing a null value, which is shown at the top of the item list

sortComparator - the Comparator used to sort the contents of this combo box model, if null then the contents are not sorted

See Also:

isNullValueSelected()

Method Detail

refresh

public final void refresh()

Performs a refresh, reloading the relevant data

Specified by:

refresh in interface Refreshable

clear

public final void clear()

Clears all data from this refreshable instance

Specified by:

clear in interface Refreshable

isCleared

public final boolean isCleared()

Specified by:

isCleared in interface FilteredComboBoxModel<T>

Returns:

true if the model data has been cleared and needs to be refreshed

setContents

public final void setContents(java.util.Collection<T> contents)

Resets the contents of this model using the values found in contents, if contents is null then the model is considered to be cleared.

Specified by:

setContents in interface FilteredComboBoxModel<T>

Parameters:

contents - the contents to display in this combo box model

See Also:

FilteredComboBoxModel.isCleared()

filterContents

public final 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.

Specified by:

filterContents in interface FilteredModel<T>

See Also:

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

getVisibleItems

public final java.util.List<T> getVisibleItems()

Specified by:

getVisibleItems in interface FilteredModel<T>

Returns:

an unmodifiable view of the visible items

getFilteredItems

public final java.util.List<T> getFilteredItems()

Specified by:

getFilteredItems in interface FilteredModel<T>

Returns:

an unmodifiable view of the filtered items

getAllItems

public final java.util.List<T> getAllItems()

Specified by:

getAllItems in interface FilteredModel<T>

Returns:

all visible and filtered items in this table model

setFilterCondition

public final void setFilterCondition(FilterCondition<T> filterCondition)

Sets the filter condition and filters the model

Specified by:

setFilterCondition in interface FilteredModel<T>

Parameters:

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

getFilterCondition

public final FilterCondition<T> getFilterCondition()

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

Specified by:

getFilterCondition in interface FilteredModel<T>

Returns:

the filter condition

getFilteredItemCount

public final int getFilteredItemCount()

Specified by:

getFilteredItemCount in interface FilteredModel<T>

Returns:

the number of currently filtered items

getVisibleItemCount

public final int getVisibleItemCount()

Specified by:

getVisibleItemCount in interface FilteredModel<T>

Returns:

the number of currently visible items

isVisible

public final boolean isVisible(T item)

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

Specified by:

isVisible in interface FilteredModel<T>

Parameters:

item - the item

Returns:

true if the given item is visible

isFiltered

public final boolean isFiltered(T item)

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

Specified by:

isFiltered in interface FilteredModel<T>

Parameters:

item - the item

Returns:

true if the given item is filtered

addItem

public final void addItem(T item)

Adds the given item to this model, respecting the sorting order if specified

Specified by:

addItem in interface FilteredComboBoxModel<T>

Parameters:

item - the item to add

removeItem

public final void removeItem(T item)

Removes the given item from this model

Specified by:

removeItem in interface FilteredComboBoxModel<T>

Parameters:

item - the item to remove

contains

public final boolean contains(T item,
                              boolean includeFiltered)

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

Specified by:

contains in interface FilteredModel<T>

Parameters:

item - the item

includeFiltered - if true then the filtered items are included

Returns:

true if this model contains the item

getSortComparator

public final java.util.Comparator<T> getSortComparator()

Specified by:

getSortComparator in interface FilteredComboBoxModel<T>

Returns:

the Comparator used when sorting the contents of this model

setSortComparator

public final void setSortComparator(java.util.Comparator<T> sortComparator)

Sets the Comparator used when sorting the items visible in this model and sorts the model accordingly. This Comparator must take into account the null value if a nullValueString is specified. If a null sortComparator is provided no sorting will be performed.

Specified by:

setSortComparator in interface FilteredComboBoxModel<T>

Parameters:

sortComparator - the Comparator, null if the contents of this model should not be sorted

getNullValue

public final T getNullValue()

Specified by:

getNullValue in interface FilteredComboBoxModel<T>

Returns:

the value representing the null value, null if no such value has been specified

setNullValue

public final void setNullValue(T nullValue)

Sets the value which should represent a null value, a refresh is required for it to show up

Specified by:

setNullValue in interface FilteredComboBoxModel<T>

Parameters:

nullValue - a value which is used to represent a null value

isNullValueSelected

public final boolean isNullValueSelected()

Returns true if the value representing null is selected, false if no such value has been specified or if it is not selected.

Specified by:

isNullValueSelected in interface FilteredComboBoxModel<T>

Returns:

true if the value representing null is selected, false otherwise

See Also:

FilteredComboBoxModel.setNullValue(Object)

isSelectionEmpty

public final boolean isSelectionEmpty()

Specified by:

isSelectionEmpty in interface FilteredComboBoxModel<T>

Returns:

true if no value is selected or if the value representing null is selected

getSelectedValue

public final T getSelectedValue()

Specified by:

getSelectedValue in interface FilteredComboBoxModel<T>

Returns:

the selected item, null in case the value representing null is selected

See Also:

FilteredComboBoxModel.setNullValue(Object)

getSelectedItem

public final T getSelectedItem()

Specified by:

getSelectedItem in interface javax.swing.ComboBoxModel<T>

Specified by:

getSelectedItem in interface FilteredComboBoxModel<T>

Returns:

the selected item, N.B. this can include the nullValue in case it has been set, getSelectedValue() is usually what you want

setSelectedItem

public final void setSelectedItem(java.lang.Object anItem)

Specified by:

setSelectedItem in interface javax.swing.ComboBoxModel<T>

Specified by:

setSelectedItem in interface FilteredComboBoxModel<T>

Parameters:

anItem - the item to select

setFilterSelectedItem

public void setFilterSelectedItem(boolean value)

Specifies whether or not filtering can change the selected item, if true then the selected item is set to null when the currently selected item is filtered from the model, otherwise the selected item can potentially represent a value which is not currently visible in the model. By default this is true.

Specified by:

setFilterSelectedItem in interface FilteredComboBoxModel<T>

Parameters:

value - if true then the selected item is changed when it is filtered out,

isFilterSelectedItem

public boolean isFilterSelectedItem()

Specifies whether or not filtering can change the selected item, if true then the selected item is set to null when the currently selected item is filtered from the model, otherwise the selected item can potentially represent a value which is not currently visible in the model. By default this is true.

Specified by:

isFilterSelectedItem in interface FilteredComboBoxModel<T>

Returns:

true if the selected item is changed when it is filtered out

addListDataListener

public final void addListDataListener(javax.swing.event.ListDataListener listener)

Specified by:

addListDataListener in interface javax.swing.ListModel<T>

removeListDataListener

public final void removeListDataListener(javax.swing.event.ListDataListener listener)

Specified by:

removeListDataListener in interface javax.swing.ListModel<T>

getElementAt

public final T getElementAt(int index)

Specified by:

getElementAt in interface javax.swing.ListModel<T>

Specified by:

getElementAt in interface FilteredComboBoxModel<T>

Parameters:

index - the index

Returns:

the item at the given index

getSize

public final int getSize()

Specified by:

getSize in interface javax.swing.ListModel<T>

Specified by:

getSize in interface FilteredComboBoxModel<T>

Returns:

the number of visible items in this model

addFilteringListener

public final void addFilteringListener(EventListener listener)

Specified by:

addFilteringListener in interface FilteredModel<T>

Parameters:

listener - a listener notified each time this model is filtered

removeFilteringListener

public final void removeFilteringListener(EventListener listener)

Specified by:

removeFilteringListener in interface FilteredModel<T>

Parameters:

listener - the listener to remove

addSelectionListener

public final void addSelectionListener(EventDataListener<T> listener)

Specified by:

addSelectionListener in interface FilteredComboBoxModel<T>

Parameters:

listener - a listener notified each time the selection changes

removeSelectionListener

public final void removeSelectionListener(EventDataListener listener)

Specified by:

removeSelectionListener in interface FilteredComboBoxModel<T>

Parameters:

listener - a selection listener to remove

initializeContents

protected java.util.List<T> initializeContents()

Returns:

a List containing the items to be shown in this combo box model, by default it simply returns a list containing the items currently contained in the model, both filtered and visible, excluding the null value.

allowSelectionChange

protected boolean allowSelectionChange(T itemToSelect)

Parameters:

itemToSelect - the item to be selected

Returns:

true if the selection change is ok, false if it should be vetoed

translateSelectionItem

protected T translateSelectionItem(java.lang.Object item)

Parameters:

item - the item to be selected

Returns:

the actual item to select

fireContentsChanged

protected final void fireContentsChanged()

Fires a ListDataEvent.CONTENTS_CHANGED event on all registered listeners