Module org.autogui

Package org.autogui.swing.table

Class ObjectTableColumn

java.lang.Object

org.autogui.swing.table.ObjectTableColumn

Direct Known Subclasses:

GuiSwingTableColumnCollection.ObjectTableColumnCollectionWrapper, ObjectTableColumn.ObjectTableColumnLabel, ObjectTableColumn.ObjectTableColumnRowIndex, ObjectTableColumnValue

public class ObjectTableColumn
extends Object

a table-column with additional info.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectTableColumn.NumberRenderer	a renderer for index numbers
static class	ObjectTableColumn.ObjectTableColumnLabel<ObjType,PropType>	a column class for specifying operations with lambdas.
static class	ObjectTableColumn.ObjectTableColumnRowIndex	a top-column displaying a row-index number
static interface	ObjectTableColumn.PopupMenuBuilderSource	a menu-builder holder
static interface	ObjectTableColumn.PopupMenuBuilderSourceForHeader	a static menu-factory for the column header view; as the default, the cell-renderer and the cell-editor that implements it is used
static interface	ObjectTableColumn.TableMenuComposite	menu items which the column can process
static interface	ObjectTableColumn.TableMenuCompositeShared	a shared key for a menu composite
static class	ObjectTableColumn.TableTargetColumnForObjectColumn	supporting value conversion like Path to File

Field Summary

Fields

Modifier and Type	Field	Description
protected Comparator<?>	comparator
protected int	rowHeight
protected TableColumn	tableColumn
protected Class<?>	valueType

Constructor Summary

Constructors

Constructor	Description
ObjectTableColumn()

Method Summary

Modifier and Type	Method	Description
int[]	columnIndexToValueIndex(int columnIndex)
static <O, P> ObjectTableColumn.ObjectTableColumnLabel<O,P>	createLabel(String headerName, Function<O,P> getter)
static <O, P> ObjectTableColumn.ObjectTableColumnLabel<O,P>	createLabel(String headerName, Function<O,P> getter, BiConsumer<O,P> setter)
Object	fromActionValue(Object value)
Object	getCellValue(Object rowObject, int rowIndex, int columnIndex, GuiReprValue.ObjectSpecifier specifier)
Object	getCellValueFromContext(int rowIndex, int columnIndex, GuiReprValue.ObjectSpecifier specifier)
Comparator<?>	getComparator()
List<ObjectTableColumn.TableMenuComposite>	getCompositesForCells()
List<ObjectTableColumn.TableMenuComposite>	getCompositesForRows()
List<PopupCategorized.CategorizedMenuItem>	getHeaderMenuItems(JTable table)
List<PopupCategorized.CategorizedMenuItem>	getHeaderMenuItemsInfo()
ObjectTableColumn.PopupMenuBuilderSource	getMenuBuilderSource()	Note: the actions added by the builder will only work with single (last) value of the renderer, set by GuiSwingView.ValuePane.setSwingViewValue(Object).
int	getRowHeight()
GuiReprValue.ObjectSpecifier	getSpecifier(int rowIndex, int columnIndex)
TableColumn	getTableColumn()
Class<?>	getValueType()
boolean	isTaskRunnerUsedFor(Supplier<?> task)	determines the task can be submitted to the task runner
static void	setCellBorder(JTable table, JComponent cell, int row, int column)
Future<?>	setCellValue(Object rowObject, int rowIndex, int columnIndex, Object newColumnValue, GuiReprValue.ObjectSpecifier specifier)
Future<?>	setCellValueFromContext(int rowIndex, int columnIndex, Object newColumnValue, GuiReprValue.ObjectSpecifier specifier)
void	setColumnViewUpdater(Consumer<ObjectTableColumn> updater)
void	setComparator(Comparator<?> comparator)
void	setRowHeight(int rowHeight)
void	setTableColumn(TableColumn tableColumn)
void	setValueType(Class<?> valueType)
void	shutdown()
Object	toActionValue(Object value)
void	viewUpdateAsDynamic(ObjectTableColumn source)
ObjectTableColumn	withCellEditor(TableCellEditor cellEditor)
ObjectTableColumn	withCellRenderer(TableCellRenderer cellRenderer)
ObjectTableColumn	withComparator(Comparator<?> comparator)
ObjectTableColumn	withHeaderRenderer(TableCellRenderer headerRenderer)
ObjectTableColumn	withHeaderValue(Object headerValue)
ObjectTableColumn	withIdentifier(Object identifier)
ObjectTableColumn	withMaxWidth(int maxWidth)
ObjectTableColumn	withMinWidth(int minWidth)
ObjectTableColumn	withPreferredWidth(int preferredWidth)
ObjectTableColumn	withResizable(boolean isResizable)
ObjectTableColumn	withRowHeight(int rowHeight)
ObjectTableColumn	withTableColumn(TableColumn column)
ObjectTableColumn	withValueType(Class<?> valueType)

Methods inherited from class java.lang.Object

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

Field Details

tableColumn

protected TableColumn tableColumn

rowHeight

protected int rowHeight

comparator

protected Comparator<?> comparator

valueType

protected Class<?> valueType

Constructor Details

ObjectTableColumn

public ObjectTableColumn()

Method Details

getTableColumn

public TableColumn getTableColumn()

setTableColumn

public void setTableColumn(TableColumn tableColumn)

getRowHeight

