Module is.codion.swing.framework.ui
Package is.codion.swing.framework.ui

Class EntityTablePanel.Settings

java.lang.Object
is.codion.swing.framework.ui.EntityTablePanel.Settings
Enclosing class:
EntityTablePanel
public final class EntityTablePanel.Settings extends Object
Contains configuration settings for a EntityTablePanel which must be set before the panel is initialized.

  • Method Details

    • includeSouthPanel

      public EntityTablePanel.Settings includeSouthPanel(boolean includeSouthPanel)
      Parameters:
      includeSouthPanel - true if the south panel should be included
      Returns:
      this Settings instance
      Throws:
      IllegalStateException - in case the panel has already been initialized

    • includeConditionPanel

      public EntityTablePanel.Settings includeConditionPanel(boolean includeConditionPanel)
      Parameters:
      includeConditionPanel - true if the condition panel should be included
      Returns:
      this Settings instance
      Throws:
      IllegalStateException - in case the panel has already been initialized

    • includeFilterPanel

      public EntityTablePanel.Settings includeFilterPanel(boolean includeFilterPanel)
      Parameters:
      includeFilterPanel - true if the filter panel should be included
      Returns:
      this Settings instance
      Throws:
      IllegalStateException - in case the panel has already been initialized

    • includePopupMenu

      public EntityTablePanel.Settings includePopupMenu(boolean includePopupMenu)
      Parameters:
      includePopupMenu - true if a popup menu should be included
      Returns:
      this Settings instance
      Throws:
      IllegalStateException - in case the panel has already been initialized

    • includeClearControl

      public EntityTablePanel.Settings includeClearControl(boolean includeClearControl)
      Parameters:
      includeClearControl - true if a 'Clear' control should be included in the popup menu
      Returns:
      this Settings instance
      Throws:
      IllegalStateException - in case the panel has already been initialized

    • includeLimitMenu

      public EntityTablePanel.Settings includeLimitMenu(boolean includeLimitMenu)
      Parameters:
      includeLimitMenu - true if a popup menu for configuring the table model limit should be included
      Returns:
      this Settings instance
      Throws:
      IllegalStateException - in case the panel has already been initialized

    • includeSelectionModeControl

      public EntityTablePanel.Settings includeSelectionModeControl(boolean includeSelectionModeControl)
      Parameters:
      includeSelectionModeControl - true if a 'Single Selection' control should be included in the popup menu
      Returns:
      this Settings instance
      Throws:
      IllegalStateException - in case the panel has already been initialized

    • columnSelection

      public EntityTablePanel.Settings columnSelection(EntityTablePanel.ColumnSelection columnSelection)
      Parameters:
      columnSelection - specifies how columns are selected
      Returns:
      this Settings instance
      Throws:
      IllegalStateException - in case the panel has already been initialized

    • addPopupMenuControls

      public EntityTablePanel.Settings addPopupMenuControls(Controls additionalPopupMenuControls)
      Parameters:
      additionalPopupMenuControls - a set of controls to add to the table popup menu
      Returns:
      this Settings instance
      Throws:
      IllegalStateException - in case the panel has already been initialized

    • addToolBarControls

      public EntityTablePanel.Settings addToolBarControls(Controls additionalToolBarControls)
      Parameters:
      additionalToolBarControls - a set of controls to add to the table toolbar menu
      Returns:
      this Settings instance
      Throws:
      IllegalStateException - in case the panel has already been initialized

    • keyStroke

      public Value<KeyStroke> keyStroke(EntityTablePanel.KeyboardShortcut shortcut)
      Parameters:
      shortcut - the keyboard shortcut key
      Returns:
      the Value controlling the keyStroke for the given keyboard shortcut key

    • editableAttributes

      public ValueSet<Attribute<?>> editableAttributes()
      Specifies the attributes that should be editable in this table panel, such as via the edit selected entities menu.
      Returns:
      the attributes that should be editable via this table panel