Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.component.table

Interface FilterTable.Builder<R,C>

Type Parameters:

R - the type representing rows

C - the type used to identify columns

All Superinterfaces:

ComponentBuilder<FilterTable<R,C>,FilterTable.Builder<R,C>>, Supplier<FilterTable<R,C>>

Enclosing class:

FilterTable<R,C>

public static interface FilterTable.Builder<R,C>
extends ComponentBuilder<FilterTable<R,C>,FilterTable.Builder<R,C>>

A builder for a FilterTable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FilterTable.Builder.ModelStep	Provides a FilterTable.Builder instance based on a given table model

Method Summary

Modifier and Type	Method	Description
FilterTable.Builder<R,C>	autoResizeMode(int autoResizeMode)
FilterTable.Builder<R,C>	autoStartsEdit(boolean autoStartsEdit)
FilterTable.Builder<R,C>	cellEditable(BiPredicate<R,C> cellEditable)
<T> FilterTable.Builder<R,C>	cellEditor(C identifier, FilterTableCellEditor<?,T> cellEditor)	the cell renderer for the given column, overrides cellEditors(FilterTableCellEditor.Factory).
FilterTable.Builder<R,C>	cellEditors(FilterTableCellEditor.Factory<R,C> cellEditors)	Note that this factory is only used to create cell editors for columns which do not already have a cell editor and is overridden by any editor set via cellEditor(Object, FilterTableCellEditor).
<T> FilterTable.Builder<R,C>	cellRenderer(C identifier, Class<T> columnClass, Consumer<FilterTableCellRenderer.Builder<R,C,T>> renderer)	The cell renderer for the given column, overrides cellRenderers(FilterTableCellRenderer.Factory).
FilterTable.Builder<R,C>	cellRenderers(FilterTableCellRenderer.Factory<R,C> cellRenderers)	Note that this factory is only used to create cell renderers for columns which do not already have a cell renderer and is overridden by any renderer set via cellRenderer(Object, Class, Consumer).
FilterTable.Builder<R,C>	cellSelection(boolean cellSelection)
FilterTable.Builder<R,C>	centerOnScroll(FilterTable.CenterOnScroll centerOnScroll)
FilterTable.Builder<R,C>	columnReordering(boolean columnReordering)
FilterTable.Builder<R,C>	columnResizing(boolean columnResizing)
FilterTable.Builder<R,C>	columns(Consumer<FilterTableColumn.Builder<C>> columns)
FilterTable.Builder<R,C>	columnSelection(boolean columnSelection)
FilterTable.Builder<R,C>	columnToolTips(boolean columnToolTips)	Specifies whether the table should display the column tooltips when the mouse hovers over the table header
FilterTable.Builder<R,C>	doubleClick(Action doubleClick)
FilterTable.Builder<R,C>	dragEnabled(boolean dragEnabled)
FilterTable.Builder<R,C>	dropMode(DropMode dropMode)
FilterTable.Builder<R,C>	fillsViewportHeight(boolean fillsViewportHeight)	Specifies whether the table fills the viewport height, default true.
FilterTable.Builder<R,C>	filterComponents(C identifier, ColumnConditionPanel.ConditionComponents filterComponents)
FilterTable.Builder<R,C>	filterPanel(TableConditionPanel.Factory<C> filterPanel)
FilterTable.Builder<R,C>	filterView(ConditionPanel.ConditionView filterView)
FilterTable.Builder<R,C>	gridColor(Color gridColor)
FilterTable.Builder<R,C>	headerless(boolean headerless)
FilterTable.Builder<R,C>	headerRenderers(FilterTableHeaderRenderer.Factory<R,C> headerRenderers)	Note that this factory is only used to create header renderers for columns which do not already have a header renderer
FilterTable.Builder<R,C>	hideColumns(C... columns)
FilterTable.Builder<R,C>	intercellSpacing(Dimension intercellSpacing)
FilterTable.Builder<R,C>	keyStroke(ControlKey<?> controlKey, KeyStroke keyStroke)
FilterTable.Builder<R,C>	resizeRowToFitEditor(boolean resizeRowToFitEditor)	Only applicable to FilterTableCellEditor
FilterTable.Builder<R,C>	rowHeight(int rowHeight)
FilterTable.Builder<R,C>	rowMargin(int rowMargin)
FilterTable.Builder<R,C>	rowSelection(boolean rowSelection)
FilterTable.Builder<R,C>	rowsFillViewport(boolean rowsFillViewport)	Specifies whether the remaining rows below the ones available in the table model are painted.
FilterTable.Builder<R,C>	scrollToAddedItem(boolean scrollToAddedItem)	Specifies whether the table should scroll when items are added, so that the topmost added item appears at the top of the table view.
FilterTable.Builder<R,C>	scrollToSelectedItem(boolean scrollToSelectedItem)
FilterTable.Builder<R,C>	selectionMode(int selectionMode)
FilterTable.Builder<R,C>	showGrid(boolean showGrid)
FilterTable.Builder<R,C>	showHorizontalLines(boolean showHorizontalLines)
FilterTable.Builder<R,C>	showVerticalLines(boolean showVerticalLines)
FilterTable.Builder<R,C>	sortable(boolean sortable)
FilterTable.Builder<R,C>	startEditing(KeyStroke keyStroke)	Associates the given keyStroke with the action associated with the 'startEditing' key in the table action map.
FilterTable.Builder<R,C>	stopEditOnFocusLost(boolean stopEditOnFocusLost)
FilterTable.Builder<R,C>	summaryValues(SummaryModel.SummaryValues.Factory<C> summaryValues)
FilterTable.Builder<R,C>	surrendersFocusOnKeystroke(boolean surrendersFocusOnKeystroke)
FilterTable.Builder<R,C>	visibleRows(int visibleRows)	Specifies the preferred number of rows to display in a scrollable viewport.

