Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui

Class EntityTablePanel.Config

java.lang.Object

is.codion.swing.framework.ui.EntityTablePanel.Config

Enclosing class:

EntityTablePanel

public static final class EntityTablePanel.Config
extends Object

Contains configuration settings for a EntityTablePanel which must be set before the panel is initialized.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<EntityTablePanel.AutoResizeModeSelection>	AUTO_RESIZE_MODE_SELECTION	Specifies how column selection is presented to the user. Value type: EntityTablePanel.AutoResizeModeSelection Default value: EntityTablePanel.AutoResizeModeSelection.DIALOG
static final PropertyValue<EntityTablePanel.ColumnSelection>	COLUMN_SELECTION	Specifies how column selection is presented to the user. Value type: EntityTablePanel.ColumnSelection Default value: EntityTablePanel.ColumnSelection.DIALOG
static final PropertyValue<ColumnConditionPanel.ConditionState>	CONDITION_STATE	Specifies the default initial table condition panel state Value type: ColumnConditionPanel.ConditionState Default value: ColumnConditionPanel.ConditionState.HIDDEN
static final PropertyValue<EntityTablePanel.EditAttributeSelection>	EDIT_ATTRIBUTE_SELECTION	Specifies how the edit an attribute action is presented to the user. Value type: EntityTablePanel.EditAttributeSelection Default value: EntityTablePanel.EditAttributeSelection.MENU
static final PropertyValue<ColumnConditionPanel.ConditionState>	FILTER_STATE	Specifies the default initial table filter panel state Value type: ColumnConditionPanel.ConditionState Default value: ColumnConditionPanel.ConditionState.HIDDEN
static final PropertyValue<Boolean>	INCLUDE_CLEAR_CONTROL	Specifies whether to include a 'Clear' control in the popup menu. Value type: Boolean Default value: false
static final PropertyValue<Boolean>	INCLUDE_CONDITION_PANEL	Specifies whether to include a condition panel. Value type: Boolean Default value: true
static final PropertyValue<Boolean>	INCLUDE_ENTITY_MENU	Specifies whether to include a EntityPopupMenu on this table, triggered with CTRL-ALT-V. Value type: Boolean Default value: true
static final PropertyValue<Boolean>	INCLUDE_FILTER_PANEL	Specifies whether to include a filter panel. Value type: Boolean Default value: true
static final PropertyValue<Boolean>	INCLUDE_LIMIT_MENU	Specifies whether to include a popup menu for configuring the table model limit. Value type: Boolean Default value: false
static final PropertyValue<Boolean>	INCLUDE_POPUP_MENU	Specifies whether to include the default popup menu on entity tables Value type: Boolean Default value: true
static final PropertyValue<Boolean>	INCLUDE_SUMMARY_PANEL	Specifies whether to include a summary panel. Value type: Boolean Default value: true
static final PropertyValue<Boolean>	ORDER_QUERY_BY_SORT_ORDER	Specifies whether the table model sort order is used as a basis for the query order by clause.
static final PropertyValue<Boolean>	QUERY_HIDDEN_COLUMNS	Specifies whether the values of hidden columns are included in the underlying query Value type: Boolean Default value: true
static final PropertyValue<EntityTablePanel.RefreshButtonVisible>	REFRESH_BUTTON_VISIBLE	Specifies whether the refresh button should always be visible or only when the condition panel is visible Value type: Boolean Default value: EntityTablePanel.RefreshButtonVisible.WHEN_CONDITION_PANEL_IS_VISIBLE
static final PropertyValue<Boolean>	SHOW_REFRESH_PROGRESS_BAR	Specifies whether to show an indeterminate progress bar while the model is refreshing. Value type: Boolean Default value: false
static final PropertyValue<Boolean>	SUMMARY_PANEL_VISIBLE	Specifies whether table summary panel should be visible or not by default Value type: Boolean Default value: false

Method Summary

