Module org.autogui

Package org.autogui.swing.table

Class ObjectTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

org.autogui.swing.table.ObjectTableModel

All Implemented Interfaces:

Serializable, TableModel, ObjectTableModelColumns.ObjectTableModelColumnsListener

Direct Known Subclasses:

GuiSwingTableModelCollection

public class ObjectTableModel
extends AbstractTableModel
implements ObjectTableModelColumns.ObjectTableModelColumnsListener

a table-model based on a list of row objects

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ObjectTableModel.BuildResult	the return value of buildDataArray(Runnable)
static class	ObjectTableModel.CollectionRowsAndCellsActionBuilder	a builder accepting a TableTargetCellAction and wrapping it to a ObjectTableModel.TableTargetCellExecutionAction.
static class	ObjectTableModel.MenuBuilderForRowsOrCells	a menu builder without adding titles
static class	ObjectTableModel.MenuBuilderWithEmptySeparator	a menu builder with empty separators
static class	ObjectTableModel.ObjectTableColumnSizeAndSelection	refreshColumns() seems to clear column selection between the first size-obtaining step and the after-step.
static class	ObjectTableModel.PopupCategorizedForRowsOrCells	a menu builder for table items
static interface	ObjectTableModel.PopupMenuBuilderForRowsOrCells	a menu builder for TableTargetCellActions
static class	ObjectTableModel.TableTargetCellExecutionAction	an action for wrapping TableTargetCellAction

Field Summary

Fields

Modifier and Type	Field	Description
protected ObjectTableModelColumns	columns
protected Object[][]	data	cached computed values
protected Consumer<Runnable>	futureWaiter
static Object	NULL_CELL
protected GuiSwingTaskRunner	runner
protected Supplier<Object>	source
protected JTable	table

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor	Description
ObjectTableModel()
ObjectTableModel(GuiSwingTaskRunner runner)

Method Summary

Modifier and Type	Method	Description
ObjectTableModel.BuildResult	buildDataArray(Runnable delayedAfterInEvent)
void	clearRowData(int rowIndex)
void	columnAdded(ObjectTableColumn column)
void	columnViewUpdate(ObjectTableColumn column)
<RetType> GuiSwingTaskRunner.ContextTaskResult<RetType>	executeContextTask(Supplier<RetType> task, Consumer<GuiSwingTaskRunner.ContextTaskResult<RetType>> afterTask)
<RetType> GuiSwingTaskRunner.ContextTaskResult<RetType>	executeContextTask(ObjectTableColumn column, Supplier<RetType> task, Consumer<GuiSwingTaskRunner.ContextTaskResult<RetType>> afterTask)
void	fireTableRowsUpdatedAll()	update existing rows without changing selection
PopupExtension.PopupMenuBuilder	getBuilderForRowsOrCells(JTable table, List<ObjectTableColumn> cols, boolean row)
List<PopupCategorized.CategorizedMenuItem>	getBuildersForRowsOrCells(JTable table, List<ObjectTableColumn> cols, boolean row)
Object	getCollectionFromSource()
ObjectTableColumn	getColumnAt(int index)
Class<?>	getColumnClass(int columnIndex)
int	getColumnCount()
DefaultTableColumnModel	getColumnModel()
String	getColumnName(int column)
ObjectTableModelColumns	getColumns()
Consumer<Runnable>	getFutureWaiter()
Object	getRowAtIndex(int row)
int	getRowCount()
int	getRowCountUpdated()
JTable	getTable()
Object	getValueAt(int rowIndex, int columnIndex)
Object	getValueAtWithError(int rowIndex, int columnIndex)	executed under the event thread.
void	initColumns()
JScrollPane	initTable(JTable table)
void	initTableRowHeight(JTable table)
void	initTableRowSorter(JTable table)
JScrollPane	initTableScrollPane(JComponent table)
void	initTableWithoutScrollPane(JTable table)
JScrollPane	initTableWithScroll()
protected void	invokeLater(Runnable task)	running the task in the event thread
boolean	isCellEditable(int rowIndex, int columnIndex)
void	offerValueForSource(Object aValue, int rowIndex, int columnIndex)
void	offsetValueForSourceFuture(Object rowObject, Object aValue, int rowIndex, int columnIndex, Future<?> future)
void	refreshColumns()
void	refreshColumns(int... columnIndices)	executed under event thread
void	refreshColumns(Collection<Integer> columnIndices)	executed under event thread
void	refreshData()	executed under event thread
void	refreshRow(int rowIndex)	executed under event thread
void	refreshRows(int... rowIndices)	executed under event thread
void	setFutureWaiter(Consumer<Runnable> futureWaiter)
void	setSource(Supplier<Object> source)
void	setTable(JTable table)
void	setValueAt(Object aValue, int rowIndex, int columnIndex)
void	setValueAtWithError(Object aValue, int rowIndex, int columnIndex)	executed under event thread.
Object	takeValueFromSource(Object[] rowData, int rowIndex, int columnIndex)	the column's ObjectTableColumn.getCellValue(Object, int, int, GuiReprValue.ObjectSpecifier) might return a Future object, and then it waits completion of the task in takeValueFromSourceFuture(Object[], int, int, Future).
void	takeValueFromSourceFuture(Object[] rowData, int rowIndex, int columnIndex, Future<?> future)	wait the completion of a task up to 1 sec.
Object	taskValueFromSourceAfter(Object[] rowData, int rowIndex, int columnIndex, Object cellObject)

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, 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