Methods inherited from interface is.codion.swing.common.ui.component.builder.ComponentBuilder

ancestorListener, background, border, build, build, clientProperty, componentListener, componentOrientation, enabled, enabled, focusable, focusable, focusCycleRoot, focusListener, font, font, foreground, get, hierarchyListener, keyEvent, keyListener, label, label, maximumHeight, maximumSize, maximumWidth, minimumHeight, minimumSize, minimumWidth, mouseListener, mouseMotionListener, mouseWheelListener, name, onBuild, onSetVisible, opaque, popupControl, popupControls, popupControls, popupMenu, preferredHeight, preferredSize, preferredWidth, propertyChangeListener, propertyChangeListener, scrollPane, toolTipText, toolTipText, transferFocusOnEnter, transferFocusOnEnter, transferHandler, visible, visible

Method Details

columns

FilterTable.Builder<R,C> columns(Consumer<FilterTableColumn.Builder<C>> columns)

Parameters:

columns - called to configure each column builder

Returns:

this builder instance

hideColumns

FilterTable.Builder<R,C> hideColumns(C... columns)

Parameters:

columns - the columns to hide initially

Returns:

this builder instance

summaryValues

FilterTable.Builder<R,C> summaryValues(SummaryModel.SummaryValues.Factory<C> summaryValues)

Parameters:

summaryValues - the column summary values factory

Returns:

this builder instance

filterPanel

FilterTable.Builder<R,C> filterPanel(TableConditionPanel.Factory<C> filterPanel)

Parameters:

filterPanel - the table filter condition panel factory

Returns:

this builder instance

filterComponents

FilterTable.Builder<R,C> filterComponents(C identifier,
 ColumnConditionPanel.ConditionComponents filterComponents)

Parameters:

identifier - the column identifier

filterComponents - the column filter component factory for the given column

Returns:

this builder instance

See Also:

• FilterTable.filters()

cellRenderer

<T> FilterTable.Builder<R,C> cellRenderer(C identifier,
 Class<T> columnClass,
 Consumer<FilterTableCellRenderer.Builder<R,C,T>> renderer)

The cell renderer for the given column, overrides cellRenderers(FilterTableCellRenderer.Factory).

Type Parameters:

T - the column type

Parameters:

identifier - the column identifier

columnClass - the column class

renderer - provided with the cell renderer to for the given column

Returns:

this builder instance

cellRenderers

FilterTable.Builder<R,C> cellRenderers(FilterTableCellRenderer.Factory<R,C> cellRenderers)

Note that this factory is only used to create cell renderers for columns which do not already have a cell renderer and is overridden by any renderer set via cellRenderer(Object, Class, Consumer).

Parameters:

cellRenderers - the table cell renderer factory

Returns:

this builder instance

headerRenderers

FilterTable.Builder<R,C> headerRenderers(FilterTableHeaderRenderer.Factory<R,C> headerRenderers)

Note that this factory is only used to create header renderers for columns which do not already have a header renderer

Parameters:

headerRenderers - the header renderer factory

Returns:

this builder instance

cellEditor

<T> FilterTable.Builder<R,C> cellEditor(C identifier,
 FilterTableCellEditor<?,T> cellEditor)

the cell renderer for the given column, overrides cellEditors(FilterTableCellEditor.Factory).

Type Parameters:

T - the column type

