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 (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:

  • Field Details

    • CONDITION_PANEL_VISIBLE

      public static final is.codion.common.property.PropertyValue<Boolean> CONDITION_PANEL_VISIBLE
      Specifies whether table condition panels should be visible or not by default
      Value type: Boolean
      Default value: false

    • FILTER_PANEL_VISIBLE

      public static final is.codion.common.property.PropertyValue<Boolean> FILTER_PANEL_VISIBLE
      Specifies whether table filter panels should be visible or not by default
      Value type: Boolean
      Default value: false

    • INCLUDE_ENTITY_MENU

      public static final is.codion.common.property.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 is.codion.common.property.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 is.codion.common.property.PropertyValue<Boolean> INCLUDE_CONDITION_PANEL
      Specifies whether to include a condition panel.
      Value type: Boolean
      Default value: true

    • INCLUDE_FILTER_PANEL

      public static final is.codion.common.property.PropertyValue<Boolean> INCLUDE_FILTER_PANEL
      Specifies whether to include a filter panel.
      Value type: Boolean
      Default value: true

    • SHOW_REFRESH_PROGRESS_BAR

      public static final is.codion.common.property.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 is.codion.common.property.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 is.codion.common.property.PropertyValue<EntityTablePanel.ColumnSelection> COLUMN_SELECTION
      Specifies how column selection is presented to the user.
      Value type: EntityTablePanel.ColumnSelection
      Default value: EntityTablePanel.ColumnSelection.DIALOG

  • Constructor Details

    • EntityTablePanel

      public EntityTablePanel(is.codion.swing.framework.model.SwingEntityTableModel tableModel)
      Initializes a new EntityTablePanel instance
      Parameters:
      tableModel - the SwingEntityTableModel instance

    • EntityTablePanel

      public EntityTablePanel(is.codion.swing.framework.model.SwingEntityTableModel tableModel, EntityConditionPanelFactory conditionPanelFactory)
      Initializes a new EntityTablePanel instance
      Parameters:
      tableModel - the SwingEntityTableModel instance
      conditionPanelFactory - the condition panel factory, if any

  • Method Details

    • updateUI

      public void updateUI()
      Overrides:
      updateUI in class JPanel

    • table

      public final is.codion.swing.common.ui.component.table.FilteredTable<is.codion.framework.domain.entity.Entity,is.codion.framework.domain.entity.attribute.Attribute<?>> table()
      Returns:
      the table

    • tableModel

      public final <T extends is.codion.swing.framework.model.SwingEntityTableModel> T tableModel()
      Type Parameters:
      T - the table model type
      Returns:
      the EntityTableModel used by this EntityTablePanel

    • conditionPanel

      public final is.codion.swing.common.ui.component.table.FilteredTableConditionPanel<is.codion.framework.domain.entity.attribute.Attribute<?>> conditionPanel()
      Returns:
      the condition panel
      Throws:
      IllegalStateException - in case no condition panel is available

    • editableAttributes

      public final is.codion.common.value.ValueSet<is.codion.framework.domain.entity.attribute.Attribute<?>> editableAttributes()
      Specifies the attributes that should be editable in this table panel, such as via the edit selected entities menu. Modifying this ValueSet after the panel has been initialized will result in a IllegalStateException being thrown
      Returns:
      the attributes that should be editable via this table panel

    • addPopupMenuControls

      public final void addPopupMenuControls(is.codion.swing.common.ui.control.Controls additionalPopupMenuControls)
      Parameters:
      additionalPopupMenuControls - a set of controls to add to the table popup menu
      Throws:
      IllegalStateException - in case the panel has already been initialized
      See Also:

    • addToolBarControls

      public final void addToolBarControls(is.codion.swing.common.ui.control.Controls additionalToolBarControls)
      Parameters:
      additionalToolBarControls - a set of controls to add to the table toolbar menu
      Throws:
      IllegalStateException - in case the panel has already been initialized
      See Also:

    • setIncludeSouthPanel

      public final void setIncludeSouthPanel(boolean includeSouthPanel)
      Parameters:
      includeSouthPanel - true if the south panel should be included
      Throws:
      IllegalStateException - in case the panel has already been initialized
      See Also:

    • setIncludeConditionPanel

      public final void setIncludeConditionPanel(boolean includeConditionPanel)
      Parameters:
      includeConditionPanel - true if the condition panel should be included
      Throws:
      IllegalStateException - in case the panel has already been initialized
      See Also:

    • setIncludeFilterPanel

      public final void setIncludeFilterPanel(boolean includeFilterPanel)
      Parameters:
      includeFilterPanel - true if the filter panel should be included
      Throws:
      IllegalStateException - in case the panel has already been initialized
      See Also:

    • setIncludePopupMenu

      public final void setIncludePopupMenu(boolean includePopupMenu)
      Parameters:
      includePopupMenu - true if a popup menu should be included
      Throws:
      IllegalStateException - in case the panel has already been initialized
      See Also:

    • setIncludeClearControl

      public final void setIncludeClearControl(boolean includeClearControl)
      Parameters:
      includeClearControl - true if a 'Clear' control should be included in the popup menu
      Throws:
      IllegalStateException - in case the panel has already been initialized
      See Also:

    • setIncludeSelectionModeControl

      public final void setIncludeSelectionModeControl(boolean includeSelectionModeControl)
      Parameters:
      includeSelectionModeControl - true if a 'Single Selection' control should be included in the popup menu
      Throws:
      IllegalStateException - in case the panel has already been initialized
      See Also:

    • setColumnSelection

      public final void setColumnSelection(EntityTablePanel.ColumnSelection columnSelection)
      Parameters:
      columnSelection - specifies how columns are selected

    • getRefreshButtonVisible

      public final EntityTablePanel.RefreshButtonVisible getRefreshButtonVisible()
      Returns:
      the refresh button visible setting

    • setRefreshButtonVisible

      public final void setRefreshButtonVisible(EntityTablePanel.RefreshButtonVisible refreshButtonVisible)
      Parameters:
      refreshButtonVisible - the refresh button visible setting

    • conditionPanelVisible

      public final is.codion.common.state.State conditionPanelVisible()
      Returns:
      the state controlling whether the condition panel is visible

    • filterPanelVisible

      public final is.codion.common.state.State filterPanelVisible()
      Returns:
      the state controlling whether the filter panel is visible

    • summaryPanelVisible

      public final is.codion.common.state.State summaryPanelVisible()
      Returns:
      the state controlling whether the summary panel is visible

    • showRefreshProgressBar

      public final is.codion.common.state.State showRefreshProgressBar()
      Returns:
      the state controlling whether an indeterminate progress bar should be shown while the model is refreshing
      See Also:

    • statusMessage

      public final is.codion.common.value.Value<Function<is.codion.swing.framework.model.SwingEntityTableModel,String>> statusMessage()
      Returns:
      the value containing the function for creating the table status message
      See Also:

    • setEditComponentFactory

      public final <T, A extends is.codion.framework.domain.entity.attribute.Attribute<T>, C extends JComponent> void setEditComponentFactory(A attribute, EntityComponentFactory<T,A,C> componentFactory)
      Sets the component factory for the given attribute, used when editing entities via editSelectedEntities(Attribute).
      Type Parameters:
      T - the value type
      A - the attribute type
      C - the component type
      Parameters:
      attribute - the attribute
      componentFactory - the component factory

    • setTableCellEditorFactory

      public final <T, A extends is.codion.framework.domain.entity.attribute.Attribute<T>, C extends JComponent> void setTableCellEditorFactory(A attribute, EntityComponentFactory<T,A,C> componentFactory)
      Sets the table cell editor component factory for the given attribute.
      Type Parameters:
      T - the value type
      A - the attribute type
      C - the component type
      Parameters:
      attribute - the attribute
      componentFactory - the component factory

    • 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

    • setReferentialIntegrityErrorHandling

      public final void setReferentialIntegrityErrorHandling(ReferentialIntegrityErrorHandling referentialIntegrityErrorHandling)
      Parameters:
      referentialIntegrityErrorHandling - the action to take on a referential integrity error during delete

    • setDeleteConfirmer

      public final void setDeleteConfirmer(EntityEditPanel.Confirmer deleteConfirmer)
      Parameters:
      deleteConfirmer - the delete confirmer, null for the default one

    • toString

      public final String toString()
      Overrides:
      toString in class Component

    • control

      public final Optional<is.codion.swing.common.ui.control.Control> control(EntityTablePanel.ControlCode controlCode)
      Parameters:
      controlCode - the control code
      Returns:
      the control associated with controlCode or an empty Optional if no control is available

    • editSelectedEntities

      public final <T> void editSelectedEntities(is.codion.framework.domain.entity.attribute.Attribute<T> attributeToEdit)
      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

    • deleteWithConfirmation

      public final boolean deleteWithConfirmation()
      Deletes the entities selected in the underlying table model after asking for confirmation using the EntityEditPanel.Confirmer set via setDeleteConfirmer(Confirmer).
      Returns:
      true if the delete operation was successful
      See Also:

    • delete

      public final boolean delete()
      Deletes the entities selected in the underlying table model without asking for confirmation.
      Returns:
      true if the delete operation was successful
      See Also:

    • printTable

      public final void printTable() throws PrinterException
      Prints the table
      Throws:
      PrinterException - in case of a print exception
      See Also:

    • 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

    • 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 setIncludeSouthPanel(boolean).
      Returns:
      the south panel, or null if no south panel should be included

    • setupKeyboardActions

      protected void setupKeyboardActions()
      Sets up the default keyboard actions.

    • setControl

      protected final void setControl(EntityTablePanel.ControlCode controlCode, is.codion.swing.common.ui.control.Control control)
      Associates control with controlCode
      Parameters:
      controlCode - the control code
      control - the control to associate with controlCode, null for none
      Throws:
      IllegalStateException - in case the panel has already been initialized

    • createToolBarControls

      protected is.codion.swing.common.ui.control.Controls createToolBarControls(List<is.codion.swing.common.ui.control.Controls> additionalToolBarControls)

    • createPopupMenuControls

      protected is.codion.swing.common.ui.control.Controls createPopupMenuControls(List<is.codion.swing.common.ui.control.Controls> additionalPopupMenuControls)
      Creates a Controls instance containing the controls to include in the table popup menu. Returns null or an empty Controls instance to indicate 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

      protected is.codion.swing.common.ui.control.Controls createPrintMenuControls()
      By default this method returns a Controls instance containing the Control associated with EntityTablePanel.ControlCode.PRINT. If no Control has been assigned to that control key, an empty Controls 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

      protected TableCellRenderer createTableCellRenderer(is.codion.framework.domain.entity.attribute.Attribute<?> attribute)
      Creates a TableCellRenderer to use for the given attribute in this EntityTablePanel
      Parameters:
      attribute - the attribute
      Returns:
      the TableCellRenderer for the given attribute

    • createTableCellEditor

      protected TableCellEditor createTableCellEditor(is.codion.framework.domain.entity.attribute.Attribute<?> attribute)
      Creates a TableCellEditor for the given attribute, returns null if no editor is available, such as for non-updatable attributes.
      Parameters:
      attribute - the attribute
      Returns:
      a TableCellEditor for the given attribute, null in case none 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:

    • createSouthToolBar

      protected JToolBar createSouthToolBar()
      Creates the south panel toolbar, by default based on createToolBarControls(List)
      Returns:
      the toolbar to add to the south panel, null if none should be included

    • beforeDelete

      protected void beforeDelete()
      Called before delete is performed on the selected entities. To cancel the delete throw a CancelException.

    • onReferentialIntegrityException

      protected void onReferentialIntegrityException(is.codion.common.db.exception.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 onException(Throwable) is called.
      Parameters:
      exception - the exception
      See Also:

    • onValidationException

      protected void onValidationException(is.codion.framework.domain.entity.exception.ValidationException exception)
      Displays the exception message.
      Parameters:
      exception - the exception

    • onException

      protected void onException(Throwable exception)
      Handles the given exception, simply displays the error message to the user by default.
      Parameters:
      exception - the exception to handle
      See Also:

    • displayException

      protected final void displayException(Throwable 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