ObservableEntityList (JMinor Framework API 0.12.5-SNAPSHOT)

java.lang.Object
- javafx.beans.binding.ListExpression<E>
- - javafx.beans.property.ReadOnlyListProperty<E>
  - - javafx.beans.property.ListProperty<E>
    - - javafx.beans.property.ListPropertyBase<E>
      - javafx.beans.property.SimpleListProperty<Entity>
        
        org.jminor.javafx.framework.model.ObservableEntityList

All Implemented Interfaces:

java.lang.Iterable<Entity>, java.util.Collection<Entity>, java.util.List<Entity>, javafx.beans.Observable, javafx.beans.property.Property<javafx.collections.ObservableList<Entity>>, javafx.beans.property.ReadOnlyProperty<javafx.collections.ObservableList<Entity>>, javafx.beans.value.ObservableListValue<Entity>, javafx.beans.value.ObservableObjectValue<javafx.collections.ObservableList<Entity>>, javafx.beans.value.ObservableValue<javafx.collections.ObservableList<Entity>>, javafx.beans.value.WritableListValue<Entity>, javafx.beans.value.WritableObjectValue<javafx.collections.ObservableList<Entity>>, javafx.beans.value.WritableValue<javafx.collections.ObservableList<Entity>>, javafx.collections.ObservableList<Entity>, FilteredModel<Entity>, Refreshable

Direct Known Subclasses:

FXEntityListModel
```
public class ObservableEntityList
extends javafx.beans.property.SimpleListProperty<Entity>
implements javafx.collections.ObservableList<Entity>, FilteredModel<Entity>, Refreshable
```
An ObservableList based on a Entity

Constructor Summary

