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
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 (FilteredTable) | | | | | | | | | |____________________________________________________| | 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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Specifies how column selection is presented.static final class
Contains configuration settings for aEntityTablePanel
which must be set before the panel is initialized.static enum
The keyboard shortcuts available forEntityTablePanel
s.static enum
Specifies the refresh button visibility.static enum
The standard controls available in a table panelNested 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
ConstructorsConstructorDescriptionEntityTablePanel
(SwingEntityTableModel tableModel) Initializes a new EntityTablePanel instanceEntityTablePanel
(SwingEntityTableModel tableModel, EntityEditPanel editPanel) Initializes a new EntityTablePanel instanceEntityTablePanel
(SwingEntityTableModel tableModel, EntityEditPanel editPanel, Consumer<EntityTablePanel.Config> configuration) Initializes a new EntityTablePanel instanceEntityTablePanel
(SwingEntityTableModel tableModel, Consumer<EntityTablePanel.Config> configuration) Initializes a new EntityTablePanel instance -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPopupMenuControls
(Controls additionalPopupMenuControls) void
addToolBarControls
(Controls additionalToolBarControls) final FilteredTableConditionPanel<Attribute<?>>
final State
protected final boolean
control
(EntityTablePanel.TableControl tableControl) protected Controls
createPopupMenuControls
(List<Controls> additionalPopupMenuControls) Creates a Controls instance containing the controls to include in the table popup menu.protected Controls
By default this method returns aControls
instance containing theControl
associated withEntityTablePanel.TableControl.PRINT
.protected TableCellEditor
createTableCellEditor
(Attribute<?> attribute) Creates a TableCellEditor for the given attribute, returns null if no editor is available, such as for non-editable attributes.protected TableCellRenderer
createTableCellRenderer
(Attribute<?> attribute) Creates a TableCellRenderer to use for the given attribute in this EntityTablePanelprotected JToolBar
Creates the table toolbar, by default based oncreateToolBarControls(List)
protected Controls
createToolBarControls
(List<Controls> additionalToolBarControls) final boolean
Deletes the entities selected in the underlying table model without asking for confirmation.final boolean
Deletes the entities selected in the underlying table model after asking for confirmation using the confirmer specified viaEntityTablePanel.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.final <T> void
editSelected
(Attribute<T> attributeToEdit) Retrieves a new value via input dialog and performs an update on the selected entities assigning the value to the attributefinal State
final EntityTablePanel
Initializes the UI, while presenting a wait cursor to the user.protected JPanel
Initializes the south panel, override and return null for no south panel.protected void
layoutPanel
(JComponent tableComponent, JPanel southPanel) This method simply addstablePanel
at location BorderLayout.CENTER and, if non-null, the givensouthPanel
to theBorderLayout.SOUTH
location.protected void
onException
(Exception exception) Propagates the exception toonValidationException(ValidationException)
oronReferentialIntegrityException(ReferentialIntegrityException)
depending on type, otherwise displays the exception.protected void
Called when aReferentialIntegrityException
occurs during a delete operation on the selected entities.protected void
onValidationException
(ValidationException exception) Displays the exception message.final void
Allows the user to select one of the available search condition panelsfinal void
Allows the user to select one of the available filter condition panelsprotected void
Override to setup any custom controls.protected void
final State
final FilteredTable<Entity,
Attribute<?>> table()
final <T extends SwingEntityTableModel>
Tfinal void
Toggles the condition panel through the states hidden, visible and advancedfinal void
Toggles the filter panel through the states hidden, visible and advancedfinal String
toString()
final void
Displays a dialog containing tables of entities depending on the selected entities via non-soft foreign keysMethods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
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
-
Constructor Details
-
EntityTablePanel
Initializes a new EntityTablePanel instance- Parameters:
tableModel
- the SwingEntityTableModel instance
-
EntityTablePanel
public EntityTablePanel(SwingEntityTableModel tableModel, Consumer<EntityTablePanel.Config> configuration) Initializes a new EntityTablePanel instance- Parameters:
tableModel
- the SwingEntityTableModel instanceconfiguration
- provides access to the table panel configuration
-
EntityTablePanel
Initializes a new EntityTablePanel instance- Parameters:
tableModel
- the SwingEntityTableModel instanceeditPanel
- the edit panel
-
EntityTablePanel
public EntityTablePanel(SwingEntityTableModel tableModel, EntityEditPanel editPanel, Consumer<EntityTablePanel.Config> configuration) Initializes a new EntityTablePanel instance- Parameters:
tableModel
- the SwingEntityTableModel instanceeditPanel
- the edit panelconfiguration
- provides access to the table panel configuration
-
-
Method Details
-
table
- Returns:
- the table
-
tableModel
- Type Parameters:
T
- the table model type- Returns:
- the EntityTableModel used by this EntityTablePanel
-
conditionPanel
- Returns:
- the condition panel
- Throws:
IllegalStateException
- in case no condition panel is available
-
conditionPanelVisible
- Returns:
- the state controlling whether the condition panel is visible
-
filterPanelVisible
- Returns:
- the state controlling whether the filter panel is visible
-
summaryPanelVisible
- Returns:
- the state controlling whether the summary panel is visible
-
toggleConditionPanel
public final void toggleConditionPanel()Toggles the condition panel through the states hidden, visible and advanced -
toggleFilterPanel
public final void toggleFilterPanel()Toggles the filter panel through the states hidden, visible and advanced -
selectConditionPanel
public final void selectConditionPanel()Allows the user to select one of the available search condition panels -
selectFilterPanel
public final void selectFilterPanel()Allows the user to select one of the available filter condition panels -
addPopupMenuControls
- Parameters:
additionalPopupMenuControls
- a set of controls to add to the table popup menu- Throws:
IllegalStateException
- in case this panel has already been initialized
-
addToolBarControls
- Parameters:
additionalToolBarControls
- a set of controls to add to the table toolbar menu- Throws:
IllegalStateException
- in case this panel has already been initialized
-
toString
-
control
Returns aValue
containing the control associated withcontrolCode
, an emptyValue
if no such control is available. Note that standard controls are populated during initialization, so until then, these values may be empty.- Parameters:
tableControl
- the table control code- Returns:
- the
Value
containing the control associated withcontrolCode
-
editSelected
Retrieves a new value via input dialog and performs an update on the selected entities assigning the value to the attribute- Type Parameters:
T
- the attribute value type- Parameters:
attributeToEdit
- the attribute which value to edit- See Also:
-
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 viaEntityTablePanel.Config.deleteConfirmer(Confirmer)
- Returns:
- true if the delete operation was successful
- See Also:
-
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
-
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:
-
initializeSouthPanel
Initializes the south panel, override and return null for no south panel. Not called if the south panel has been disabled viaEntityTablePanel.Config.includeSouthPanel(boolean)
.- Returns:
- the south panel, or null if no south panel should be included
- See Also:
-
setupKeyboardActions
protected void setupKeyboardActions() -
createToolBarControls
-
createPopupMenuControls
Creates a Controls instance containing the controls to include in the table popup menu. Returning null or an empty Controls instance indicates that no popup menu should be included.- Parameters:
additionalPopupMenuControls
- any additional controls to include in the popup menu- Returns:
- Controls on which to base the table popup menu, null or an empty Controls instance if no popup menu should be included
-
createPrintMenuControls
By default this method returns aControls
instance containing theControl
associated withEntityTablePanel.TableControl.PRINT
. If noControl
has been assigned to that control key, an emptyControls
instance is returned. Override to add print actions, which will then appear in the table popup menu.- Returns:
- the print controls to display in the table popup menu
-
createTableCellRenderer
Creates a TableCellRenderer to use for the given attribute in this EntityTablePanel- Parameters:
attribute
- the attribute- Returns:
- the TableCellRenderer for the given attribute
-
createTableCellEditor
Creates a TableCellEditor for the given attribute, returns null if no editor is available, such as for non-editable attributes.- Parameters:
attribute
- the attribute- Returns:
- a TableCellEditor for the given attribute, null in case none is available
- See Also:
-
layoutPanel
This method simply addstablePanel
at location BorderLayout.CENTER and, if non-null, the givensouthPanel
to theBorderLayout.SOUTH
location. By overriding this method you can override the default layout.- Parameters:
tableComponent
- the component containing the table, condition and summary panelsouthPanel
- the south toolbar panel, null if not required- See Also:
-
createToolBar
Creates the table toolbar, by default based oncreateToolBarControls(List)
- Returns:
- the toolbar, null if none should be included
-
onException
Propagates the exception toonValidationException(ValidationException)
oronReferentialIntegrityException(ReferentialIntegrityException)
depending on type, otherwise displays the exception.- Parameters:
exception
- the exception to handle- See Also:
-
onReferentialIntegrityException
Called when aReferentialIntegrityException
occurs during a delete operation on the selected entities. If the referential error handling isReferentialIntegrityErrorHandling.DISPLAY_DEPENDENCIES
, the dependencies of the entities involved are displayed to the user, otherwiseonException(Exception)
is called.- Parameters:
exception
- the exception- See Also:
-
onValidationException
Displays the exception message.- Parameters:
exception
- the exception
-
editDialogBuilder
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
-
displayException
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:
-