EntityTablePanel (JMinor Framework API 0.12.5-SNAPSHOT)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - org.jminor.swing.common.ui.table.FilteredTablePanel<Entity,Property>
        
        org.jminor.swing.framework.ui.EntityTablePanel

All Implemented Interfaces:: java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, DialogExceptionHandler

public class EntityTablePanel
extends FilteredTablePanel<Entity,Property>
implements DialogExceptionHandler

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

  ____________________________________________________
 |                searchPanel                         |
 |____________________________________________________|
 |                                                    |
 |                                                    |
 |                                                    |
 |                                                    |
 |                entityTable (JTable)                |
 |                                                    |
 |                                                    |
 |                                                    |
 |                                                    |
 |____________________________________________________|
 |                summaryPanel                        |
 |____________________________________________________|
 |                southPanel                          |
 |____________________________________________________|

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

See Also:: EntityTableModel, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EntityTablePanel.ReferentialIntegrityErrorHandling
The possible actions to take on a referential integrity error
- Nested classes/interfaces inherited from class org.jminor.swing.common.ui.table.FilteredTablePanel
  FilteredTablePanel.ColumnConditionPanelProvider<C>
- Nested classes/interfaces inherited from class javax.swing.JPanel
  javax.swing.JPanel.AccessibleJPanel
- Nested classes/interfaces inherited from class javax.swing.JComponent
  javax.swing.JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  java.awt.Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Nested Classes
Modifier and Type	Class and Description
`static class`	`EntityTablePanel.ReferentialIntegrityErrorHandling` The possible actions to take on a referential integrity error

Field Summary

Fields
Modifier and Type	Field and Description
`static PropertyValue<java.lang.Boolean>`	`ALLOW_COLUMN_REORDERING` Specifies whether or not columns can be rearranged in tables Value type: Boolean Default value: true
`static java.lang.String`	`CLEAR`
`static java.lang.String`	`CLEAR_SELECTION`
`static java.lang.String`	`CONDITION_PANEL_VISIBLE`
`static java.lang.String`	`COPY_TABLE_DATA`
`static java.lang.String`	`DELETE_SELECTED`
`static java.lang.String`	`EXPORT_JSON`
`static java.lang.String`	`MOVE_SELECTION_DOWN`
`static java.lang.String`	`MOVE_SELECTION_UP`
`static java.lang.String`	`PRINT_TABLE`
`static PropertyValue<EntityTablePanel.ReferentialIntegrityErrorHandling>`	`REFERENTIAL_INTEGRITY_ERROR_HANDLING` Specifies whether to display the error message or the dependent entities in case of a referential integrity error on delete Value type: `EntityTablePanel.ReferentialIntegrityErrorHandling` Default value: `EntityTablePanel.ReferentialIntegrityErrorHandling.ERROR`
`static java.lang.String`	`REFRESH`
`static java.lang.String`	`SELECT_COLUMNS`
`static PropertyValue<java.lang.Integer>`	`TABLE_AUTO_RESIZE_MODE` Specifies the default table column resize mode for tables in the application Value type: Integer (JTable.AUTO_RESIZE_*) Default value: JTable.AUTO_RESIZE_OFF
`static PropertyValue<java.lang.Boolean>`	`TABLE_CONDITION_PANEL_VISIBLE` Specifies whether the table condition panels should be visible or not by default Value type: Boolean Default value: false
`static java.lang.String`	`TOGGLE_CONDITION_PANEL`
`static java.lang.String`	`TOGGLE_SUMMARY_PANEL`
`static java.lang.String`	`UPDATE_SELECTED`
`static java.lang.String`	`VIEW_DEPENDENCIES`