Parameters:

identifier - the column identifier

cellEditor - the cell editor to use for the given column

Returns:

this builder instance

cellEditors

FilterTable.Builder<R,C> cellEditors(FilterTableCellEditor.Factory<R,C> cellEditors)

Note that this factory is only used to create cell editors for columns which do not already have a cell editor and is overridden by any editor set via cellEditor(Object, FilterTableCellEditor).

Parameters:

cellEditors - the table cell editor factory

Returns:

this builder instance

cellEditable

FilterTable.Builder<R,C> cellEditable(BiPredicate<R,C> cellEditable)

Parameters:

cellEditable - called to see if the given cell in the given row is editable, after the model has been queried

Returns:

this builder instance

See Also:

• JTable.isCellEditable(int, int)

startEditing

FilterTable.Builder<R,C> startEditing(KeyStroke keyStroke)

Associates the given keyStroke with the action associated with the 'startEditing' key in the table action map.

Parameters:

keyStroke - a keyStroke for triggering the 'startEditing' action

Returns:

this builder instance

autoStartsEdit

FilterTable.Builder<R,C> autoStartsEdit(boolean autoStartsEdit)

Parameters:

autoStartsEdit - true if editing should start automatically

Returns:

this builder instance

surrendersFocusOnKeystroke

FilterTable.Builder<R,C> surrendersFocusOnKeystroke(boolean surrendersFocusOnKeystroke)

Parameters:

surrendersFocusOnKeystroke - true if the table should surrenders focus on keystroke

Returns:

this builder instance

See Also:

• JTable.setSurrendersFocusOnKeystroke(boolean)

stopEditOnFocusLost

FilterTable.Builder<R,C> stopEditOnFocusLost(boolean stopEditOnFocusLost)

Parameters:

stopEditOnFocusLost - whether the table should stop and commit editing when it loses focus

Returns:

this builder instance

See Also:

• FilterTable.STOP_EDIT_ON_FOCUS_LOST

centerOnScroll

FilterTable.Builder<R,C> centerOnScroll(FilterTable.CenterOnScroll centerOnScroll)

Parameters:

centerOnScroll - the center on scroll behavious

Returns:

this builder instance

doubleClick

FilterTable.Builder<R,C> doubleClick(Action doubleClick)

Parameters:

doubleClick - the action to perform on a double-click

Returns:

this builder instance

scrollToSelectedItem

FilterTable.Builder<R,C> scrollToSelectedItem(boolean scrollToSelectedItem)

Parameters:

scrollToSelectedItem - true if this table should scroll to the selected item

Returns:

this builder instance

scrollToAddedItem

FilterTable.Builder<R,C> scrollToAddedItem(boolean scrollToAddedItem)

Specifies whether the table should scroll when items are added, so that the topmost added item appears at the top of the table view.

Default: false.

Parameters:

scrollToAddedItem - true if this table should scroll to the topmost added item

Returns:

this builder instance

columnToolTips

FilterTable.Builder<R,C> columnToolTips(boolean columnToolTips)

Specifies whether the table should display the column tooltips when the mouse hovers over the table header

Default: true.

Parameters:

columnToolTips - true if column tool tips should be shown

Returns:

this builder instance

See Also:

• FilterTableColumn.toolTipText()
• FilterTableModel.TableColumns.description(Object)

fillsViewportHeight

FilterTable.Builder<R,C> fillsViewportHeight(boolean fillsViewportHeight)

Specifies whether the table fills the viewport height, default true.

Parameters:

fillsViewportHeight - whether this table is always made large enough to fill the height of an enclosing viewport

Returns:

this builder instance

See Also:

• FilterTable.FILLS_VIEWPORT_HEIGHT
• JTable.setFillsViewportHeight(boolean)

rowsFillViewport

FilterTable.Builder<R,C> rowsFillViewport(boolean rowsFillViewport)

Specifies whether the remaining rows below the ones available in the table model are painted.

Note that this requires JTable.setFillsViewportHeight(boolean) to be enabled, and relies on that remaining so. This is true by default, see fillsViewportHeight(boolean).

Parameters:

rowsFillViewport - true if the remaining rows should be painted to fill the viewport

Returns:

this builder instance

See Also:

• FilterTable.ROWS_FILL_VIEWPORT
• fillsViewportHeight(boolean)

visibleRows

FilterTable.Builder<R,C> visibleRows(int visibleRows)

Specifies the preferred number of rows to display in a scrollable viewport.

Parameters:

visibleRows - the preferred number of visible rows to display

Returns:

this builder instance

See Also:

• JTable.getPreferredScrollableViewportSize()

