Package docking.widgets.table

Class DefaultEnumeratedColumnTableModel<C extends Enum<C> & DefaultEnumeratedColumnTableModel.EnumeratedTableColumn<C,R>,R>

java.lang.Object

javax.swing.table.AbstractTableModel

docking.widgets.table.AbstractGTableModel<R>

docking.widgets.table.AbstractSortedTableModel<R>

docking.widgets.table.GDynamicColumnTableModel<R,Void>

docking.widgets.table.DefaultEnumeratedColumnTableModel<C,R>

Type Parameters:

C - the type of the enum

R - the type of rows

All Implemented Interfaces:

ConfigurableColumnTableModel, DynamicColumnTableModel<R>, EnumeratedColumnTableModel<R>, RowObjectTableModel<R>, SelectionStorage<R>, SortedTableModel, VariableColumnTableModel, Serializable, EventListener, ChangeListener, TableModel

Direct Known Subclasses:

DefaultEnumeratedColumnProgramTableModel, RowWrappedEnumeratedColumnTableModel

public class DefaultEnumeratedColumnTableModel<C extends Enum<C> & DefaultEnumeratedColumnTableModel.EnumeratedTableColumn<C,R>,R>
extends GDynamicColumnTableModel<R,Void>
implements EnumeratedColumnTableModel<R>

A table model whose columns are described using an Enum.

See the callers to this class' constructor to find example uses.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DefaultEnumeratedColumnTableModel.EnumeratedTableColumn<C extends Enum<C>,R>	An interface on enums used to describe table columns

Nested classes/interfaces inherited from interface docking.widgets.table.EnumeratedColumnTableModel

EnumeratedColumnTableModel.EditableDynamicTableColumn<ROW_TYPE,COLUMN_TYPE,DATA_SOURCE>

Field Summary

Fields inherited from class docking.widgets.table.GDynamicColumnTableModel

columnSettings, serviceProvider, tableColumns

Fields inherited from class docking.widgets.table.AbstractSortedTableModel

hasEverSorted

Fields inherited from class docking.widgets.table.AbstractGTableModel

isDisposed, WIDTH_UNDEFINED

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Fields inherited from interface docking.widgets.table.SortedTableModel

ASCENDING_ORDER, DESCENDING_ORDER

Constructor Summary

Constructors

Constructor	Description
DefaultEnumeratedColumnTableModel(PluginTool tool, String name, Class<C> colType)

Method Summary

Modifier and Type	Method	Description
void	add(R row)
void	addAll(Collection<R> c)
void	clear()
List<R>	copyModelData()
protected TableColumnDescriptor<R>	createTableColumnDescriptor()
List<C>	defaultSortOrder()	Get the default sort order of the table
void	delete(R row)
List<R>	deleteWith(Predicate<R> predicate)
R	findFirst(Predicate<R> predicate)
Void	getDataSource()	Returns the table's context for the data.
List<R>	getModelData()	Implementors should return the current data of the model.
String	getName()	Returns the name of this model
boolean	isCellEditable(int rowIndex, int columnIndex)
void	notifyUpdated(R row)
List<R>	notifyUpdatedWith(Predicate<R> predicate)
void	setValueAt(Object aValue, int rowIndex, int columnIndex)
protected void	sort(List<R> data, TableSortingContext<R> sortingContext)	A default sort method that uses the Collections.sort(List, Comparator) method for sorting.

Methods inherited from class docking.widgets.table.GDynamicColumnTableModel

addTableColumn, addTableColumn, addTableColumns, addTableColumns, createSortComparator, createSortComparatorForColumn, dispose, disposeDynamicColumnData, getColumn, getColumnClass, getColumnCount, getColumnDescription, getColumnDisplayName, getColumnIndex, getColumnIndex, getColumnName, getColumnSettings, getColumnSettingsDefinitions, getColumnValueForRow, getDefaultColumnCount, getHeaderRenderer, getMaxLines, getPreferredColumnWidth, getRenderer, getTableColumnDescriptor, getUniqueIdentifier, isDefaultColumn, isSortable, isVisibleByDefault, loadDiscoveredTableColumns, reloadColumns, removeTableColumn, removeTableColumns, setAllColumnSettings, stateChanged

Methods inherited from class docking.widgets.table.AbstractSortedTableModel

addSortListener, cleanupTableSortState, createSortingContext, fireTableChanged, getIndexForRowObject, getIndexForRowObject, getPendingSortState, getPrimarySortColumnIndex, getRowIndex, getRowObject, getTableSortState, getValueAt, initializeSorting, isSorted, isSortPending, notifyModelSorted, reSort, setDefaultTableSortState, setTableSortState, sortCompleted

Methods inherited from class docking.widgets.table.AbstractGTableModel

getLastSelectedObjects, getRowCount, isDisposed, refresh, setLastSelectedObjects

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getListeners, getTableModelListeners, removeTableModelListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface docking.widgets.table.RowObjectTableModel