Fields inherited from class org.jminor.swing.common.ui.table.FilteredTablePanel
FILTER_INDICATOR

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 and Description
`EntityTablePanel(javax.swing.JTable table, EntityTableConditionPanel conditionPanel)` Initializes a new EntityTablePanel instance.
`EntityTablePanel(SwingEntityTableModel tableModel)` Initializes a new EntityTablePanel instance
`EntityTablePanel(SwingEntityTableModel tableModel, EntityTableConditionPanel conditionPanel)` Initializes a new EntityTablePanel instance

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConditionPanelVisibleListener(EventListener listener)`
`void`	`addPopupControls(ControlSet additionalPopupControls)`
`void`	`addTableDoubleClickListener(EventListener listener)`
`void`	`addToolbarControls(ControlSet additionalToolbarControls)`
`protected boolean`	`confirmDelete()` Called before a delete is performed, if true is returned the delete action is performed otherwise it is canceled
`protected InputProvider`	`createEntityInputProvider(ForeignKeyProperty foreignKeyProperty, Entity currentValue, EntityEditModel editModel)` Creates a InputProvider for the given foreign key property
`static EntityTablePanel`	`createEntityTablePanel(java.util.Collection<Entity> entities, EntityConnectionProvider connectionProvider)` Creates a static entity table panel showing the given entities, note that this table panel will provide a popup menu for updating and deleting the selected entities unless the underlying entities are read-only.
`static EntityTablePanel`	`createEntityTablePanel(SwingEntityTableModel tableModel)` Creates a entity table panel based on the given table model.
`static EntityTablePanel`	`createStaticEntityTablePanel(java.util.Collection<Entity> entities, EntityConnectionProvider connectionProvider)` Creates a static read-only entity table panel showing the given entities
`void`	`delete()` Deletes the entities selected in the underlying table model
`void`	`displayException(java.lang.Throwable throwable, java.awt.Window dialogParent)` Handle the given exception and display it to the user.
`void`	`exportSelected()` Exports the selected records as a text file using the available serializer
`Control`	`getClearControl()`
`Control`	`getClearSelectionControl()`
`EntityTableConditionPanel`	`getConditionPanel()`
`protected Control`	`getConditionPanelControl()`
`protected java.lang.String[]`	`getConfirmDeleteMessages()`
`Control`	`getControl(java.lang.String controlCode)`
`protected Control`	`getCopyCellControl()`
`protected ControlSet`	`getCopyControlSet()`
`protected Control`	`getCopyTableWithHeaderControl()`
`Control`	`getDeleteSelectedControl()`
`SwingEntityTableModel`	`getEntityTableModel()`
`Control`	`getExportControl()`
`protected InputProvider`	`getInputProvider(Property property, java.util.List<Entity> toUpdate)` Provides value input components for multiple entity update, override to supply specific InputValueProvider implementations for properties.
`Control`	`getMoveSelectionDownControl()`
`Control`	`getMoveSelectionUpControl()`
`protected ControlSet`	`getPopupControls(java.util.List<ControlSet> additionalPopupControlSets)` Constructs a ControlSet containing the controls to include in the table popup menu.
`protected ControlSet`	`getPrintControls()`
`Control`	`getPrintTableControl()`
`Control`	`getRefreshControl()`
`javax.swing.Action`	`getTableDoubleClickAction()`
`Control`	`getToggleConditionPanelControl()` Initializes the button used to toggle the condition panel state (hidden, visible and advanced)
`protected ControlSet`	`getToolbarControls(java.util.List<ControlSet> additionalToolbarControlSets)`
`ControlSet`	`getUpdateSelectedControlSet()` Creates a `ControlSet` containing controls for updating the value of a single property for the selected entities.
`Control`	`getViewDependenciesControl()`
`Control`	`getViewImageControl(java.lang.String imagePathPropertyId)` Creates a Control for viewing an image based on the entity selected in this EntityTablePanel.
`protected void`	`handleException(DatabaseException exception)` Handles DatabaseExceptions By default displays the exception message to the user.
`void`	`handleException(java.lang.Throwable throwable)` Handles the given exception, which usually means simply displaying it to the user
`protected void`	`handleException(ValidationException exception)` Handles ValidationExceptions.
`protected boolean`	`includeUpdateSelectedProperty(Property property)` Override to exclude properties from the update selected menu.
`EntityTablePanel`	`initializePanel()` Initializes the UI, while presenting a wait cursor to the user.
`protected javax.swing.JPanel`	`initializeSouthPanel()` Initializes the south panel, override and return null for no south panel.
`protected javax.swing.table.TableCellRenderer`	`initializeTableCellRenderer(Property property)` Returns the TableCellRenderer used for the given property in this EntityTablePanel
`protected java.awt.event.MouseListener`	`initializeTableMouseListener()` Initialize the MouseListener for the table component handling double click and right click, or popup click with ALT down.
`protected javax.swing.JToolBar`	`initializeToolbar()` Initializes the south panel toolbar, by default based on `getToolbarControls()`
`boolean`	`isConditionPanelVisible()`
`protected void`	`layoutPanel(javax.swing.JPanel southPanel)` This method simply adds the given `southPanel` to the `BorderLayout.SOUTH` location, assuming the `basePanel` is at location BorderLayout.CENTER.
`void`	`printTable()` Prints the table
`void`	`removeConditionPanelVisibleListener(EventListener listener)`
`void`	`removeTableDoubleClickListener(EventListener listener)`
`void`	`selectConditionPanel()` Allows the user to select on of the available search condition fields
`static java.util.Collection<Entity>`	`selectEntities(SwingEntityTableModel lookupModel, java.awt.Container dialogOwner, boolean singleSelection, java.lang.String dialogTitle)` Displays a entity table in a dialog for selecting one or more entities
`static java.util.Collection<Entity>`	`selectEntities(SwingEntityTableModel lookupModel, java.awt.Container dialogOwner, boolean singleSelection, java.lang.String dialogTitle, java.awt.Dimension preferredSize)` Displays a entity table in a dialog for selecting one or more entities
`void`	`setConditionPanelVisible(boolean visible)` Hides or shows the column condition panel for this EntityTablePanel
`protected void`	`setControl(java.lang.String controlCode, Control control)` Associates `control` with `controlCode`
`void`	`setIncludeConditionPanel(boolean value)`
`void`	`setIncludePopupMenu(boolean value)`
`void`	`setIncludeSouthPanel(boolean value)`
`void`	`setReferentialIntegrityErrorHandling(EntityTablePanel.ReferentialIntegrityErrorHandling referentialIntegrityErrorHandling)`
`void`	`setTableDoubleClickAction(javax.swing.Action doubleClickAction)`
`protected void`	`setTablePopupMenu(javax.swing.JTable table, ControlSet popupControls)` Adds a popup menu to `table`, null or an empty ControlSet mean no popup menu
`static void`	`showDependenciesDialog(java.util.Collection<Entity> entities, EntityConnectionProvider connectionProvider, javax.swing.JComponent dialogParent)` Displays a dialog with the entities depending on the given entities.
`void`	`toggleConditionPanel()` Toggles the condition panel through the states hidden, visible and in case it is a EntityTableConditionPanel, advanced
`java.lang.String`	`toString()`
`void`	`updateSelectedEntities(Property propertyToUpdate)` Retrieves a new property value via input dialog and performs an update on the selected entities
`protected void`	`viewImage(java.lang.String imagePath)` Displays the given image
`void`	`viewSelectionDependencies()` Shows a dialog containing lists of entities depending on the selected entities via foreign key

Methods inherited from class org.jminor.swing.common.ui.table.FilteredTablePanel
addSummaryPanelVisibleListener, getBasePanel, getJTable, getSearchField, getSelectColumnsControl, getTableModel, getTableScrollPane, getToggleSummaryPanelControl, isCellVisible, isScrollToSelectedItem, isSortingEnabled, isSummaryPanelVisible, removeSummaryPanelVisibleListener, scrollToColumn, scrollToCoordinate, selectTableColumns, setFilterPanelsVisible, setScrollToSelectedItem, setSortingEnabled, setSummaryPanelVisible

Methods 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

- Field Detail
  - ALLOW_COLUMN_REORDERING
```
public static final PropertyValue<java.lang.Boolean> ALLOW_COLUMN_REORDERING
```
    Specifies whether or not columns can be rearranged in tables
    Value type: Boolean
    Default value: true
  - TABLE_CONDITION_PANEL_VISIBLE
```
public static final PropertyValue<java.lang.Boolean> TABLE_CONDITION_PANEL_VISIBLE
```
    Specifies whether the table condition panels should be visible or not by default
    Value type: Boolean
    Default value: false
  - TABLE_AUTO_RESIZE_MODE
```
public static final PropertyValue<java.lang.Integer> TABLE_AUTO_RESIZE_MODE
```
    Specifies the default table column resize mode for tables in the application
    Value type: Integer (JTable.AUTO_RESIZE_*)
    Default value: JTable.AUTO_RESIZE_OFF
  - REFERENTIAL_INTEGRITY_ERROR_HANDLING
```
public static final PropertyValue<EntityTablePanel.ReferentialIntegrityErrorHandling> REFERENTIAL_INTEGRITY_ERROR_HANDLING
```
    Specifies whether to display the error message or the dependent entities in case of a referential integrity error on delete
    Value type: EntityTablePanel.ReferentialIntegrityErrorHandling
    Default value: EntityTablePanel.ReferentialIntegrityErrorHandling.ERROR
  - PRINT_TABLE
```
public static final java.lang.String PRINT_TABLE
```
    See Also:
    
    Constant Field Values
  - DELETE_SELECTED
```
public static final java.lang.String DELETE_SELECTED
```
    See Also:
    
    Constant Field Values
  - VIEW_DEPENDENCIES
```
public static final java.lang.String VIEW_DEPENDENCIES
```
    See Also:
    
    Constant Field Values
  - UPDATE_SELECTED
```
public static final java.lang.String UPDATE_SELECTED
```
    See Also:
    
    Constant Field Values
  - SELECT_COLUMNS
```
public static final java.lang.String SELECT_COLUMNS
```
    See Also:
    
    Constant Field Values
  - EXPORT_JSON
```
public static final java.lang.String EXPORT_JSON
```
    See Also:
    
    Constant Field Values
  - CLEAR
```
public static final java.lang.String CLEAR
```
    See Also:
    
    Constant Field Values
  - REFRESH
```
public static final java.lang.String REFRESH
```
    See Also:
    
    Constant Field Values
  - TOGGLE_SUMMARY_PANEL
```
public static final java.lang.String TOGGLE_SUMMARY_PANEL
```
    See Also:
    
    Constant Field Values
  - TOGGLE_CONDITION_PANEL
```
public static final java.lang.String TOGGLE_CONDITION_PANEL
```
    See Also:
    
    Constant Field Values
  - CONDITION_PANEL_VISIBLE
```
public static final java.lang.String CONDITION_PANEL_VISIBLE
```
    See Also:
    
    Constant Field Values
  - CLEAR_SELECTION
```
public static final java.lang.String CLEAR_SELECTION
```
    See Also:
    
    Constant Field Values
  - MOVE_SELECTION_UP
```
public static final java.lang.String MOVE_SELECTION_UP
```
    See Also:
    
    Constant Field Values
  - MOVE_SELECTION_DOWN
```
public static final java.lang.String MOVE_SELECTION_DOWN
```
    See Also:
    
    Constant Field Values
  - COPY_TABLE_DATA
```
public static final java.lang.String COPY_TABLE_DATA
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EntityTablePanel
```
public EntityTablePanel(SwingEntityTableModel tableModel)
```
    Initializes a new EntityTablePanel instance
    
    Parameters:
    
    tableModel - the EntityTableModel instance
  - EntityTablePanel