headerless

FilterTable.Builder<R,C> headerless(boolean headerless)

Parameters:

headerless - true if the table should be headerless

Returns:

this builder instance

sortable

FilterTable.Builder<R,C> sortable(boolean sortable)

Parameters:

sortable - true if sorting via clicking the header should be enbled

Returns:

this builder instance

selectionMode

FilterTable.Builder<R,C> selectionMode(int selectionMode)

Parameters:

selectionMode - the table selection mode

Returns:

this builder instance

See Also:

• JTable.setSelectionMode(int)

rowSelection

FilterTable.Builder<R,C> rowSelection(boolean rowSelection)

Parameters:

rowSelection - true if row selection should be enabled

Returns:

this builder instance

See Also:

• JTable.setRowSelectionAllowed(boolean)

columnSelection

FilterTable.Builder<R,C> columnSelection(boolean columnSelection)

Parameters:

columnSelection - true if column selection should be enabled

Returns:

this builder instance

See Also:

• JTable.setColumnSelectionAllowed(boolean)

cellSelection

FilterTable.Builder<R,C> cellSelection(boolean cellSelection)

Parameters:

cellSelection - true if cell selection should be enabled

Returns:

this builder instance

See Also:

• JTable.setCellSelectionEnabled(boolean)

columnReordering

FilterTable.Builder<R,C> columnReordering(boolean columnReordering)

Parameters:

columnReordering - true if column reordering should be allowed

Returns:

this builder instance

columnResizing

FilterTable.Builder<R,C> columnResizing(boolean columnResizing)

Parameters:

columnResizing - true if column resizing should be allowed

Returns:

this builder instance

autoResizeMode

FilterTable.Builder<R,C> autoResizeMode(int autoResizeMode)

Parameters:

autoResizeMode - the table auto column resizing mode

Returns:

this builder instance

resizeRowToFitEditor

FilterTable.Builder<R,C> resizeRowToFitEditor(boolean resizeRowToFitEditor)

Only applicable to FilterTableCellEditor

Parameters:

resizeRowToFitEditor - true if the row should be resized to fit the editor

Returns:

this builder instance

filterView

FilterTable.Builder<R,C> filterView(ConditionPanel.ConditionView filterView)

Parameters:

filterView - the initial filter condition view

Returns:

this builder instance

keyStroke

FilterTable.Builder<R,C> keyStroke(ControlKey<?> controlKey,
 KeyStroke keyStroke)

Parameters:

controlKey - the control key

keyStroke - the keyStroke to assign to the given control

Returns:

this builder instance

rowHeight

FilterTable.Builder<R,C> rowHeight(int rowHeight)

Parameters:

rowHeight - the row height

Returns:

this builder instance

See Also:

• JTable.setRowHeight(int)

rowMargin

FilterTable.Builder<R,C> rowMargin(int rowMargin)

Parameters:

rowMargin - the row margin

Returns:

this builder instance

See Also:

• JTable.setRowMargin(int)

intercellSpacing

FilterTable.Builder<R,C> intercellSpacing(Dimension intercellSpacing)

Parameters:

intercellSpacing - the intercell spacing

Returns:

this builder instance

See Also:

• JTable.setIntercellSpacing(Dimension)

gridColor

FilterTable.Builder<R,C> gridColor(Color gridColor)

Parameters:

gridColor - the grid color

Returns:

this builder instance

See Also:

• JTable.setGridColor(Color)

showGrid

FilterTable.Builder<R,C> showGrid(boolean showGrid)

Parameters:

showGrid - the show grid value

Returns:

this builder instance

See Also:

• JTable.setShowGrid(boolean)

showHorizontalLines

FilterTable.Builder<R,C> showHorizontalLines(boolean showHorizontalLines)

Parameters:

showHorizontalLines - the show horizontal lines value

Returns:

this builder instance

See Also:

• JTable.setShowHorizontalLines(boolean)

showVerticalLines

FilterTable.Builder<R,C> showVerticalLines(boolean showVerticalLines)

Parameters:

showVerticalLines - the show vertical lines value

Returns:

this builder instance

See Also:

• JTable.setShowVerticalLines(boolean)

dragEnabled

FilterTable.Builder<R,C> dragEnabled(boolean dragEnabled)

Parameters:

dragEnabled - the drag enabled value

Returns:

this builder instance

See Also:

• JTable.setDragEnabled(boolean)

dropMode

FilterTable.Builder<R,C> dropMode(DropMode dropMode)

Parameters:

dropMode - the drop mode

Returns:

this builder instance

See Also:

• JTable.setDropMode(DropMode)