Modifier and Type	Method	Description
EntityTablePanel.Config	autoResizeModeSelection(EntityTablePanel.AutoResizeModeSelection autoResizeModeSelection)
EntityTablePanel.Config	columnSelection(EntityTablePanel.ColumnSelection columnSelection)
EntityTablePanel.Config	conditionFieldFactory(FilterColumnConditionPanel.FieldFactory<Attribute<?>> conditionFieldFactory)
EntityTablePanel.Config	configureTable(Consumer<FilterTable.Builder<Entity,Attribute<?>>> tableBuilder)	Provides access to the builder for the underlying FilterTable
EntityTablePanel.Config	deleteConfirmer(EntityEditPanel.Confirmer deleteConfirmer)
EntityTablePanel.Config	editable(Consumer<ValueSet<Attribute<?>>> attributes)
EntityTablePanel.Config	editAttributeSelection(EntityTablePanel.EditAttributeSelection editAttributeSelection)
<T, A extends Attribute<T>, C extends JComponent> EntityTablePanel.Config	editComponentFactory(A attribute, EntityComponentFactory<T,A,C> componentFactory)	Sets the component factory for the given attribute, used when editing entities via EntityTablePanel.editSelected(Attribute).
EntityTablePanel.Config	includeAddControl(boolean includeAddControl)
EntityTablePanel.Config	includeClearControl(boolean includeClearControl)
EntityTablePanel.Config	includeConditionPanel(boolean includeConditionPanel)
EntityTablePanel.Config	includeEditAttributeControl(boolean includeEditAttributeControl)
EntityTablePanel.Config	includeEditControl(boolean includeEditControl)
EntityTablePanel.Config	includeEntityMenu(boolean includeEntityMenu)
EntityTablePanel.Config	includeFilterPanel(boolean includeFilterPanel)
EntityTablePanel.Config	includeLimitMenu(boolean includeLimitMenu)
EntityTablePanel.Config	includePopupMenu(boolean includePopupMenu)
EntityTablePanel.Config	includeSelectionModeControl(boolean includeSelectionModeControl)
EntityTablePanel.Config	includeSouthPanel(boolean includeSouthPanel)
EntityTablePanel.Config	includeSummaryPanel(boolean includeSummaryPanel)
EntityTablePanel.Config	includeToolBar(boolean includeToolBar)
EntityTablePanel.Config	keyStroke(ControlKey<?> controlKey, Consumer<Value<KeyStroke>> keyStroke)
EntityTablePanel.Config	referentialIntegrityErrorHandling(ReferentialIntegrityErrorHandling referentialIntegrityErrorHandling)
EntityTablePanel.Config	refreshButtonVisible(EntityTablePanel.RefreshButtonVisible refreshButtonVisible)
EntityTablePanel.Config	showRefreshProgressBar(boolean showRefreshProgressBar)
EntityTablePanel.Config	statusMessage(Function<SwingEntityTableModel,String> statusMessage)
EntityTablePanel.Config	tableConditionPanelFactory(TableConditionPanel.Factory<Attribute<?>> tableConditionPanelFactory)
EntityTablePanel	tablePanel()

Methods inherited from class java.lang.Object

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

Field Details

QUERY_HIDDEN_COLUMNS

public static final PropertyValue<Boolean> QUERY_HIDDEN_COLUMNS

Specifies whether the values of hidden columns are included in the underlying query
Value type: Boolean
Default value: true

ORDER_QUERY_BY_SORT_ORDER

public static final PropertyValue<Boolean> ORDER_QUERY_BY_SORT_ORDER

Specifies whether the table model sort order is used as a basis for the query order by clause. Note that this only applies to column attributes. Value type: Boolean
Default value: false

CONDITION_STATE

public static final PropertyValue<ColumnConditionPanel.ConditionState> CONDITION_STATE

Specifies the default initial table condition panel state
Value type: ColumnConditionPanel.ConditionState
Default value: ColumnConditionPanel.ConditionState.HIDDEN

FILTER_STATE

public static final PropertyValue<ColumnConditionPanel.ConditionState> FILTER_STATE

Specifies the default initial table filter panel state
Value type: ColumnConditionPanel.ConditionState
Default value: ColumnConditionPanel.ConditionState.HIDDEN

SUMMARY_PANEL_VISIBLE

public static final PropertyValue<Boolean> SUMMARY_PANEL_VISIBLE

Specifies whether table summary panel should be visible or not by default
Value type: Boolean
Default value: false

INCLUDE_POPUP_MENU

public static final PropertyValue<Boolean> INCLUDE_POPUP_MENU

Specifies whether to include the default popup menu on entity tables
Value type: Boolean
Default value: true

INCLUDE_ENTITY_MENU

public static final PropertyValue<Boolean> INCLUDE_ENTITY_MENU

Specifies whether to include a EntityPopupMenu on this table, triggered with CTRL-ALT-V.
Value type: Boolean
Default value: true

INCLUDE_CLEAR_CONTROL

public static final PropertyValue<Boolean> INCLUDE_CLEAR_CONTROL

Specifies whether to include a 'Clear' control in the popup menu.
Value type: Boolean
Default value: false

INCLUDE_CONDITION_PANEL

public static final PropertyValue<Boolean> INCLUDE_CONDITION_PANEL

