Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui

Class EntityTablePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

is.codion.swing.framework.ui.EntityTablePanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class EntityTablePanel
extends JPanel

The EntityTablePanel is a UI class based on the EntityTableModel class. It consists of a JTable as well as filtering/searching and summary panels. The default layout is as follows

  ____________________________________________________
 |                conditionPanel                      |
 |____________________________________________________|
 |                                                    |
 |                                                    |
 |                                                    |
 |                                                    |
 |                entityTable (FilterTable)           |
 |                                                    |
 |                                                    |
 |                                                    |
 |                                                    |
 |____________________________________________________|
 |                summaryPanel                        |
 |____________________________________________________|
 |                southPanel                          |
 |____________________________________________________|
 

The condition and summary panels can be hidden Note that initialize() must be called to initialize this panel before displaying it.

See Also:

• EntityTableModel
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EntityTablePanel.AutoResizeModeSelection	Specifies how auto-resize-mode selection is presented.
static enum	EntityTablePanel.ColumnSelection	Specifies how column selection is presented.
static final class	EntityTablePanel.Config	Contains configuration settings for a EntityTablePanel which must be set before the panel is initialized.
static final class	EntityTablePanel.ControlKeys	The Controls available in a EntityTablePanel
static enum	EntityTablePanel.EditAttributeSelection	Specifies how attribute selection is presented for editing the selected records.
static enum	EntityTablePanel.RefreshButtonVisible	Specifies the refresh button visibility.

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
EntityTablePanel(SwingEntityTableModel tableModel)	Instantiates a new EntityTablePanel instance
EntityTablePanel(SwingEntityTableModel tableModel, EntityEditPanel editPanel)	Instantiates a new EntityTablePanel instance
EntityTablePanel(SwingEntityTableModel tableModel, EntityEditPanel editPanel, Consumer<EntityTablePanel.Config> config)	Instantiates a new EntityTablePanel instance
EntityTablePanel(SwingEntityTableModel tableModel, Consumer<EntityTablePanel.Config> config)	Instantiates a new EntityTablePanel instance

Method Summary

Modifier and Type	Method	Description
final void	addPopupMenuControls(Controls additionalPopupMenuControls)
final void	addToolBarControls(Controls additionalToolBarControls)
void	applyPreferences()	Applies any user preferences previously saved via savePreferences()
final <T extends TableConditionPanel<Attribute<?>>> T	conditions()
protected final void	configurePopupMenu(Consumer<Controls.Layout> popupMenuLayout)	Configures the popup menu controls layout. Note that the Controls.Layout instance has pre-configured defaults, which must be cleared in order to start with an empty configuration.
protected final void	configureToolBar(Consumer<Controls.Layout> toolBarLayout)	Configures the toolbar controls layout. Note that the Controls.Layout instance has pre-configured defaults, which must be cleared in order to start with an empty configuration.
protected final boolean	confirmDelete()
final <T extends Control> Value<T>	control(ControlKey<T> controlKey)	Returns a Value containing the control associated with controlKey, an empty Value if no such control is available.
final boolean	deleteSelected()	Deletes the entities selected in the underlying table model without asking for confirmation.
final boolean	deleteSelectedWithConfirmation()	Deletes the entities selected in the underlying table model after asking for confirmation using the confirmer specified via EntityTablePanel.Config.deleteConfirmer(Confirmer)
protected final void	displayException(Exception exception)	Displays the exception in a dialog, with the dialog owner as the current focus owner or this panel if none is available.
protected <T> EntityDialogs.EditAttributeDialogBuilder<T>	editDialogBuilder(Attribute<T> attribute)	Override to customize the edit dialog used when multiple entities are edited.
protected final <T extends EntityEditPanel> T	editPanel()
final void	editSelected()	Displays a selection dialog for selecting an attribute to edit and retrieves a new value via input dialog and performs an update on the selected entities assigning the value to the attribute
final void	editSelected(Attribute<?> attributeToEdit)	Retrieves a new value via input dialog and performs an update on the selected entities assigning the value to the attribute
final EntityTablePanel	initialize()	Initializes the UI, while presenting a wait cursor to the user.
protected JPanel	initializeSouthPanel()	Initializes the south panel, override and return null for no south panel.
protected void	layoutPanel(JComponent tableComponent, JPanel southPanel)	This method simply adds tablePanel at location BorderLayout.CENTER and, if non-null, the given southPanel to the BorderLayout.SOUTH location.
protected void	onException(Exception exception)	Propagates the exception to onValidationException(ValidationException) or onReferentialIntegrityException(ReferentialIntegrityException) depending on type, otherwise displays the exception.
protected void	onReferentialIntegrityException(ReferentialIntegrityException exception)	Called when a ReferentialIntegrityException occurs during a delete operation on the selected entities.
protected void	onValidationException(ValidationException exception)	Displays the exception message.
final State	orderQueryBySortOrder()	Specifies whether the current sort order is used as a basis for the query order by clause.
final State	queryHiddenColumns()	Returns whether the values of hidden columns are included when querying data
void	savePreferences()	Saves user preferences
protected void	setupControls()	Override to setup any custom controls.
protected void	setupKeyboardActions()	Sets up the keyboard shortcuts.
final State	summaryPanelVisible()
final FilterTable<Entity,Attribute<?>>	table()
final <T extends SwingEntityTableModel> T	tableModel()
final String	toString()
void	updateUI()
protected String	userPreferencesKey()	Returns the key used to identify user preferences for this table panel, that is column positions, widths and such.
final void	viewDependencies()	Displays a dialog containing tables of entities depending on the selected entities via non-soft foreign keys

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Details