```
public EntityTablePanel(SwingEntityTableModel tableModel,
                        EntityTableConditionPanel conditionPanel)
```
    Initializes a new EntityTablePanel instance
    
    Parameters:
    
    tableModel - the EntityTableModel instance
    
    conditionPanel - the condition panel
  - EntityTablePanel
```
public EntityTablePanel(javax.swing.JTable table,
                        EntityTableConditionPanel conditionPanel)
```
    Initializes a new EntityTablePanel instance. Note that the JTable must have been instantiated with a SwingEntityTableModel.
```
   SwingEntityTableModel tableModel = ...;
   JTable table = new JTable(tableModel, tableModel.getColumnModel(), (ListSelectionModel) tableModel.getSelectionModel());
 
```
    Parameters:
    
    table - the JTable to use
    
    conditionPanel - the condition panel
    
    See Also:
    
    AbstractFilteredTableModel.getColumnModel(), AbstractFilteredTableModel.getSelectionModel()
- Method Detail
  - setTableDoubleClickAction
```
public final void setTableDoubleClickAction(javax.swing.Action doubleClickAction)
```
    Parameters:
    
    doubleClickAction - the action to perform when a double click is performed on the table, null for no double click action
  - getTableDoubleClickAction
```
public final javax.swing.Action getTableDoubleClickAction()
```
    Returns:
    
    the Action performed when the table receives a double click
  - addPopupControls