Constructors
Constructor and Description
`ObservableEntityList(java.lang.String entityId, EntityConnectionProvider connectionProvider)` Instantiates a new `ObservableEntityList`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFilteringListener(EventListener listener)`
`void`	`addRefreshListener(EventListener listener)`
`void`	`addSelectionChangedListener(EventListener listener)`
`protected void`	`bindSelectionModelEvents()` Binds model events to the selection model
`boolean`	`contains(Entity 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<Entity>`	`getAllItems()`
`EntityConnectionProvider`	`getConnectionProvider()`
`java.lang.String`	`getEntityId()`
`FilterCondition<Entity>`	`getFilterCondition()` Returns the filter condition defined by this model, null if no filter condition has been set.
`int`	`getFilteredItemCount()`
`java.util.List<Entity>`	`getFilteredItems()`
`javafx.collections.transformation.FilteredList<Entity>`	`getFilteredList()`
`StateObserver`	`getMultipleSelectionObserver()`
`StateObserver`	`getSelectionEmptyObserver()`
`SelectionModel<Entity>`	`getSelectionModel()`
`StateObserver`	`getSingleSelectionObserver()`
`javafx.collections.transformation.SortedList<Entity>`	`getSortedList()`
`int`	`getVisibleItemCount()`
`java.util.List<Entity>`	`getVisibleItems()`
`boolean`	`isFiltered(Entity item)` Returns true if the given item is being filtered in this model, that is, is not visible
`boolean`	`isVisible(Entity item)` Returns true if the given item is visible, that is, not filtered in this model
`protected java.util.List<Entity>`	`performQuery()`
`void`	`refresh()` Performs a refresh, reloading the relevant data
`void`	`removeFilteringListener(EventListener listener)`
`protected boolean`	`selectionModelHasBeenSet()`
`void`	`setFilterCondition(FilterCondition<Entity> filterCondition)` Sets the filter condition and filters the model
`void`	`setSelectCondition(Condition selectCondition)` Sets the condition to use when querying data
`void`	`setSelectionModel(javafx.scene.control.SelectionModel<Entity> selectionModel)` Sets the selection model to use

Methods inherited from class javafx.beans.property.SimpleListProperty
getBean, getName

Methods inherited from class javafx.beans.property.ListPropertyBase
addListener, addListener, addListener, bind, emptyProperty, fireValueChangedEvent, fireValueChangedEvent, get, invalidated, isBound, removeListener, removeListener, removeListener, set, sizeProperty, toString, unbind

Methods inherited from class javafx.beans.property.ListProperty
bindBidirectional, setValue, unbindBidirectional

Methods inherited from class javafx.beans.property.ReadOnlyListProperty
bindContent, bindContentBidirectional, equals, hashCode, unbindContent, unbindContentBidirectional

Methods inherited from class javafx.beans.binding.ListExpression
add, add, addAll, addAll, addAll, asString, clear, contains, containsAll, get, getSize, getValue, indexOf, isEmpty, isEqualTo, isNotEqualTo, isNotNull, isNull, iterator, lastIndexOf, listExpression, listIterator, listIterator, remove, remove, remove, removeAll, removeAll, retainAll, retainAll, set, setAll, setAll, size, subList, toArray, toArray, valueAt, valueAt

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javafx.collections.ObservableList
addAll, addListener, filtered, remove, removeAll, removeListener, retainAll, setAll, setAll, sorted, sorted

Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface javafx.beans.Observable
addListener, removeListener

Methods inherited from interface org.jminor.common.model.Refreshable
clear

Methods inherited from interface javafx.beans.value.ObservableValue
getValue

Methods inherited from interface javafx.beans.value.WritableValue
getValue

- Constructor Detail
  - ObservableEntityList
```
public ObservableEntityList(java.lang.String entityId,
                            EntityConnectionProvider connectionProvider)
```
    Instantiates a new ObservableEntityList
    
    Parameters:
    
    entityId - the entity on which to base the list
    
    connectionProvider - the connection provider
- Method Detail
  - getEntityId
```
public final java.lang.String getEntityId()
```
    Returns:
    
    the ID of the underlying entity
  - getConnectionProvider
```
public final EntityConnectionProvider getConnectionProvider()
```
    Returns:
    
    the connection provider
  - refresh
```
public final void refresh()
```
    Performs a refresh, reloading the relevant data
    
    Specified by:
    
    refresh in interface Refreshable
  - getFilteredList
```
public final javafx.collections.transformation.FilteredList<Entity> getFilteredList()
```
    Returns:
    
    a filtered view of this list
    
    See Also:
    
    setFilterCondition(FilterCondition)
  - getSortedList
```
public final javafx.collections.transformation.SortedList<Entity> getSortedList()
```
    Returns:
    
    a sorted view of this list
  - setSelectionModel
```
public final void setSelectionModel(javafx.scene.control.SelectionModel<Entity> selectionModel)
```
    Sets the selection model to use
    
    Parameters:
    
    selectionModel - the selection model
    
    Throws:
    
    java.lang.IllegalStateException - in case the selection model has already been set
  - addRefreshListener
```
public final void addRefreshListener(EventListener listener)
```
    Parameters:
    
    listener - a listener notified each time this model is refreshed
  - getSelectionModel
```
public final SelectionModel<Entity> getSelectionModel()
```
    Returns:
    
    the selection model
    
    Throws:
    
    java.lang.IllegalStateException - in case the selection model has not been set
  - getSelectionEmptyObserver
```
public final StateObserver getSelectionEmptyObserver()
```
    Returns:
    
    a StateObserver active when the selection is empty
    
    Throws:
    
    java.lang.IllegalStateException - in case the selection model has not been set
  - getSingleSelectionObserver
```
public final StateObserver getSingleSelectionObserver()
```
    Returns:
    
    a StateObserver active when a single item is selected
    
    Throws:
    
    java.lang.IllegalStateException - in case the selection model has not been set
  - getMultipleSelectionObserver
```
public final StateObserver getMultipleSelectionObserver()
```
    Returns:
    
    a StateObserver active when multiple items are selected
    
    Throws:
    
    java.lang.IllegalStateException - in case the selection model has not been set
  - addSelectionChangedListener
```
public final void addSelectionChangedListener(EventListener listener)
```
  - contains
```
public final boolean contains(Entity item,
                              boolean includeFiltered)
```
    Returns true if this model contains the given item, visible or filtered.
    
    Specified by:
    
    contains in interface FilteredModel<Entity>
    
    Parameters:
    
    item - the item
    
    includeFiltered - if true then the filtered items are included
    
    Returns:
    
    true if this model contains the item
  - isVisible
```
public final boolean isVisible(Entity item)
```
    Returns true if the given item is visible, that is, not filtered in this model
    
    Specified by:
    
    isVisible in interface FilteredModel<Entity>
    
    Parameters:
    
    item - the item
    
    Returns:
    
    true if the given item is visible
  - isFiltered
```
public final boolean isFiltered(Entity item)
```
    Returns true if the given item is being filtered in this model, that is, is not visible
    
    Specified by:
    
    isFiltered in interface FilteredModel<Entity>
    
    Parameters:
    
    item - the item
    
    Returns:
    
    true if the given item is filtered
  - getAllItems
```
public final java.util.List<Entity> getAllItems()
```
    Specified by:
    
    getAllItems in interface FilteredModel<Entity>
    
    Returns:
    
    all visible and filtered items in this table model
  - getFilteredItems
```
public final java.util.List<Entity> getFilteredItems()
```
    Specified by:
    
    getFilteredItems in interface FilteredModel<Entity>
    
    Returns:
    
    an unmodifiable view of the filtered items
  - getVisibleItems
```
public final java.util.List<Entity> getVisibleItems()
```
    Specified by:
    
    getVisibleItems in interface FilteredModel<Entity>
    
    Returns:
    
    an unmodifiable view of the visible items
  - getVisibleItemCount
```
public final int getVisibleItemCount()
```
    Specified by:
    
    getVisibleItemCount in interface FilteredModel<Entity>
    
    Returns:
    
    the number of currently visible items
  - getFilteredItemCount
```
public final int getFilteredItemCount()
```
    Specified by:
    
    getFilteredItemCount in interface FilteredModel<Entity>
    
    Returns:
    
    the number of currently filtered items
  - getFilterCondition
```
public final FilterCondition<Entity> getFilterCondition()
```
    Returns the filter condition defined by this model, null if no filter condition has been set.
    
    Specified by:
    
    getFilterCondition in interface FilteredModel<Entity>
    
    Returns:
    
    the filter condition
  - setFilterCondition
```
public final void setFilterCondition(FilterCondition<Entity> filterCondition)
```
    Sets the filter condition and filters the model
    
    Specified by:
    
    setFilterCondition in interface FilteredModel<Entity>
    
    Parameters:
    
    filterCondition - the FilterCondition to use, null if no filtering should be performed
  - 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<Entity>
    
    See Also:
    
    FilteredModel.getFilterCondition(), FilteredModel.setFilterCondition(FilterCondition), FilteredModel.addFilteringListener(EventListener)
  - addFilteringListener
```
public final void addFilteringListener(EventListener listener)
```
    Specified by:
    
    addFilteringListener in interface FilteredModel<Entity>
    
    Parameters:
    
    listener - a listener notified each time this model is filtered
  - removeFilteringListener
```
public final void removeFilteringListener(EventListener listener)
```
    Specified by:
    
    removeFilteringListener in interface FilteredModel<Entity>
    
    Parameters:
    
    listener - the listener to remove
  - setSelectCondition
```
public final void setSelectCondition(Condition selectCondition)
```
    Sets the condition to use when querying data
    
    Parameters:
    
    selectCondition - the select condition to use
    
    See Also:
    
    performQuery()
  - selectionModelHasBeenSet
```
protected final boolean selectionModelHasBeenSet()
```
    Returns:
    
    true if the selection model has been set
  - performQuery
```
protected java.util.List<Entity> performQuery()
```
    Returns:
    
    the entities to display in this list
  - bindSelectionModelEvents
```
protected void bindSelectionModelEvents()
```
    Binds model events to the selection model

Class ObservableEntityList

Constructor Summary

Method Summary

Methods inherited from class javafx.beans.property.SimpleListProperty

Methods inherited from class javafx.beans.property.ListPropertyBase

Methods inherited from class javafx.beans.property.ListProperty

Methods inherited from class javafx.beans.property.ReadOnlyListProperty

Methods inherited from class javafx.beans.binding.ListExpression

Methods inherited from class java.lang.Object

Methods inherited from interface javafx.collections.ObservableList

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface javafx.beans.Observable

Methods inherited from interface org.jminor.common.model.Refreshable

Methods inherited from interface javafx.beans.value.ObservableValue

Methods inherited from interface javafx.beans.value.WritableValue

Constructor Detail

ObservableEntityList

Method Detail

getEntityId

getConnectionProvider

refresh

getFilteredList

getSortedList

setSelectionModel

addRefreshListener

getSelectionModel

getSelectionEmptyObserver

getSingleSelectionObserver

getMultipleSelectionObserver

addSelectionChangedListener

contains

isVisible

isFiltered

getAllItems

getFilteredItems

getVisibleItems

getVisibleItemCount

getFilteredItemCount

getFilterCondition

setFilterCondition

filterContents

addFilteringListener

removeFilteringListener

setSelectCondition

selectionModelHasBeenSet

performQuery

bindSelectionModelEvents