EntityTablePanel

public EntityTablePanel(SwingEntityTableModel tableModel)

Instantiates a new EntityTablePanel instance

Parameters:

tableModel - the SwingEntityTableModel instance

EntityTablePanel

public EntityTablePanel(SwingEntityTableModel tableModel,
 Consumer<EntityTablePanel.Config> config)

Instantiates a new EntityTablePanel instance

Parameters:

tableModel - the SwingEntityTableModel instance

config - provides access to the table panel configuration

EntityTablePanel

public EntityTablePanel(SwingEntityTableModel tableModel,
 EntityEditPanel editPanel)

Instantiates a new EntityTablePanel instance

Parameters:

tableModel - the SwingEntityTableModel instance

editPanel - the edit panel

EntityTablePanel

public EntityTablePanel(SwingEntityTableModel tableModel,
 EntityEditPanel editPanel,
 Consumer<EntityTablePanel.Config> config)

Instantiates a new EntityTablePanel instance

Parameters:

tableModel - the SwingEntityTableModel instance

editPanel - the edit panel

config - provides access to the table panel configuration

Method Details

updateUI

public void updateUI()

Overrides:

updateUI in class JPanel

table

public final FilterTable<Entity,Attribute<?>> table()

Returns:

the table

Throws:

IllegalStateException - in case this method is called during configuration

tableModel

public final <T extends SwingEntityTableModel> T tableModel()

Type Parameters:

T - the table model type

Returns:

the EntityTableModel used by this EntityTablePanel

conditions

public final <T extends TableConditionPanel<Attribute<?>>>
T conditions()

Type Parameters:

T - the condition panel type

Returns:

the condition panel

Throws:

IllegalStateException - in case a condition panel is not available

See Also:

• EntityTablePanel.Config.includeConditions(boolean)

summaryPanelVisible

public final State summaryPanelVisible()

Returns:

the State controlling whether the summary panel is visible

orderQueryBySortOrder

public final State orderQueryBySortOrder()

Specifies whether the current sort order is used as a basis for the query order by clause. Note that this only applies to column attributes.

Returns:

the State controlling whether the current sort order should be used as a basis for the query order by clause

queryHiddenColumns

public final State queryHiddenColumns()

Returns whether the values of hidden columns are included when querying data

Returns:

the State controlling whether the values of hidden columns are included when querying data

addPopupMenuControls

public final void addPopupMenuControls(Controls additionalPopupMenuControls)

Parameters:

additionalPopupMenuControls - a set of controls to add to the table popup menu

Throws:

IllegalStateException - in case this panel has already been initialized

addToolBarControls

public final void addToolBarControls(Controls additionalToolBarControls)

Parameters:

additionalToolBarControls - a set of controls to add to the table toolbar menu

Throws:

IllegalStateException - in case this panel has already been initialized

toString

public final String toString()

Overrides:

toString in class Component

control

public final <T extends Control> Value<T> control(ControlKey<T> controlKey)

Returns a Value containing the control associated with controlKey, an empty Value if no such control is available.

Type Parameters:

T - the control type

Parameters:

controlKey - the control key

Returns:

the Value containing the control associated with controlKey

editSelected

public final void editSelected()

Displays a selection dialog for selecting an attribute to edit and retrieves a new value via input dialog and performs an update on the selected entities assigning the value to the attribute

See Also:

• EntityTablePanel.Config.editComponentFactory(Attribute, EntityComponentFactory)

editSelected

public final void editSelected(Attribute<?> attributeToEdit)

Retrieves a new value via input dialog and performs an update on the selected entities assigning the value to the attribute

Parameters:

attributeToEdit - the attribute which value to edit

See Also:

• EntityTablePanel.Config.editComponentFactory(Attribute, EntityComponentFactory)

viewDependencies

public final void viewDependencies()

Displays a dialog containing tables of entities depending on the selected entities via non-soft foreign keys

deleteSelectedWithConfirmation

public final boolean deleteSelectedWithConfirmation()

Deletes the entities selected in the underlying table model after asking for confirmation using the confirmer specified via EntityTablePanel.Config.deleteConfirmer(Confirmer)

Returns:

true if the delete operation was successful

See Also:

• EntityTablePanel.Config.deleteConfirmer(Confirmer)

deleteSelected

public final boolean deleteSelected()

Deletes the entities selected in the underlying table model without asking for confirmation.

Returns:

true if the delete operation was successful

savePreferences

public void savePreferences()

Saves user preferences

See Also:

• userPreferencesKey()

applyPreferences

public void applyPreferences()

Applies any user preferences previously saved via savePreferences()

initialize

public final EntityTablePanel initialize()

Initializes the UI, while presenting a wait cursor to the user. Note that calling this method more than once has no effect.

Returns:

this EntityTablePanel instance

setupControls

protected void setupControls()

Override to setup any custom controls. This default implementation is empty. This method is called after all standard controls have been initialized.

See Also:

• control(ControlKey)

initializeSouthPanel

protected JPanel initializeSouthPanel()

Initializes the south panel, override and return null for no south panel. Not called if the south panel has been disabled via EntityTablePanel.Config.includeSouthPanel(boolean).

Returns:

the south panel, or null if no south panel should be included

See Also:

• EntityTablePanel.Config.includeSouthPanel(boolean)

setupKeyboardActions

protected void setupKeyboardActions()

Sets up the keyboard shortcuts.

See Also:

• EntityTablePanel.ControlKeys.REFRESH
• EntityTablePanel.ControlKeys.REQUEST_TABLE_FOCUS
• EntityTablePanel.ControlKeys.SELECT_CONDITION
• EntityTablePanel.ControlKeys.TOGGLE_CONDITION_VIEW
• EntityTablePanel.ControlKeys.SELECT_FILTER
• EntityTablePanel.ControlKeys.TOGGLE_FILTER_VIEW
• EntityTablePanel.ControlKeys.PRINT
• EntityTablePanel.ControlKeys.ADD
• EntityTablePanel.ControlKeys.EDIT
• EntityTablePanel.ControlKeys.EDIT_SELECTED_ATTRIBUTE
• EntityTablePanel.ControlKeys.DELETE
• EntityTablePanel.ControlKeys.MOVE_SELECTION_UP
• EntityTablePanel.ControlKeys.MOVE_SELECTION_DOWN
• EntityTablePanel.ControlKeys.DISPLAY_ENTITY_MENU
• EntityTablePanel.ControlKeys.DISPLAY_POPUP_MENU

configureToolBar

protected final void configureToolBar(Consumer<Controls.Layout> toolBarLayout)

Configures the toolbar controls layout.
Note that the Controls.Layout instance has pre-configured defaults, which must be cleared in order to start with an empty configuration.

 
   configureToolBar(layout -> layout.clear()
           .standard(ControlKeys.REFRESH)
           .separator()
           .control(createCustomControl())
           .separator()
           .defaults())
 
 

Defaults:

• ControlKeys#TOGGLE_SUMMARY_PANEL
• ControlKeys#TOGGLE_CONDITION_VIEW
• ControlKeys#TOGGLE_FILTER_VIEW
• Separator
• ControlKeys#ADD (If an EditPanel is available)
• ControlKeys#EDIT (If an EditPanel is available)
• ControlKeys#DELETE
• Separator
• ControlKeys#EDIT_SELECTED_ATTRIBUTE
• Separator
• ControlKeys#PRINT
• Separator
• ControlKeys#ADDITIONAL_TOOLBAR_CONTROLS