```
public final void addPopupControls(ControlSet additionalPopupControls)
```
    Parameters:
    
    additionalPopupControls - a set of controls to add to the table popup menu
    
    Throws:
    
    java.lang.IllegalStateException - in case the panel has already been initialized
    
    See Also:
    
    initializePanel()
  - addToolbarControls
```
public final void addToolbarControls(ControlSet additionalToolbarControls)
```
    Parameters:
    
    additionalToolbarControls - a set of controls to add to the table toolbar menu
    
    Throws:
    
    java.lang.IllegalStateException - in case the panel has already been initialized
    
    See Also:
    
    initializePanel()
  - setIncludeSouthPanel
```
public final void setIncludeSouthPanel(boolean value)
```
    Parameters:
    
    value - true if the south panel should be included
    
    Throws:
    
    java.lang.IllegalStateException - in case the panel has already been initialized
    
    See Also:
    
    initializeSouthPanel(), initializePanel()
  - setIncludeConditionPanel
```
public final void setIncludeConditionPanel(boolean value)
```
    Parameters:
    
    value - true if the condition panel should be included
    
    Throws:
    
    java.lang.IllegalStateException - in case the panel has already been initialized
    
    See Also:
    
    initializePanel()
  - setIncludePopupMenu
```
public final void setIncludePopupMenu(boolean value)
```
    Parameters:
    
    value - true if a popup menu should be included
    
    Throws:
    
    java.lang.IllegalStateException - in case the panel has already been initialized
    
    See Also:
    
    initializePanel()
  - getEntityTableModel