Specifies whether to include a condition panel.
Value type: Boolean
Default value: true

INCLUDE_FILTER_PANEL

public static final PropertyValue<Boolean> INCLUDE_FILTER_PANEL

Specifies whether to include a filter panel.
Value type: Boolean
Default value: true

INCLUDE_SUMMARY_PANEL

public static final PropertyValue<Boolean> INCLUDE_SUMMARY_PANEL

Specifies whether to include a summary panel.
Value type: Boolean
Default value: true

INCLUDE_LIMIT_MENU

public static final PropertyValue<Boolean> INCLUDE_LIMIT_MENU

Specifies whether to include a popup menu for configuring the table model limit.
Value type: Boolean
Default value: false

SHOW_REFRESH_PROGRESS_BAR

public static final PropertyValue<Boolean> SHOW_REFRESH_PROGRESS_BAR

Specifies whether to show an indeterminate progress bar while the model is refreshing.
Value type: Boolean
Default value: false

REFRESH_BUTTON_VISIBLE

public static final PropertyValue<EntityTablePanel.RefreshButtonVisible> REFRESH_BUTTON_VISIBLE

Specifies whether the refresh button should always be visible or only when the condition panel is visible
Value type: Boolean
Default value: EntityTablePanel.RefreshButtonVisible.WHEN_CONDITION_PANEL_IS_VISIBLE

COLUMN_SELECTION

public static final PropertyValue<EntityTablePanel.ColumnSelection> COLUMN_SELECTION

Specifies how column selection is presented to the user.
Value type: EntityTablePanel.ColumnSelection
Default value: EntityTablePanel.ColumnSelection.DIALOG

AUTO_RESIZE_MODE_SELECTION

public static final PropertyValue<EntityTablePanel.AutoResizeModeSelection> AUTO_RESIZE_MODE_SELECTION

Specifies how column selection is presented to the user.
Value type: EntityTablePanel.AutoResizeModeSelection
Default value: EntityTablePanel.AutoResizeModeSelection.DIALOG

EDIT_ATTRIBUTE_SELECTION

public static final PropertyValue<EntityTablePanel.EditAttributeSelection> EDIT_ATTRIBUTE_SELECTION

Specifies how the edit an attribute action is presented to the user.
Value type: EntityTablePanel.EditAttributeSelection
Default value: EntityTablePanel.EditAttributeSelection.MENU

Method Details

tablePanel

public EntityTablePanel tablePanel()

Returns:

the table panel

configureTable

public EntityTablePanel.Config configureTable(Consumer<FilterTable.Builder<Entity,Attribute<?>>> tableBuilder)

Provides access to the builder for the underlying FilterTable

Parameters:

tableBuilder - the table builder

Returns:

this Config instance

tableConditionPanelFactory

public EntityTablePanel.Config tableConditionPanelFactory(TableConditionPanel.Factory<Attribute<?>> tableConditionPanelFactory)

Parameters:

tableConditionPanelFactory - the table condition panel factory

Returns:

this Config instance

conditionFieldFactory

public EntityTablePanel.Config conditionFieldFactory(FilterColumnConditionPanel.FieldFactory<Attribute<?>> conditionFieldFactory)

Parameters:

conditionFieldFactory - the condition field factory

Returns:

this Config instance

See Also:

• EntityTablePanel.conditionPanel()

includeSouthPanel

public EntityTablePanel.Config includeSouthPanel(boolean includeSouthPanel)

Parameters:

includeSouthPanel - true if the south panel should be included

Returns:

this Config instance

includeConditionPanel

public EntityTablePanel.Config includeConditionPanel(boolean includeConditionPanel)

Parameters:

includeConditionPanel - true if the condition panel should be included

Returns:

this Config instance

includeFilterPanel

public EntityTablePanel.Config includeFilterPanel(boolean includeFilterPanel)

Parameters:

includeFilterPanel - true if the filter panel should be included

Returns:

this Config instance

includeSummaryPanel

public EntityTablePanel.Config includeSummaryPanel(boolean includeSummaryPanel)

Parameters:

includeSummaryPanel - true if the summary panel should be included

Returns:

this Config instance

includePopupMenu

public EntityTablePanel.Config includePopupMenu(boolean includePopupMenu)

Parameters:

includePopupMenu - true if a popup menu should be included

Returns:

this Config instance

includeClearControl

public EntityTablePanel.Config includeClearControl(boolean includeClearControl)

Parameters:

includeClearControl - true if a 'Clear' control should be included in the popup menu

Returns:

this Config instance

Throws:

IllegalStateException - in case the panel has already been initialized

includeLimitMenu