Parameters:

toolBarLayout - provides access to the toolbar configuration

See Also:

• Controls.Layout.clear()

configurePopupMenu

protected final void configurePopupMenu(Consumer<Controls.Layout> popupMenuLayout)

Configures the popup menu controls layout.
Note that the Controls.Layout instance has pre-configured defaults, which must be cleared in order to start with an empty configuration.

 
   configurePopupMenu(layout -> layout.clear()
           .standard(ControlKeys.REFRESH)
           .separator()
           .control(createCustomControl())
           .separator()
           .defaults())
 
 

Defaults:

• ControlKeys#REFRESH
• ControlKeys#CLEAR
• Separator
• ControlKeys#ADD (If an EditPanel is available)
• ControlKeys#EDIT (If an EditPanel is available)
• ControlKeys#DELETE
• Separator
• ControlKeys#EDIT_SELECTED_ATTRIBUTE or ControlKeys#EDIT_ATTRIBUTE_CONTROLS
• Separator
• ControlKeys#VIEW_DEPENDENCIES
• Separator
• ControlKeys#ADDITIONAL_POPUP_MENU_CONTROLS
• Separator
• ControlKeys#PRINT_CONTROLS
• Separator
• ControlKeys#COLUMN_CONTROLS
• Separator
• ControlKeys#SELECTION_MODE
• Separator
• ControlKeys#CONDITION_CONTROLS
• Separator
• ControlKeys#FILTER_CONTROLS
• Separator
• ControlKeys#COPY_CONTROLS

Parameters:

popupMenuLayout - provides access to the popup menu layout

See Also:

• Controls.Layout.clear()

editPanel

protected final <T extends EntityEditPanel> T editPanel()

Type Parameters:

T - the edit panel type

Returns:

the edit panel

Throws:

IllegalStateException - in case no edit panel is available

layoutPanel

protected void layoutPanel(JComponent tableComponent,
 JPanel southPanel)

This method simply adds tablePanel at location BorderLayout.CENTER and, if non-null, the given southPanel to the BorderLayout.SOUTH location. By overriding this method you can override the default layout.

Parameters:

tableComponent - the component containing the table, condition and summary panel

southPanel - the south toolbar panel, null if not required

See Also:

• initializeSouthPanel()

onException

protected void onException(Exception exception)

Propagates the exception to onValidationException(ValidationException) or onReferentialIntegrityException(ReferentialIntegrityException) depending on type, otherwise displays the exception.

Parameters:

exception - the exception to handle

See Also:

• displayException(Exception)

onReferentialIntegrityException

protected void onReferentialIntegrityException(ReferentialIntegrityException exception)

Called when a ReferentialIntegrityException occurs during a delete operation on the selected entities. If the referential error handling is ReferentialIntegrityErrorHandling.DISPLAY_DEPENDENCIES, the dependencies of the entities involved are displayed to the user, otherwise displayException(Exception) is called.

Parameters:

exception - the exception

See Also:

• EntityTablePanel.Config.referentialIntegrityErrorHandling(ReferentialIntegrityErrorHandling)

onValidationException

protected void onValidationException(ValidationException exception)

Displays the exception message.

Parameters:

exception - the exception

editDialogBuilder

protected <T>
EntityDialogs.EditAttributeDialogBuilder<T> editDialogBuilder(Attribute<T> attribute)

Override to customize the edit dialog used when multiple entities are edited.

Type Parameters:

T - the attribute type

Parameters:

attribute - the attribute to edit

Returns:

a edit dialog builder

userPreferencesKey

protected String userPreferencesKey()

Returns the key used to identify user preferences for this table panel, that is column positions, widths and such. The default implementation is:

 
 return tableModel().getClass().getSimpleName() + "-" + entityType();
 
 

Override in case this key is not unique within the application.

Returns:

the key used to identify user preferences for this table panel

displayException

protected final void displayException(Exception exception)

Displays the exception in a dialog, with the dialog owner as the current focus owner or this panel if none is available.

Parameters:

exception - the exception to display

confirmDelete

protected final boolean confirmDelete()

Returns:

true if confirmed

See Also:

• EntityTablePanel.Config.deleteConfirmer(Confirmer)