```
public final SwingEntityTableModel getEntityTableModel()
```
    Returns:
    
    the EntityTableModel used by this EntityTablePanel
  - setConditionPanelVisible
```
public final void setConditionPanelVisible(boolean visible)
```
    Hides or shows the column condition panel for this EntityTablePanel
    
    Parameters:
    
    visible - if true the condition panel is shown, if false it is hidden
  - isConditionPanelVisible
```
public final boolean isConditionPanelVisible()
```
    Returns:
    
    true if the condition panel is visible, false if it is hidden
  - getConditionPanel
```
public final EntityTableConditionPanel getConditionPanel()
```
    Returns:
    
    the condition panel being used by this EntityTablePanel
  - toggleConditionPanel
```
public final void toggleConditionPanel()
```
    Toggles the condition panel through the states hidden, visible and in case it is a EntityTableConditionPanel, advanced
  - selectConditionPanel
```
public final void selectConditionPanel()
```
    Allows the user to select on of the available search condition fields
    
    See Also:
    
    EntityTableConditionPanel.selectConditionPanel()
  - setReferentialIntegrityErrorHandling
```
public final void setReferentialIntegrityErrorHandling(EntityTablePanel.ReferentialIntegrityErrorHandling referentialIntegrityErrorHandling)
```
    Parameters:
    
    referentialIntegrityErrorHandling - the action to take on a referential integrity error on delete
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.awt.Component
  - getControl
```
public final Control getControl(java.lang.String controlCode)
```
    Parameters:
    
    controlCode - the control code
    
    Returns:
    
    the control associated with controlCode
    
    Throws:
    
    java.lang.IllegalArgumentException - in case no control is associated with the given control code
  - getUpdateSelectedControlSet
```
public ControlSet getUpdateSelectedControlSet()
```
    Creates a ControlSet containing controls for updating the value of a single property for the selected entities. These controls are enabled as long as the selection is not empty and EntityEditModel.getAllowUpdateObserver() is enabled.
    
    Returns:
    
    a control set containing a set of controls, one for each updatable property in the underlying entity, for performing an update on the selected entities
    
    Throws:
    
    java.lang.IllegalStateException - in case the underlying edit model is read only or updating is not allowed
    
    See Also:
    
    initializePanel(), includeUpdateSelectedProperty(Property), EntityEditModel.getAllowUpdateObserver()
  - getViewDependenciesControl
```
public final Control getViewDependenciesControl()
```
    Returns:
    
    a control for showing the dependencies dialog
  - getDeleteSelectedControl
```
public final Control getDeleteSelectedControl()
```
    Returns:
    
    a control for deleting the selected entities
    
    Throws:
    
    java.lang.IllegalStateException - in case the underlying model is read only or if deleting is not allowed
  - getExportControl
```
public final Control getExportControl()
```
    Returns:
    
    a control for exporting the selected records to file
  - getPrintTableControl
```
public final Control getPrintTableControl()
```
    Returns:
    
    a control for printing the table
  - getRefreshControl
```
public final Control getRefreshControl()
```
    Returns:
    
    a Control for refreshing the underlying table data
  - getClearControl
```
public final Control getClearControl()
```
    Returns:
    
    a Control for clearing the underlying table model, that is, removing all rows
  - updateSelectedEntities
```
public final void updateSelectedEntities(Property propertyToUpdate)
```
    Retrieves a new property value via input dialog and performs an update on the selected entities
    
    Parameters:
    
    propertyToUpdate - the property to update
    
    See Also:
    
    getInputProvider(Property, java.util.List)
  - viewSelectionDependencies
```
public final void viewSelectionDependencies()
```
    Shows a dialog containing lists of entities depending on the selected entities via foreign key
  - delete
```
public final void delete()
```
    Deletes the entities selected in the underlying table model
    
    See Also:
    
    confirmDelete()
  - exportSelected
```
public final void exportSelected()
```
    Exports the selected records as a text file using the available serializer
    
    See Also:
    
    Domain.getEntitySerializer(), Domain.ENTITY_SERIALIZER_CLASS
  - printTable