fireTableDataChanged, getColumnValueForRow, getRowIndex, getRowObject

Methods inherited from interface javax.swing.table.TableModel

addTableModelListener, getColumnClass, getColumnCount, getColumnName, getRowCount, getValueAt, removeTableModelListener

Constructor Details

DefaultEnumeratedColumnTableModel

public DefaultEnumeratedColumnTableModel(PluginTool tool,
 String name,
 Class<C> colType)

Method Details

getName

public String getName()

Description copied from interface: RowObjectTableModel

Returns the name of this model

Specified by:

getName in interface RowObjectTableModel<C extends Enum<C> & DefaultEnumeratedColumnTableModel.EnumeratedTableColumn<C,R>>

Returns:

the name of this model

getModelData

public List<R> getModelData()

Description copied from interface: RowObjectTableModel

Implementors should return the current data of the model. For models that support filtering, this will be the filtered version of the data. Furthermore, the data should be the underlying data and not a copy, as this method will potentially sort the given data.

For those subclasses using an array, you may use the Arrays class to create a list backed by the array (Arrays.asList(Object...)).

Specified by:

getModelData in interface RowObjectTableModel<C extends Enum<C> & DefaultEnumeratedColumnTableModel.EnumeratedTableColumn<C,R>>

Returns:

the model data.

copyModelData

public List<R> copyModelData()

createTableColumnDescriptor

protected TableColumnDescriptor<R> createTableColumnDescriptor()

Specified by:

createTableColumnDescriptor in class GDynamicColumnTableModel<R,Void>

getDataSource

public Void getDataSource()

Description copied from class: GDynamicColumnTableModel

Returns the table's context for the data.

Specified by:

getDataSource in class GDynamicColumnTableModel<R,Void>

Returns:

the table's context for the data.

defaultSortOrder

public List<C> defaultSortOrder()

Get the default sort order of the table

Returns:

the list of columns in order of descending priority

setValueAt

public void setValueAt(Object aValue,
 int rowIndex,
 int columnIndex)

Specified by:

setValueAt in interface TableModel

Overrides:

setValueAt in class AbstractTableModel

isCellEditable

public boolean isCellEditable(int rowIndex,
 int columnIndex)

Specified by:

isCellEditable in interface TableModel

Overrides:

isCellEditable in class AbstractTableModel

add

public void add(R row)

Specified by:

add in interface EnumeratedColumnTableModel<C extends Enum<C> & DefaultEnumeratedColumnTableModel.EnumeratedTableColumn<C,R>>

addAll

public void addAll(Collection<R> c)

Specified by:

addAll in interface EnumeratedColumnTableModel<C extends Enum<C> & DefaultEnumeratedColumnTableModel.EnumeratedTableColumn<C,R>>

notifyUpdated

public void notifyUpdated(R row)

Specified by:

notifyUpdated in interface EnumeratedColumnTableModel<C extends Enum<C> & DefaultEnumeratedColumnTableModel.EnumeratedTableColumn<C,R>>

notifyUpdatedWith

public List<R> notifyUpdatedWith(Predicate<R> predicate)

Specified by:

notifyUpdatedWith in interface EnumeratedColumnTableModel<C extends Enum<C> & DefaultEnumeratedColumnTableModel.EnumeratedTableColumn<C,R>>

delete

public void delete(R row)

Specified by:

delete in interface EnumeratedColumnTableModel<C extends Enum<C> & DefaultEnumeratedColumnTableModel.EnumeratedTableColumn<C,R>>

deleteWith

public List<R> deleteWith(Predicate<R> predicate)

Specified by:

deleteWith in interface EnumeratedColumnTableModel<C extends Enum<C> & DefaultEnumeratedColumnTableModel.EnumeratedTableColumn<C,R>>

findFirst

public R findFirst(Predicate<R> predicate)

Specified by:

findFirst in interface EnumeratedColumnTableModel<C extends Enum<C> & DefaultEnumeratedColumnTableModel.EnumeratedTableColumn<C,R>>

clear

public void clear()

Specified by:

clear in interface EnumeratedColumnTableModel<C extends Enum<C> & DefaultEnumeratedColumnTableModel.EnumeratedTableColumn<C,R>>

sort

protected void sort(List<R> data,
 TableSortingContext<R> sortingContext)

Description copied from class: AbstractSortedTableModel

A default sort method that uses the Collections.sort(List, Comparator) method for sorting. Implementors with reasonably sized data sets can rely on this method. For data sets that can become large, the ThreadedTableModel is the recommended base class, as it handles loading/sorting/filtering in a threaded way.

Overrides:

sort in class AbstractSortedTableModel<R>

Parameters:

data - The data to be sorted

sortingContext - The context required to sort (it contains the sorting columns, a comparator for sorting, etc...).