Field Details

table

protected JTable table

source

protected Supplier<Object> source

columns

protected ObjectTableModelColumns columns

data

protected Object[][] data

cached computed values

futureWaiter

protected Consumer<Runnable> futureWaiter

runner

protected GuiSwingTaskRunner runner

NULL_CELL

public static Object NULL_CELL

Constructor Details

ObjectTableModel

public ObjectTableModel()

ObjectTableModel

public ObjectTableModel(GuiSwingTaskRunner runner)

Method Details

initColumns

public void initColumns()

setFutureWaiter

public void setFutureWaiter(Consumer<Runnable> futureWaiter)

getFutureWaiter

public Consumer<Runnable> getFutureWaiter()

setTable

public void setTable(JTable table)

getTable

public JTable getTable()

getColumnName

public String getColumnName(int column)

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractTableModel

getColumnModel

public DefaultTableColumnModel getColumnModel()

getColumnAt

public ObjectTableColumn getColumnAt(int index)

getColumnClass

public Class<?> getColumnClass(int columnIndex)

Specified by:

getColumnClass in interface TableModel

Overrides:

getColumnClass in class AbstractTableModel

getColumns

public ObjectTableModelColumns getColumns()

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface TableModel

refreshColumns

public void refreshColumns()

initTableWithScroll

public JScrollPane initTableWithScroll()

initTable

public JScrollPane initTable(JTable table)

initTableWithoutScrollPane

public void initTableWithoutScrollPane(JTable table)

initTableRowSorter

public void initTableRowSorter(JTable table)

initTableRowHeight

public void initTableRowHeight(JTable table)

initTableScrollPane

public JScrollPane initTableScrollPane(JComponent table)

executeContextTask

public <RetType>
GuiSwingTaskRunner.ContextTaskResult<RetType> executeContextTask(Supplier<RetType> task,
 Consumer<GuiSwingTaskRunner.ContextTaskResult<RetType>> afterTask)

executeContextTask

public <RetType>
GuiSwingTaskRunner.ContextTaskResult<RetType> executeContextTask(ObjectTableColumn column,
 Supplier<RetType> task,
 Consumer<GuiSwingTaskRunner.ContextTaskResult<RetType>> afterTask)

Type Parameters:

RetType - the task result type

Parameters:

column - the column related to the task

task - executed task

afterTask - the second task. nullable

Returns:

result of the task

Since:

1.6

setSource

public void setSource(Supplier<Object> source)

getCollectionFromSource

public Object getCollectionFromSource()

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface TableModel

getRowCountUpdated

public int getRowCountUpdated()

getRowAtIndex