```
public final void printTable()
                      throws java.awt.print.PrinterException
```
    Prints the table
    
    Throws:
    
    java.awt.print.PrinterException - in case of a print exception
    
    See Also:
    
    JTable.print()
  - handleException
```
public final void handleException(java.lang.Throwable throwable)
```
    Handles the given exception, which usually means simply displaying it to the user
    
    Parameters:
    
    throwable - the exception to handle
  - displayException
```
public final void displayException(java.lang.Throwable throwable,
                                   java.awt.Window dialogParent)
```
    Handle the given exception and display it to the user.
    
    Specified by:
    
    displayException in interface DialogExceptionHandler
    
    Parameters:
    
    throwable - the exception
    
    dialogParent - the Window to use as parent to the exception dialog
  - getToggleConditionPanelControl
```
public final Control getToggleConditionPanelControl()
```
    Initializes the button used to toggle the condition panel state (hidden, visible and advanced)
    
    Returns:
    
    a condition panel toggle button
  - getClearSelectionControl
```
public final Control getClearSelectionControl()
```
    Returns:
    
    a control for clearing the table selection
  - getMoveSelectionDownControl
```
public final Control getMoveSelectionDownControl()
```
    Returns:
    
    a control for moving the table selection down one index
  - getMoveSelectionUpControl
```
public final Control getMoveSelectionUpControl()
```
    Returns:
    
    a control for moving the table selection up one index
  - getViewImageControl
```
public final Control getViewImageControl(java.lang.String imagePathPropertyId)
```
    Creates a Control for viewing an image based on the entity selected in this EntityTablePanel. The action shows an image found at the path specified by the value of the given propertyId. If no entity is selected or the image path value is null no action is performed. Note that for the image to be displayed viewImage(java.lang.String) must be implemented.
    
    Parameters:
    
    imagePathPropertyId - the ID of the property specifying the image path
    
    Returns:
    
    a Control for viewing an image based on the selected entity in a EntityTablePanel
  - addConditionPanelVisibleListener
```
public final void addConditionPanelVisibleListener(EventListener listener)
```
    Parameters:
    
    listener - a listener notified each time the condition panel visibility changes
  - removeConditionPanelVisibleListener
```
public final void removeConditionPanelVisibleListener(EventListener listener)
```
    Parameters:
    
    listener - the listener to remove
  - addTableDoubleClickListener
```
public final void addTableDoubleClickListener(EventListener listener)
```
    Parameters:
    
    listener - a listener notified each time the table is double clicked
  - removeTableDoubleClickListener
```
public final void removeTableDoubleClickListener(EventListener listener)
```
    Parameters:
    
    listener - the listener to remove
  - showDependenciesDialog
```
public static void showDependenciesDialog(java.util.Collection<Entity> entities,
                                          EntityConnectionProvider connectionProvider,
                                          javax.swing.JComponent dialogParent)
```
    Displays a dialog with the entities depending on the given entities.
    
    Parameters:
    
    entities - the entities for which to display dependencies
    
    connectionProvider - the connection provider
    
    dialogParent - the dialog parent
  - createStaticEntityTablePanel
```
public static EntityTablePanel createStaticEntityTablePanel(java.util.Collection<Entity> entities,
                                                            EntityConnectionProvider connectionProvider)
```
    Creates a static read-only entity table panel showing the given entities
    
    Parameters:
    
    entities - the entities to show in the panel
    
    connectionProvider - the EntityConnectionProvider, in case the returned panel should require one
    
    Returns:
    
    a static EntityTablePanel showing the given entities
  - createEntityTablePanel
```
public static EntityTablePanel createEntityTablePanel(java.util.Collection<Entity> entities,
                                                      EntityConnectionProvider connectionProvider)
```
    Creates a static entity table panel showing the given entities, note that this table panel will provide a popup menu for updating and deleting the selected entities unless the underlying entities are read-only.
    
    Parameters:
    
    entities - the entities to show in the panel
    
    connectionProvider - the EntityConnectionProvider, in case the returned panel should require one
    
    Returns:
    
    a static EntityTablePanel showing the given entities
  - createEntityTablePanel
```
public static EntityTablePanel createEntityTablePanel(SwingEntityTableModel tableModel)
```
    Creates a entity table panel based on the given table model. If the table model is not read only, a popup menu for updating or deleting the selected entities is provided.
    
    Parameters:
    
    tableModel - the table model
    
    Returns:
    
    a entity table panel based on the given model
  - selectEntities
