Class GTreeTableModel<T extends GTreeTableNode>

java.lang.Object

javax.swing.table.AbstractTableModel

docking.widgets.table.AbstractGTableModel<T>

docking.widgets.table.AbstractSortedTableModel<T>

docking.widgets.table.GDynamicColumnTableModel<T,Object>

docking.widgets.table.threaded.ThreadedTableModel<T,Object>

docking.widgets.table.threaded.ThreadedTableModelStub<T>

docking.widgets.gtreetable.GTreeTableModel<T>

All Implemented Interfaces:

ConfigurableColumnTableModel, DynamicColumnTableModel<T>, RowObjectFilterModel<T>, RowObjectTableModel<T>, SelectionStorage<T>, SortedTableModel, VariableColumnTableModel, Serializable, EventListener, ChangeListener, TableModel

public class GTreeTableModel<T extends GTreeTableNode>
extends ThreadedTableModelStub<T>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	GTreeTableModel.TreeColumn

Nested classes/interfaces inherited from class ThreadedTableModel

ThreadedTableModel.IncrementalLoadJobListener

Field Summary

Fields inherited from class ThreadedTableModel

allData, filteredData

Fields inherited from class GDynamicColumnTableModel

columnSettings, serviceProvider, tableColumns

Fields inherited from class AbstractSortedTableModel

hasEverSorted

Fields inherited from class AbstractGTableModel

isDisposed, WIDTH_UNDEFINED

Fields inherited from class AbstractTableModel

listenerList

Fields inherited from interface RowObjectFilterModel

SUB_FILTERING_DISABLED_PROPERTY

Fields inherited from interface SortedTableModel

ASCENDING_ORDER, DESCENDING_ORDER

Constructor Summary

Constructors

Constructor	Description
GTreeTableModel(GTreeTableNode rootNode)

Method Summary

Modifier and Type	Method	Description
protected TableColumnDescriptor<T>	createTableColumnDescriptor()	Add the GTreeTableModel<T extends GTreeTableNode>.TreeColumn by default, override to add additional columns
protected List<T>	doFilter(List<T> data, TableSortingContext<T> lastSortingContext, TaskMonitor monitor)	Any rows that match the filter have all of their ancestors added to the filtered tree to ensure the tree structure remains intact
protected void	doLoad(Accumulator<T> accumulator, TaskMonitor monitor)	The basic method that all children must implement.
boolean	setRootNode(GTreeTableNode node)	Set the root node of this model
protected String	treeColumnName()	Name of the tree column, allows extending classes the ability to change the name

Methods inherited from class ThreadedTableModelStub

getDataSource

Methods inherited from class ThreadedTableModel

addInitialLoadListener, addInitialLoadListener, addObject, addThreadedTableModelListener, backgroundWorkCancelled, cancelAllUpdates, clearData, createAccumulator, createIncrementalLoadJob, createSortComparator, dispose, fireTableChanged, getAddRemoveStrategy, getAllData, getModelData, getModelIndex, getModelRow, getName, getRowCount, getRowObjects, getTableFilter, getUnfilteredData, getUnfilteredIndexForRowObject, getUnfilteredRowCount, getUnfilteredRowObjectForIndex, getValueAt, getViewIndex, getViewRow, hasFilter, initializeSorting, isBusy, isFiltered, isLoadIncrementally, reFilter, reload, removeObject, removeThreadedTableModelListener, reSort, setIncrementalTaskMonitor, setModelState, setTableFilter, sort, startInitialLoad, updateNow, updateObject

Methods inherited from class GDynamicColumnTableModel

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

Methods inherited from class AbstractSortedTableModel

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

Methods inherited from class AbstractGTableModel

getLastSelectedObjects, isDisposed, refresh, setLastSelectedObjects

Methods inherited from class AbstractTableModel

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

Methods inherited from class Object

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

Methods inherited from interface DynamicColumnTableModel

getPreferenceKey

Methods inherited from interface RowObjectTableModel

fireTableDataChanged, getColumnValueForRow, getRowIndex, getRowObject

Methods inherited from interface TableModel

addTableModelListener, getColumnClass, getColumnCount, getColumnName, isCellEditable, removeTableModelListener, setValueAt

Constructor Details

GTreeTableModel

public GTreeTableModel(GTreeTableNode rootNode)

Method Details

createTableColumnDescriptor

protected TableColumnDescriptor<T> createTableColumnDescriptor()

Add the GTreeTableModel<T extends GTreeTableNode>.TreeColumn by default, override to add additional columns

Specified by:

createTableColumnDescriptor in class GDynamicColumnTableModel<T extends GTreeTableNode, Object>

doFilter

protected List<T> doFilter(List<T> data,
 TableSortingContext<T> lastSortingContext,
 TaskMonitor monitor)
                    throws CancelledException

Any rows that match the filter have all of their ancestors added to the filtered tree to ensure the tree structure remains intact

Override this to change how filtering is performed. This implementation will do nothing if a TableFilter has not been set via a call to ThreadedTableModel.setTableFilter(TableFilter).

Overrides:

doFilter in class ThreadedTableModel<T extends GTreeTableNode, Object>

Parameters:

data - The list of data to be filtered.

lastSortingContext - the comparator used to sort data. This can be used by overridden filter methods that need to query data about how the table is sorted.

monitor - the progress monitor to check for cancellation.

Returns:

The new filtered list of data. If no filtering takes place, then the original list should be returned.

Throws:

CancelledException - If the filter operation is cancelled.

doLoad

protected void doLoad(Accumulator<T> accumulator,
 TaskMonitor monitor)
               throws CancelledException

Description copied from class: ThreadedTableModel

The basic method that all children must implement. This is where children load their data.

Specified by:

doLoad in class ThreadedTableModel<T extends GTreeTableNode, Object>

Parameters:

accumulator - the datastructure into which you should incrementally place you table row data

monitor - the task monitor to check for cancellations and to update progress

Throws:

CancelledException - if the task monitor has been cancelled and a call is made to monitor.checkCancelled();.

setRootNode

public boolean setRootNode(GTreeTableNode node)

Set the root node of this model

Parameters:

node - Root node to set

Returns:

True if node is different, false otherwise

treeColumnName

protected String treeColumnName()

Name of the tree column, allows extending classes the ability to change the name

Returns:

Tree column name