Module org.autogui

Package org.autogui.swing.table

Class ObjectTableColumnValue

java.lang.Object

org.autogui.swing.table.ObjectTableColumn

org.autogui.swing.table.ObjectTableColumnValue

All Implemented Interfaces:

GuiSwingView.SettingsWindowClient, GuiSwingPrefsSupports.PreferencesUpdateSupport, GuiSwingTableColumn.ObjectTableColumnWithContext

public class ObjectTableColumnValue
extends ObjectTableColumn
implements GuiSwingTableColumn.ObjectTableColumnWithContext

a table-column with GuiMappingContext.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectTableColumnValue.ActionDelegate<TargetActionType extends Action>	a base class for wrapping an action
static enum	ObjectTableColumnValue.CellBorderType	indicating whether the editor needs a specific margin border
static interface	ObjectTableColumnValue.CellEditorListenerWithStart
static class	ObjectTableColumnValue.CollectionRowsActionBuilder	a menu filter for converting an action to another action which supports a selected rows.
static class	ObjectTableColumnValue.ColumnSelectionAction	an action for selecting cells of a target column and all rows
static interface	ObjectTableColumnValue.ColumnViewUpdateSource	an updater holder for renderer component: the component of ObjectTableColumnValue.ObjectTableCellRenderer may implement the interface.
static interface	ObjectTableColumnValue.ColumnViewUpdateTarget	an updating target for renderer component: the component of ObjectTableColumnValue.ObjectTableCellRenderer may implement the interface.
static class	ObjectTableColumnValue.KeyHandlerFinishEditing	a handler for finishing editor by alt+enter
static class	ObjectTableColumnValue.ObjectTableCellEditor	a cell-editor with GuiSwingView.ValuePane
static class	ObjectTableColumnValue.ObjectTableCellRenderer	a cell renderer with GuiSwingView.ValuePane
static class	ObjectTableColumnValue.ObjectTableColumnActionBuilder	a popup-menu builder returned by ObjectTableColumnValue.ObjectTableCellRenderer for wrapping an original menu-builder (not intended for a table) with ObjectTableModel.CollectionRowsAndCellsActionBuilder.
static interface	ObjectTableColumnValue.ObjectTableColumnCellView	interface for renderer and editor, in order to set up some properties like preferences and setting-windows
static class	ObjectTableColumnValue.TableRowsRepeatAction	an action for wrapping another action.
static class	ObjectTableColumnValue.TableTargetExecutionAction	a wrapper class for TableTargetColumnAction
static class	ObjectTableColumnValue.TableTargetInvocationAction	an action for selected rows of a column with a lambda

Nested classes/interfaces inherited from class org.autogui.swing.table.ObjectTableColumn

ObjectTableColumn.NumberRenderer, ObjectTableColumn.ObjectTableColumnLabel<ObjType,PropType>, ObjectTableColumn.ObjectTableColumnRowIndex, ObjectTableColumn.PopupMenuBuilderSource, ObjectTableColumn.TableMenuComposite, ObjectTableColumn.TableMenuCompositeShared, ObjectTableColumn.TableTargetColumnForObjectColumn

Field Summary

Fields

Modifier and Type	Field	Description
protected GuiMappingContext	context
protected int	contextIndex
protected TableCellEditor	editor
protected boolean	editorForColumnAlwaysApplying
protected TableCellRenderer	renderer
protected GuiSwingTableColumn.SpecifierManagerIndex	specifierIndex
protected GuiSwingView.SpecifierManager	specifierManager

Fields inherited from class org.autogui.swing.table.ObjectTableColumn

comparator, rowHeight, tableColumn, valueType

Constructor Summary

Constructors

Constructor	Description
ObjectTableColumnValue(GuiMappingContext context, GuiSwingTableColumn.SpecifierManagerIndex specifierIndex, GuiSwingView.SpecifierManager specifierManager, JComponent view)	the representation of the context must be a subtype of GuiReprValue.
ObjectTableColumnValue(GuiMappingContext context, GuiSwingTableColumn.SpecifierManagerIndex specifierIndex, GuiSwingView.SpecifierManager specifierManager, JComponent view, JComponent editorView)
ObjectTableColumnValue(GuiMappingContext context, GuiSwingTableColumn.SpecifierManagerIndex specifierIndex, GuiSwingView.SpecifierManager specifierManager, TableCellRenderer renderer, TableCellEditor editor)

Method Summary