```
public static java.util.Collection<Entity> selectEntities(SwingEntityTableModel lookupModel,
                                                          java.awt.Container dialogOwner,
                                                          boolean singleSelection,
                                                          java.lang.String dialogTitle)
```
    Displays a entity table in a dialog for selecting one or more entities
    
    Parameters:
    
    lookupModel - the table model on which to base the table panel
    
    dialogOwner - the dialog owner
    
    singleSelection - if true then only a single item can be selected
    
    dialogTitle - the dialog title
    
    Returns:
    
    a Collection containing the selected entities
    
    Throws:
    
    CancelException - in case the user cancels the operation
  - selectEntities
```
public static java.util.Collection<Entity> selectEntities(SwingEntityTableModel lookupModel,
                                                          java.awt.Container dialogOwner,
                                                          boolean singleSelection,
                                                          java.lang.String dialogTitle,
                                                          java.awt.Dimension preferredSize)
```
    Displays a entity table in a dialog for selecting one or more entities
    
    Parameters:
    
    lookupModel - the table model on which to base the table panel
    
    dialogOwner - the dialog owner
    
    singleSelection - if true then only a single item can be selected
    
    dialogTitle - the dialog title
    
    preferredSize - the preferred size of the dialog
    
    Returns:
    
    a Collection containing the selected entities
    
    Throws:
    
    CancelException - in case the user cancels the operation
  - initializePanel
```
public final EntityTablePanel initializePanel()
```
    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 javax.swing.JPanel initializeSouthPanel()
```
    Initializes the south panel, override and return null for no south panel.
    
    Returns:
    
    the south panel, or null if no south panel should be used
  - setTablePopupMenu
```
protected final void setTablePopupMenu(javax.swing.JTable table,
                                       ControlSet popupControls)
```
    Adds a popup menu to table, null or an empty ControlSet mean no popup menu
    
    Parameters:
    
    table - the table
    
    popupControls - a ControlSet specifying the controls in the popup menu
  - setControl
```
protected final void setControl(java.lang.String controlCode,
                                Control control)
```
    Associates control with controlCode
    
    Parameters:
    
    controlCode - the control code
    
    control - the control to associate with controlCode
  - getToolbarControls
```
protected ControlSet getToolbarControls(java.util.List<ControlSet> additionalToolbarControlSets)
```
  - getPopupControls
```
protected ControlSet getPopupControls(java.util.List<ControlSet> additionalPopupControlSets)
```
    Constructs a ControlSet containing the controls to include in the table popup menu. Returns null or an empty ControlSet to indicate that no popup menu should be included.
    
    Parameters:
    
    additionalPopupControlSets - any additional controls to include in the popup menu
    
    Returns:
    
    the ControlSet on which to base the table popup menu, null or an empty ControlSet if no popup menu should be included
  - getPrintControls
```
protected ControlSet getPrintControls()
```
  - getConditionPanelControl
```
protected final Control getConditionPanelControl()
```
  - getCopyControlSet
```
protected final ControlSet getCopyControlSet()
```
  - getCopyCellControl
```
protected final Control getCopyCellControl()
```
  - getCopyTableWithHeaderControl
```
protected final Control getCopyTableWithHeaderControl()
```
  - includeUpdateSelectedProperty
```
protected boolean includeUpdateSelectedProperty(Property property)
```
    Override to exclude properties from the update selected menu.
    
    Parameters:
    
    property - the property
    
    Returns:
    
    true if the given property should be included in the update selected menu.
    
    See Also:
    
    getUpdateSelectedControlSet()
  - handleException
```
protected void handleException(ValidationException exception)
```
    Handles ValidationExceptions. By default displays the exception message to the user.
    
    Parameters:
    
    exception - the exception to handle
  - handleException
```
protected void handleException(DatabaseException exception)
```
    Handles DatabaseExceptions By default displays the exception message to the user.
    
    Parameters:
    
    exception - the exception to handle
  - confirmDelete
```
protected final boolean confirmDelete()
```
    Called before a delete is performed, if true is returned the delete action is performed otherwise it is canceled
    
    Returns:
    
    true if the delete action should be performed
  - getConfirmDeleteMessages
```
protected java.lang.String[] getConfirmDeleteMessages()
```
    Returns:
    
    Strings to display in the confirm delete dialog, index 0 = message, index 1 = title
  - getInputProvider
```
protected InputProvider getInputProvider(Property property,
                                         java.util.List<Entity> toUpdate)