public Object getRowAtIndex(int row)

buildDataArray

public ObjectTableModel.BuildResult buildDataArray(Runnable delayedAfterInEvent)

getValueAt

public Object getValueAt(int rowIndex,
 int columnIndex)

Specified by:

getValueAt in interface TableModel

getValueAtWithError

public Object getValueAtWithError(int rowIndex,
 int columnIndex)

executed under the event thread.

the cell value is obtained via the specified ObjectTableColumn with the specified row of getCollectionFromSource(). the cell value is cached and obtained by takeValueFromSource(Object[], int, int) at the first time.

Parameters:

rowIndex - the target row

columnIndex - the target column

Returns:

the cell value, nullable (waiting for obtaining the value)

takeValueFromSource

public Object takeValueFromSource(Object[] rowData,
 int rowIndex,
 int columnIndex)

the column's ObjectTableColumn.getCellValue(Object, int, int, GuiReprValue.ObjectSpecifier) might return a Future object, and then it waits completion of the task in takeValueFromSourceFuture(Object[], int, int, Future). The method is run in getFutureWaiter() (default is just call the method)

Parameters:

rowData - the row array which the returned cell value will be stored

rowIndex - the row index

columnIndex - the column index

Returns:

the cell value, nullable

taskValueFromSourceAfter

public Object taskValueFromSourceAfter(Object[] rowData,
 int rowIndex,
 int columnIndex,
 Object cellObject)

takeValueFromSourceFuture

public void takeValueFromSourceFuture(Object[] rowData,
 int rowIndex,
 int columnIndex,
 Future<?> future)

wait the completion of a task up to 1 sec. , store the result to the array, and notify the update (as a later event process). If it overs the time, it just throws a runtime-exception.

Parameters:

rowData - the stored array

rowIndex - the row index

columnIndex - the column index

future - the task

setValueAt

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

Specified by:

setValueAt in interface TableModel

Overrides:

setValueAt in class AbstractTableModel

setValueAtWithError

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

executed under event thread.

Parameters:

aValue - the column value to be set

rowIndex - the target row

columnIndex - the target column

offerValueForSource

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

offsetValueForSourceFuture

public void offsetValueForSourceFuture(Object rowObject,
 Object aValue,
 int rowIndex,
 int columnIndex,
 Future<?> future)

refreshData

public void refreshData()

executed under event thread

refreshRow

public void refreshRow(int rowIndex)

executed under event thread

Parameters:

rowIndex - the target row index

clearRowData

public void clearRowData(int rowIndex)

refreshRows

public void refreshRows(int... rowIndices)

executed under event thread

Parameters:

rowIndices - the target rows

refreshColumns

public void refreshColumns(Collection<Integer> columnIndices)

executed under event thread

Parameters:

columnIndices - the target columns

refreshColumns

public void refreshColumns(int... columnIndices)

executed under event thread

Parameters:

columnIndices - the target columns

columnAdded

public void columnAdded(ObjectTableColumn column)

Specified by:

columnAdded in interface ObjectTableModelColumns.ObjectTableModelColumnsListener

columnViewUpdate

public void columnViewUpdate(ObjectTableColumn column)

Specified by:

columnViewUpdate in interface ObjectTableModelColumns.ObjectTableModelColumnsListener

fireTableRowsUpdatedAll

public void fireTableRowsUpdatedAll()

update existing rows without changing selection

invokeLater

protected void invokeLater(Runnable task)

running the task in the event thread

Parameters:

task - the task

isCellEditable

public boolean isCellEditable(int rowIndex,
 int columnIndex)

Specified by:

isCellEditable in interface TableModel

Overrides:

isCellEditable in class AbstractTableModel

getBuilderForRowsOrCells

public PopupExtension.PopupMenuBuilder getBuilderForRowsOrCells(JTable table,
 List<ObjectTableColumn> cols,
 boolean row)

getBuildersForRowsOrCells

public List<PopupCategorized.CategorizedMenuItem> getBuildersForRowsOrCells(JTable table,
 List<ObjectTableColumn> cols,
 boolean row)