public EntityTablePanel.Config includeLimitMenu(boolean includeLimitMenu)

Parameters:

includeLimitMenu - true if a popup menu for configuring the table model limit should be included

Returns:

this Config instance

includeEntityMenu

public EntityTablePanel.Config includeEntityMenu(boolean includeEntityMenu)

Parameters:

includeEntityMenu - true if a EntityPopupMenu should be available in this table, triggered with CTRL-ALT-V.

Returns:

this Config instance

includeSelectionModeControl

public EntityTablePanel.Config includeSelectionModeControl(boolean includeSelectionModeControl)

Parameters:

includeSelectionModeControl - true if a 'Single Selection' control should be included in the popup menu

Returns:

this Config instance

includeToolBar

public EntityTablePanel.Config includeToolBar(boolean includeToolBar)

Parameters:

includeToolBar - true if a toolbar should be included on the south panel

Returns:

this Config instance

includeAddControl

public EntityTablePanel.Config includeAddControl(boolean includeAddControl)

Parameters:

includeAddControl - true if a Add control should be included if a edit panel is available

Returns:

this Config instance

includeEditControl

public EntityTablePanel.Config includeEditControl(boolean includeEditControl)

Parameters:

includeEditControl - true if a Edit control should be included if a edit panel is available

Returns:

this Config instance

includeEditAttributeControl

public EntityTablePanel.Config includeEditAttributeControl(boolean includeEditAttributeControl)

Parameters:

includeEditAttributeControl - true if a 'Edit' attribute control should be included

Returns:

this Config instance

See Also:

• editAttributeSelection(EditAttributeSelection)

columnSelection

public EntityTablePanel.Config columnSelection(EntityTablePanel.ColumnSelection columnSelection)

Parameters:

columnSelection - specifies how columns are selected

Returns:

this Config instance

autoResizeModeSelection

public EntityTablePanel.Config autoResizeModeSelection(EntityTablePanel.AutoResizeModeSelection autoResizeModeSelection)

Parameters:

autoResizeModeSelection - specifies how auto-resize-mode is selected

Returns:

this Config instance

editAttributeSelection

public EntityTablePanel.Config editAttributeSelection(EntityTablePanel.EditAttributeSelection editAttributeSelection)

Parameters:

editAttributeSelection - specifies attributes are selected when editing the selected records

Returns:

this Config instance

keyStroke

public EntityTablePanel.Config keyStroke(ControlKey<?> controlKey,
 Consumer<Value<KeyStroke>> keyStroke)

Parameters:

controlKey - the control key

keyStroke - provides access to the Value controlling the key stroke for the given control

Returns:

this Config instance

editable

public EntityTablePanel.Config editable(Consumer<ValueSet<Attribute<?>>> attributes)

Parameters:

attributes - provides this tables editable attribute value set

Returns:

this Config instance

deleteConfirmer

public EntityTablePanel.Config deleteConfirmer(EntityEditPanel.Confirmer deleteConfirmer)

Parameters:

deleteConfirmer - the delete confirmer

Returns:

this Config instance

editComponentFactory

public <T,
A extends Attribute<T>,
C extends JComponent>
EntityTablePanel.Config editComponentFactory(A attribute,
 EntityComponentFactory<T,A,C> componentFactory)

Sets the component factory for the given attribute, used when editing entities via EntityTablePanel.editSelected(Attribute).

Type Parameters:

T - the value type

A - the attribute type

C - the component type

Parameters:

attribute - the attribute

componentFactory - the component factory

Returns:

this Config instance

referentialIntegrityErrorHandling

public EntityTablePanel.Config referentialIntegrityErrorHandling(ReferentialIntegrityErrorHandling referentialIntegrityErrorHandling)

Parameters:

referentialIntegrityErrorHandling - the action to take on a referential integrity error on delete

Returns:

this Config instance

refreshButtonVisible

public EntityTablePanel.Config refreshButtonVisible(EntityTablePanel.RefreshButtonVisible refreshButtonVisible)

Parameters:

refreshButtonVisible - the refresh button visible setting

Returns:

this Config instance

statusMessage

public EntityTablePanel.Config statusMessage(Function<SwingEntityTableModel,String> statusMessage)

Parameters:

statusMessage - the function used for creating the table status message

Returns:

this Config instance

showRefreshProgressBar

public EntityTablePanel.Config showRefreshProgressBar(boolean showRefreshProgressBar)

Parameters:

showRefreshProgressBar - controls whether an indeterminate progress bar should be shown while the model is refreshing

Returns:

this Config instance

See Also:

• SHOW_REFRESH_PROGRESS_BAR