```
    Provides value input components for multiple entity update, override to supply specific InputValueProvider implementations for properties. Remember to return with a call to super.getInputProvider() after handling your case.
    
    Parameters:
    
    property - the property for which to get the InputProvider
    
    toUpdate - the entities that are about to be updated
    
    Returns:
    
    the InputProvider handling input for property
    
    See Also:
    
    updateSelectedEntities(Property)
  - createEntityInputProvider
```
protected final InputProvider createEntityInputProvider(ForeignKeyProperty foreignKeyProperty,
                                                        Entity currentValue,
                                                        EntityEditModel editModel)
```
    Creates a InputProvider for the given foreign key property
    
    Parameters:
    
    foreignKeyProperty - the property
    
    currentValue - the current value to initialize the InputProvider with
    
    editModel - the edit model involved in the updating
    
    Returns:
    
    a Entity InputProvider
  - initializeTableCellRenderer
```
protected javax.swing.table.TableCellRenderer initializeTableCellRenderer(Property property)
```
    Returns the TableCellRenderer used for the given property in this EntityTablePanel
    
    Parameters:
    
    property - the property
    
    Returns:
    
    the TableCellRenderer for the given property
  - layoutPanel
```
protected void layoutPanel(javax.swing.JPanel southPanel)
```
    This method simply adds the given southPanel to the BorderLayout.SOUTH location, assuming the basePanel is at location BorderLayout.CENTER. By overriding this method you can override the default layout.
    
    Parameters:
    
    southPanel - the panel to add at the BorderLayout.SOUTH position, if any
    
    See Also:
    
    FilteredTablePanel.getBasePanel()
  - viewImage
```
protected void viewImage(java.lang.String imagePath)
                  throws java.io.IOException
```
    Displays the given image
    
    Parameters:
    
    imagePath - the path to the image
    
    Throws:
    
    java.io.IOException - in case the image is not found
  - initializeTableMouseListener
```
protected final java.awt.event.MouseListener initializeTableMouseListener()
```
    Initialize the MouseListener for the table component handling double click and right click, or popup click with ALT down. Double clicking simply invokes the action returned by getTableDoubleClickAction() with the JTable as the ActionEvent source while right click with ALT down invokes EntityUiUtil.showEntityMenu(Entity, JComponent, Point, EntityConnectionProvider)
    
    Returns:
    
    the MouseListener for the table
    
    See Also:
    
    getTableDoubleClickAction()
  - initializeToolbar
```
protected javax.swing.JToolBar initializeToolbar()
```
    Initializes the south panel toolbar, by default based on getToolbarControls()
    
    Returns:
    
    the toolbar to add to the south panel

Class EntityTablePanel

Nested Class Summary

Nested classes/interfaces inherited from class org.jminor.swing.common.ui.table.FilteredTablePanel

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

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

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

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

Field Summary

Fields inherited from class org.jminor.swing.common.ui.table.FilteredTablePanel

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class org.jminor.swing.common.ui.table.FilteredTablePanel

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

ALLOW_COLUMN_REORDERING

TABLE_CONDITION_PANEL_VISIBLE

TABLE_AUTO_RESIZE_MODE

REFERENTIAL_INTEGRITY_ERROR_HANDLING

PRINT_TABLE

DELETE_SELECTED

VIEW_DEPENDENCIES

UPDATE_SELECTED

SELECT_COLUMNS

EXPORT_JSON

CLEAR

REFRESH

TOGGLE_SUMMARY_PANEL

TOGGLE_CONDITION_PANEL

CONDITION_PANEL_VISIBLE

CLEAR_SELECTION

MOVE_SELECTION_UP

MOVE_SELECTION_DOWN

COPY_TABLE_DATA

Constructor Detail

EntityTablePanel

EntityTablePanel

EntityTablePanel

Method Detail

setTableDoubleClickAction

getTableDoubleClickAction

addPopupControls

addToolbarControls

setIncludeSouthPanel

setIncludeConditionPanel

setIncludePopupMenu

getEntityTableModel

setConditionPanelVisible

isConditionPanelVisible

getConditionPanel

toggleConditionPanel

selectConditionPanel

setReferentialIntegrityErrorHandling

toString

getControl

getUpdateSelectedControlSet

getViewDependenciesControl

getDeleteSelectedControl

getExportControl

getPrintTableControl

getRefreshControl

getClearControl

updateSelectedEntities

viewSelectionDependencies

delete

exportSelected

printTable

handleException

displayException

getToggleConditionPanelControl

getClearSelectionControl

getMoveSelectionDownControl

getMoveSelectionUpControl

getViewImageControl