public int getRowHeight()

setRowHeight

public void setRowHeight(int rowHeight)

getComparator

public Comparator<?> getComparator()

setComparator

public void setComparator(Comparator<?> comparator)

shutdown

public void shutdown()

getValueType

public Class<?> getValueType()

setValueType

public void setValueType(Class<?> valueType)

setColumnViewUpdater

public void setColumnViewUpdater(Consumer<ObjectTableColumn> updater)

viewUpdateAsDynamic

public void viewUpdateAsDynamic(ObjectTableColumn source)

getSpecifier

public GuiReprValue.ObjectSpecifier getSpecifier(int rowIndex,
 int columnIndex)

getCellValue

public Object getCellValue(Object rowObject,
 int rowIndex,
 int columnIndex,
 GuiReprValue.ObjectSpecifier specifier)

Parameters:

rowObject - the row object at rowIndex

rowIndex - the row index

columnIndex - the column index

specifier - specifier from getSpecifier(int, int)

Returns:

the value at columnIndex of rowObject. it might be Future, and then the value will be specially treated as getting the value of the future as the cell value.

setCellValue

public Future<?> setCellValue(Object rowObject,
 int rowIndex,
 int columnIndex,
 Object newColumnValue,
 GuiReprValue.ObjectSpecifier specifier)

Parameters:

rowObject - the row object at rowIndex

rowIndex - the row index

columnIndex - the column index

newColumnValue - the new value to be set

specifier - specifier from getSpecifier(int, int)

Returns:

a future object for checking completion of the updating or null

getCellValueFromContext

public Object getCellValueFromContext(int rowIndex,
 int columnIndex,
 GuiReprValue.ObjectSpecifier specifier)

setCellValueFromContext

public Future<?> setCellValueFromContext(int rowIndex,
 int columnIndex,
 Object newColumnValue,
 GuiReprValue.ObjectSpecifier specifier)

columnIndexToValueIndex

public int[] columnIndexToValueIndex(int columnIndex)

toActionValue

public Object toActionValue(Object value)

Parameters:

value - an element value obtained from GuiReprCollectionTable.TableTarget

Returns:

a value which an action can accept

Since:

1.1

fromActionValue

public Object fromActionValue(Object value)

Parameters:

value - an element value

Returns:

a value supplied to a setter of GuiReprCollectionTable.TableTarget

Since:

1.1

isTaskRunnerUsedFor

public boolean isTaskRunnerUsedFor(Supplier<?> task)

determines the task can be submitted to the task runner

Parameters:

task - the task to be invoked

Returns:

true if the task can be submitted to the task runner

Since:

1.6

withValueType

public ObjectTableColumn withValueType(Class<?> valueType)

withTableColumn

public ObjectTableColumn withTableColumn(TableColumn column)

withRowHeight

public ObjectTableColumn withRowHeight(int rowHeight)

withComparator

public ObjectTableColumn withComparator(Comparator<?> comparator)

withIdentifier

public ObjectTableColumn withIdentifier(Object identifier)

withHeaderValue

public ObjectTableColumn withHeaderValue(Object headerValue)

withHeaderRenderer

public ObjectTableColumn withHeaderRenderer(TableCellRenderer headerRenderer)

withCellRenderer

public ObjectTableColumn withCellRenderer(TableCellRenderer cellRenderer)

withCellEditor

public ObjectTableColumn withCellEditor(TableCellEditor cellEditor)

withPreferredWidth

public ObjectTableColumn withPreferredWidth(int preferredWidth)

withMinWidth

public ObjectTableColumn withMinWidth(int minWidth)

withMaxWidth

public ObjectTableColumn withMaxWidth(int maxWidth)

withResizable

public ObjectTableColumn withResizable(boolean isResizable)

getMenuBuilderSource

public ObjectTableColumn.PopupMenuBuilderSource getMenuBuilderSource()

Note: the actions added by the builder will only work with single (last) value of the renderer, set by GuiSwingView.ValuePane.setSwingViewValue(Object). So when the action is invoked, it will need to iterate over the selected rows, set the target value and invoke the action for each row. After each action invoked, it might need to check the value.

Returns:

TableColumn.getCellRenderer() if the renderer is an ObjectTableColumn.PopupMenuBuilderSource itself.

getHeaderMenuItems

public List<PopupCategorized.CategorizedMenuItem> getHeaderMenuItems(JTable table)

Returns:

list of static menu-items for the column header: compound list of both the renderer and the editor

Since:

1.8

getHeaderMenuItemsInfo

public List<PopupCategorized.CategorizedMenuItem> getHeaderMenuItemsInfo()

Returns:

the label info string: the default value is string of TableColumn.getHeaderValue()

Since:

1.8

getCompositesForRows

public List<ObjectTableColumn.TableMenuComposite> getCompositesForRows()

getCompositesForCells

public List<ObjectTableColumn.TableMenuComposite> getCompositesForCells()

setCellBorder

public static void setCellBorder(JTable table,
 JComponent cell,
 int row,
 int column)

createLabel

public static <O,
P>
ObjectTableColumn.ObjectTableColumnLabel<O,P> createLabel(String headerName,
 Function<O,P> getter)

createLabel

public static <O,
P>
ObjectTableColumn.ObjectTableColumnLabel<O,P> createLabel(String headerName,
 Function<O,P> getter,
 BiConsumer<O,P> setter)