Modifier and Type	Method	Description
protected TableCellEditor	editorForColumn()
Object	fromActionValue(Object value)
Object	getCellValue(Object rowObject, int rowIndex, int columnIndex, GuiReprValue.ObjectSpecifier specifier)
Object	getCellValueFromContext(int rowIndex, int columnIndex, GuiReprValue.ObjectSpecifier specifier)
List<ObjectTableColumn.TableMenuComposite>	getCompositesForCells()
List<ObjectTableColumn.TableMenuComposite>	getCompositesForRows()
GuiMappingContext	getContext()
int	getContextIndex()
SettingsWindow	getSettingsWindow()
GuiReprValue.ObjectSpecifier	getSpecifier(int rowIndex, int columnIndex)
GuiSwingView.SpecifierManager	getSpecifierManager()
static Border	getTableFocusBorder()
boolean	isTaskRunnerUsedFor(Supplier<?> task)	determines the task can be submitted to the task runner
void	loadSwingPreferences(GuiPreferences prefs, GuiSwingPrefsApplyOptions options)
void	saveSwingPreferences(GuiPreferences prefs)
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)
static <CompType> void	setForComponents(Class<CompType> componentType, Consumer<CompType> setter, Object... views)
void	setPreferencesUpdater(Consumer<GuiSwingPrefsSupports.PreferencesUpdateEvent> updater)
void	setSettingsWindow(SettingsWindow settingWindow)	at initialization of the root-pane, the method will be called for existing sub-panes.
static void	setTableColor(JTable table, JComponent component, boolean isSelected)
static void	setTableColor(JTable table, JComponent component, boolean isSelected, boolean hasFocus, int row, int column)
void	shutdown()
Object	toActionValue(Object value)
void	viewUpdateAsDynamic(ObjectTableColumn source)
ObjectTableColumnValue	withBorderType(ObjectTableColumnValue.CellBorderType type)	specify the margin border when the editor is a ObjectTableColumnValue.ObjectTableCellEditor.
ObjectTableColumnValue	withEditorForColumnAlwaysApplying(boolean alwaysApplying)	if the parameter to be true, it updates the editor of tableColumn

Methods inherited from class org.autogui.swing.table.ObjectTableColumn

columnIndexToValueIndex, createLabel, createLabel, getComparator, getMenuBuilderSource, getRowHeight, getTableColumn, getValueType, setCellBorder, setComparator, setRowHeight, setTableColumn, setValueType, withCellEditor, withCellRenderer, withComparator, withHeaderRenderer, withHeaderValue, withIdentifier, withMaxWidth, withMinWidth, withPreferredWidth, withResizable, withRowHeight, withTableColumn, withValueType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.autogui.swing.table.GuiSwingTableColumn.ObjectTableColumnWithContext

asColumn, loadSwingPreferences

Field Details

context

protected GuiMappingContext context

specifierIndex

protected GuiSwingTableColumn.SpecifierManagerIndex specifierIndex

specifierManager

protected GuiSwingView.SpecifierManager specifierManager

contextIndex

protected int contextIndex

renderer

protected TableCellRenderer renderer

editor

protected TableCellEditor editor

editorForColumnAlwaysApplying

protected boolean editorForColumnAlwaysApplying

Since:

1.6

Constructor Details

ObjectTableColumnValue

public ObjectTableColumnValue(GuiMappingContext context,
 GuiSwingTableColumn.SpecifierManagerIndex specifierIndex,
 GuiSwingView.SpecifierManager specifierManager,
 JComponent view)

the representation of the context must be a subtype of GuiReprValue. view must be a GuiSwingView.ValuePane

Parameters:

context - the associated context

specifierIndex - the optional index for row-index (nullable)

specifierManager - specifier factory for the column value

view - the component for both editor and renderer

ObjectTableColumnValue

public ObjectTableColumnValue(GuiMappingContext context,
 GuiSwingTableColumn.SpecifierManagerIndex specifierIndex,
 GuiSwingView.SpecifierManager specifierManager,
 JComponent view,
 JComponent editorView)

ObjectTableColumnValue

public ObjectTableColumnValue(GuiMappingContext context,
 GuiSwingTableColumn.SpecifierManagerIndex specifierIndex,
 GuiSwingView.SpecifierManager specifierManager,
 TableCellRenderer renderer,
 TableCellEditor editor)

Method Details

withBorderType

public ObjectTableColumnValue withBorderType(ObjectTableColumnValue.CellBorderType type)

specify the margin border when the editor is a ObjectTableColumnValue.ObjectTableCellEditor.

Parameters:

type - the border type

Returns:

this

Since:

1.6

withEditorForColumnAlwaysApplying

public ObjectTableColumnValue withEditorForColumnAlwaysApplying(boolean alwaysApplying)

if the parameter to be true, it updates the editor of tableColumn

Parameters:

alwaysApplying - true for editorForColumn() always returning editor

Returns:

this

Since:

1.6

editorForColumn

protected TableCellEditor editorForColumn()

getSpecifierManager

public GuiSwingView.SpecifierManager getSpecifierManager()

Specified by:

getSpecifierManager in interface GuiSwingTableColumn.ObjectTableColumnWithContext

setSettingsWindow

public void setSettingsWindow(SettingsWindow settingWindow)

Description copied from interface: GuiSwingView.SettingsWindowClient

at initialization of the root-pane, the method will be called for existing sub-panes. a dynamically created view needs to be manually set by those panes.

Specified by:

setSettingsWindow in interface GuiSwingView.SettingsWindowClient

Parameters:

settingWindow - a settings-window from the root-pane, which will be disposed at closing of the main window

getSettingsWindow

public SettingsWindow getSettingsWindow()

Specified by:

getSettingsWindow in interface GuiSwingView.SettingsWindowClient

Returns:

null

setPreferencesUpdater

public void setPreferencesUpdater(Consumer<GuiSwingPrefsSupports.PreferencesUpdateEvent> updater)

Specified by:

setPreferencesUpdater in interface GuiSwingPrefsSupports.PreferencesUpdateSupport

loadSwingPreferences

public void loadSwingPreferences(GuiPreferences prefs,
 GuiSwingPrefsApplyOptions options)

Specified by:

loadSwingPreferences in interface GuiSwingTableColumn.ObjectTableColumnWithContext

Parameters:

prefs - the source preferences

options - processor

saveSwingPreferences

public void saveSwingPreferences(GuiPreferences prefs)

Specified by:

saveSwingPreferences in interface GuiSwingTableColumn.ObjectTableColumnWithContext

shutdown

public void shutdown()

Overrides:

shutdown in class ObjectTableColumn

setColumnViewUpdater

public void setColumnViewUpdater(Consumer<ObjectTableColumn> updater)

Overrides:

setColumnViewUpdater in class ObjectTableColumn

viewUpdateAsDynamic

public void viewUpdateAsDynamic(ObjectTableColumn source)

Overrides:

viewUpdateAsDynamic in class ObjectTableColumn

getContext

public GuiMappingContext getContext()

Specified by:

getContext in interface GuiSwingTableColumn.ObjectTableColumnWithContext

getContextIndex

public int getContextIndex()

getSpecifier

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

Overrides:

getSpecifier in class ObjectTableColumn

getCellValue

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

Overrides:

getCellValue in class ObjectTableColumn

Parameters:

rowObject - the row object at rowIndex

rowIndex - the row index in the list

columnIndex - the column index of the view table-model of the column

specifier - the specifier for the column value, can be obtained by getSpecifier(int, int)

Returns:

the column value

setCellValue

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

Overrides:

setCellValue in class ObjectTableColumn

Parameters:

rowObject - the row object at rowIndex

rowIndex - the row index in the list

columnIndex - the column index of the view table-model of the column

newColumnValue - the new value to be set

specifier - the specifier for the column value, can be obtained by getSpecifier(int, int)

Returns:

null

getCellValueFromContext

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

Overrides:

getCellValueFromContext in class ObjectTableColumn

setCellValueFromContext

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

Overrides:

setCellValueFromContext in class ObjectTableColumn

toActionValue

public Object toActionValue(Object value)

Overrides:

toActionValue in class ObjectTableColumn

Parameters:

value - an element value obtained from GuiReprCollectionTable.TableTarget

Returns:

a value which an action can accept

fromActionValue

public Object fromActionValue(Object value)

Overrides:

fromActionValue in class ObjectTableColumn

Parameters:

value - an element value

Returns:

a value supplied to a setter of GuiReprCollectionTable.TableTarget

isTaskRunnerUsedFor

public boolean isTaskRunnerUsedFor(Supplier<?> task)

Description copied from class: ObjectTableColumn

determines the task can be submitted to the task runner

Overrides:

isTaskRunnerUsedFor in class ObjectTableColumn

Parameters:

task - the task to be invoked

Returns:

true if the task can be submitted to the task runner

setForComponents

public static <CompType> void setForComponents(Class<CompType> componentType,
 Consumer<CompType> setter,
 Object... views)

setTableColor

public static void setTableColor(JTable table,
 JComponent component,
 boolean isSelected)

setTableColor

public static void setTableColor(JTable table,
 JComponent component,
 boolean isSelected,
 boolean hasFocus,
 int row,
 int column)

Parameters:

table - the table

component - the cell component

isSelected - the row is selected if true

hasFocus - the row is focused if true

row - the row index

column - the column index

Since:

1.2

getTableFocusBorder

public static Border getTableFocusBorder()

getCompositesForRows

public List<ObjectTableColumn.TableMenuComposite> getCompositesForRows()

Overrides:

getCompositesForRows in class ObjectTableColumn

getCompositesForCells

public List<ObjectTableColumn.TableMenuComposite> getCompositesForCells()

Overrides:

getCompositesForCells in class ObjectTableColumn