EntityPanel (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.framework.ui.EntityPanel

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

public class EntityPanel
extends javax.swing.JPanel
implements MasterDetailPanel

A panel representing a Entity via a EntityModel, which facilitates browsing and editing of records.

   String entityId = ...;
   EntityConnectionProvider connectionProvider = ...;
   SwingEntityModel entityModel = new SwingEntityModel(entityId, connectionProvider);
   EntityPanel entityPanel = new EntityPanel(entityModel);
   entityPanel.initializePanel();
   JFrame frame = new JFrame();
   frame.add(entityPanel);
   frame.pack();
   frame.setVisible(true);

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EntityPanel.Direction` The novigation directions.
`static class`	`EntityPanel.PanelState` The possible states of a detail panel.

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

Field Summary

Fields
Modifier and Type	Field and Description
`static PropertyValue<java.lang.Boolean>`	`CENTER_APPLICATION_DIALOGS` Indicates whether dialogs opened by child panels in the application should be centered on their respective parent panel or the application frame/dialog.
`static PropertyValue<java.lang.Boolean>`	`COMPACT_ENTITY_PANEL_LAYOUT` Indicates whether entity panels containing detail panels should by default be laid out in a compact manner Value type: Boolean Default value: true
`static PropertyValue<java.lang.Boolean>`	`DISPOSE_EDIT_DIALOG_ON_ESCAPE` Indicates whether entity edit panel dialogs should be closed on escape Value type: Boolean Default value: true
`static PropertyValue<java.lang.Boolean>`	`SHOW_DETAIL_PANEL_CONTROLS` Specifies whether or not actions to hide detail panels or show them in a dialog are available to the user Value type: Boolean Default value: true
`static PropertyValue<java.lang.Boolean>`	`SHOW_TOGGLE_EDIT_PANEL_CONTROL` Specifies whether or not a control for toggling the edit panel is available to the user Value type: Boolean Default value: true
`static PropertyValue<java.lang.Integer>`	`SPLIT_PANE_DIVIDER_SIZE` Specifies the default size of the divider for detail panel split panes. Value type: Integer Default value: 18
`static PropertyValue<java.lang.Boolean>`	`TOOLBAR_BUTTONS` Specifies whether the action buttons (Save, update, delete, clear, refresh) should be on a toolbar Value type: Boolean Default value: false
`static PropertyValue<java.lang.Boolean>`	`USE_FOCUS_ACTIVATION` Indicates whether entity panels should be activated when the panel receives focus Value type: Boolean Default value: true
`static PropertyValue<java.lang.Boolean>`	`USE_KEYBOARD_NAVIGATION` Indicates whether keyboard navigation will be enabled Value type: Boolean Default value: true

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
`EntityPanel(SwingEntityModel entityModel)` Initializes a new EntityPanel instance.
`EntityPanel(SwingEntityModel entityModel, EntityEditPanel editPanel)` Instantiates a new EntityPanel instance.
`EntityPanel(SwingEntityModel entityModel, EntityEditPanel editPanel, EntityTablePanel tablePanel)` Instantiates a new EntityPanel instance.
`EntityPanel(SwingEntityModel entityModel, EntityTablePanel tablePanel)` Instantiates a new EntityPanel instance.
`EntityPanel(SwingEntityModel entityModel, java.lang.String caption)` Initializes a new EntityPanel instance.
`EntityPanel(SwingEntityModel entityModel, java.lang.String caption, EntityEditPanel editPanel)` Instantiates a new EntityPanel instance.
`EntityPanel(SwingEntityModel entityModel, java.lang.String caption, EntityEditPanel editPanel, EntityTablePanel tablePanel)` Instantiates a new EntityPanel instance.
`EntityPanel(SwingEntityModel entityModel, java.lang.String caption, EntityTablePanel tablePanel)` Instantiates a new EntityPanel instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activatePanel()` Activates this panel, showing it and preparing it for input
`EntityPanel`	`addDetailPanel(EntityPanel detailPanel)` Adds the given detail panel, and adds the detail model to the underlying model if it does not contain it already, and then sets `includeDetailPanelTabPane` to true
`EntityPanel`	`addDetailPanels(EntityPanel... detailPanels)`
`boolean`	`containsDetailPanel(java.lang.String entityId)` Returns true if this panel contains a detail panel for the given `entityId`
`boolean`	`containsEditPanel()`
`boolean`	`containsTablePanel()`
`protected javax.swing.JComponent`	`createEditControlPanel()` Creates the control panel or component to place next to the edit panel, containing controls for managing records, such as insert, update and delete.
`void`	`displayException(java.lang.Exception exception)` Displays the exception in a dialog
`EntityPanel`	`getActiveDetailPanel()`
`java.lang.String`	`getCaption()`
`java.lang.String`	`getControlPanelConstraints()`
`EntityPanel`	`getDetailPanel(java.lang.String entityId)` Returns the detail panel for the given `entityId`, if one is available
`java.util.List<MasterDetailPanel>`	`getDetailPanels()`
`EntityPanel.PanelState`	`getDetailPanelState()`
`double`	`getDetailSplitPaneResizeWeight()`
`javax.swing.JPanel`	`getEditControlPanel()`
`SwingEntityEditModel`	`getEditModel()`
`EntityEditPanel`	`getEditPanel()`
`EntityPanel.PanelState`	`getEditPanelState()`
`java.util.Collection<EntityPanel>`	`getLinkedDetailPanels()`
`MasterDetailPanel`	`getMasterPanel()`
`SwingEntityModel`	`getModel()`
`MasterDetailPanel`	`getNextPanel()`
`MasterDetailPanel`	`getPreviousPanel()`
`SwingEntityTableModel`	`getTableModel()`
`EntityTablePanel`	`getTablePanel()`
`Control`	`getToggleDetailPanelControl()`
`Control`	`getToggleEditPanelControl()`
`protected void`	`initialize()` Override to add code that should be called during the initialization routine after the panel has been initialized
`protected void`	`initializeAssociatedPanels()` Called during initialization, before controls have been initialized
`protected void`	`initializeControlPanels()` Called during initialization, after controls have been initialized, use this method to initialize any application panels that rely on controls having been initialized
`EntityPanel`	`initializePanel()` Initializes this EntityPanels UI, in case of some specific initialization code you can override the `initialize()` method and add your code there.
`protected void`	`initializeUI()` Initializes this EntityPanels UI.
`boolean`	`isCompactDetailLayout()`
`boolean`	`isDisposeEditDialogOnEscape()`
`boolean`	`isIncludeControlPanel()`
`boolean`	`isIncludeDetailPanelTabPane()`
`boolean`	`isPanelInitialized()`
`boolean`	`isShowDetailPanelControls()`
`boolean`	`isShowToggleEditPanelControl()`
`void`	`prepareUI(boolean setInitialFocus, boolean clearUI)` Prepares the UI, by clearing the input fields and setting the initial focus, if both parameters are set to false then there is no effect
`void`	`resizePanel(EntityPanel.Direction direction, int pixelAmount)` Resizes this panel in the given direction
`void`	`savePreferences()` Saves any user preferences for all entity panels and associated elements
`void`	`setActiveDetailPanel(MasterDetailPanel detailPanel)` Activates (and shows) the given detail panel
`EntityPanel`	`setCompactDetailLayout(boolean compactDetailLayout)`
`EntityPanel`	`setControlPanelConstraints(java.lang.String controlPanelConstraints)` Sets the layout constraints to use for the control panel
`void`	`setDetailPanelState(EntityPanel.PanelState state)`
`EntityPanel`	`setDetailSplitPanelResizeWeight(double detailSplitPanelResizeWeight)`
`void`	`setDisposeEditDialogOnEscape(boolean disposeEditDialogOnEscape)`
`void`	`setEditPanelState(EntityPanel.PanelState state)`
`void`	`setFilterPanelsVisible(boolean value)` Hides or shows the active filter panels for this panel and all its child panels (detail panels and their detail panels etc.)
`EntityPanel`	`setIncludeControlPanel(boolean includeControlPanel)`
`EntityPanel`	`setIncludeDetailPanelTabPane(boolean includeDetailPanelTabPane)`
`protected void`	`setMasterPanel(EntityPanel masterPanel)`
`EntityPanel`	`setShowDetailPanelControls(boolean showDetailPanelControls)`
`EntityPanel`	`setShowToggleEditPanelControl(boolean showToggleEditPanelControl)`
`void`	`toggleDetailPanelState()` Toggles the detail panel state between DIALOG, HIDDEN and EMBEDDED
`void`	`toggleEditPanelState()` Toggles the edit panel state between DIALOG, HIDDEN and EMBEDDED
`java.lang.String`	`toString()`

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
  - USE_FOCUS_ACTIVATION
```
public static final PropertyValue<java.lang.Boolean> USE_FOCUS_ACTIVATION
```
    Indicates whether entity panels should be activated when the panel receives focus
    Value type: Boolean
    Default value: true
    
    See Also:
    
    EntityEditPanel.ALL_PANELS_ACTIVE
  - USE_KEYBOARD_NAVIGATION
```
public static final PropertyValue<java.lang.Boolean> USE_KEYBOARD_NAVIGATION
```
    Indicates whether keyboard navigation will be enabled
    Value type: Boolean
    Default value: true
  - CENTER_APPLICATION_DIALOGS
```
public static final PropertyValue<java.lang.Boolean> CENTER_APPLICATION_DIALOGS
```
    Indicates whether dialogs opened by child panels in the application should be centered on their respective parent panel or the application frame/dialog. This applies to edit panels. Value type: Boolean
    Default value: false
  - DISPOSE_EDIT_DIALOG_ON_ESCAPE
```
public static final PropertyValue<java.lang.Boolean> DISPOSE_EDIT_DIALOG_ON_ESCAPE
```
    Indicates whether entity edit panel dialogs should be closed on escape
    Value type: Boolean
    Default value: true
  - SHOW_TOGGLE_EDIT_PANEL_CONTROL
```
public static final PropertyValue<java.lang.Boolean> SHOW_TOGGLE_EDIT_PANEL_CONTROL
```
    Specifies whether or not a control for toggling the edit panel is available to the user
    Value type: Boolean
    Default value: true
  - SHOW_DETAIL_PANEL_CONTROLS
```
public static final PropertyValue<java.lang.Boolean> SHOW_DETAIL_PANEL_CONTROLS
```
    Specifies whether or not actions to hide detail panels or show them in a dialog are available to the user
    Value type: Boolean
    Default value: true
  - SPLIT_PANE_DIVIDER_SIZE
```
public static final PropertyValue<java.lang.Integer> SPLIT_PANE_DIVIDER_SIZE
```
    Specifies the default size of the divider for detail panel split panes.
    Value type: Integer
    Default value: 18
  - COMPACT_ENTITY_PANEL_LAYOUT
```
public static final PropertyValue<java.lang.Boolean> COMPACT_ENTITY_PANEL_LAYOUT
```
    Indicates whether entity panels containing detail panels should by default be laid out in a compact manner
    Value type: Boolean
    Default value: true
  - TOOLBAR_BUTTONS
```
public static final PropertyValue<java.lang.Boolean> TOOLBAR_BUTTONS
```
    Specifies whether the action buttons (Save, update, delete, clear, refresh) should be on a toolbar
    Value type: Boolean
    Default value: false
- Constructor Detail
  - EntityPanel
```
public EntityPanel(SwingEntityModel entityModel)
```
    Initializes a new EntityPanel instance. The Panel is not laid out and initialized until initializePanel() is called. The default caption of the underlying entity is used.
    
    Parameters:
    
    entityModel - the EntityModel
  - EntityPanel
```
public EntityPanel(SwingEntityModel entityModel,
                   java.lang.String caption)
```
    Initializes a new EntityPanel instance. The Panel is not laid out and initialized until initializePanel() is called.
    
    Parameters:
    
    entityModel - the EntityModel
    
    caption - the caption to use when presenting this entity panel
  - EntityPanel
```
public EntityPanel(SwingEntityModel entityModel,
                   EntityEditPanel editPanel)
```
    Instantiates a new EntityPanel instance. The Panel is not laid out and initialized until initializePanel() is called.
    
    Parameters:
    
    entityModel - the EntityModel
    
    editPanel - the edit panel
  - EntityPanel
```
public EntityPanel(SwingEntityModel entityModel,
                   EntityTablePanel tablePanel)
```
    Instantiates a new EntityPanel instance. The Panel is not laid out and initialized until initializePanel() is called.
    
    Parameters:
    
    entityModel - the EntityModel
    
    tablePanel - the table panel
  - EntityPanel
```
public EntityPanel(SwingEntityModel entityModel,
                   java.lang.String caption,
                   EntityEditPanel editPanel)
```
    Instantiates a new EntityPanel instance. The Panel is not laid out and initialized until initializePanel() is called.
    
    Parameters:
    
    entityModel - the EntityModel
    
    caption - the caption to use when presenting this entity panel
    
    editPanel - the edit panel
  - EntityPanel
```
public EntityPanel(SwingEntityModel entityModel,
                   java.lang.String caption,
                   EntityTablePanel tablePanel)
```
    Instantiates a new EntityPanel instance. The Panel is not laid out and initialized until initializePanel() is called.
    
    Parameters:
    
    entityModel - the EntityModel
    
    caption - the caption to use when presenting this entity panel
    
    tablePanel - the table panel
  - EntityPanel
```
public EntityPanel(SwingEntityModel entityModel,
                   EntityEditPanel editPanel,
                   EntityTablePanel tablePanel)
```
    Instantiates a new EntityPanel instance. The Panel is not laid out and initialized until initializePanel() is called.
    
    Parameters:
    
    entityModel - the EntityModel
    
    editPanel - the edit panel
    
    tablePanel - the table panel
  - EntityPanel
```
public EntityPanel(SwingEntityModel entityModel,
                   java.lang.String caption,
                   EntityEditPanel editPanel,
                   EntityTablePanel tablePanel)
```
    Instantiates a new EntityPanel instance. The Panel is not laid out and initialized until initializePanel() is called.
    
    Parameters:
    
    entityModel - the EntityModel
    
    caption - the caption to use when presenting this entity panel
    
    editPanel - the edit panel
    
    tablePanel - the table panel
- Method Detail
  - getModel
```
public final SwingEntityModel getModel()
```
    Returns:
    
    the EntityModel
  - getEditModel
```
public final SwingEntityEditModel getEditModel()
```
    Returns:
    
    the EntityEditModel
  - getTableModel
```
public final SwingEntityTableModel getTableModel()
```
    Returns:
    
    the EntityTableModel, null if none is available
  - getControlPanelConstraints
```
public final java.lang.String getControlPanelConstraints()
```
    Returns:
    
    the control panel layout constraints (BorderLayout constraints)
  - setControlPanelConstraints
```
public final EntityPanel setControlPanelConstraints(java.lang.String controlPanelConstraints)
```
    Sets the layout constraints to use for the control panel
```
 The default layout is as follows (BorderLayout.WEST):
 __________________________________
 |   edit panel           |control|
 |  (EntityEditPanel)     | panel | } edit control panel
 |________________________|_______|

 With  (BorderLayout.SOUTH):
 __________________________
 |         edit           |
 |        panel           |
 |________________________| } edit control panel
 |     control panel      |
 |________________________|

 etc.
```
    Parameters:
    
    controlPanelConstraints - the control panel layout constraints (BorderLayout constraints)
    
    Returns:
    
    this entity panel
    
    Throws:
    
    java.lang.IllegalStateException - if the panel has been initialized
    
    java.lang.IllegalArgumentException - in case the given constraint is not one of BorderLayout.SOUTH, NORTH, EAST or WEST
  - isCompactDetailLayout
```
public final boolean isCompactDetailLayout()
```
    Returns:
    
    true if this entity panel is using a compact detail layout
  - setCompactDetailLayout
```
public final EntityPanel setCompactDetailLayout(boolean compactDetailLayout)
```
    Parameters:
    
    compactDetailLayout - true if this panel and its detail panels should be laid out in a compact state
    
    Returns:
    
    this EntityPanel instance
  - addDetailPanels
```
public final EntityPanel addDetailPanels(EntityPanel... detailPanels)
```
    Parameters:
    
    detailPanels - the detail panels
    
    Returns:
    
    this entity panel
  - addDetailPanel
```
public final EntityPanel addDetailPanel(EntityPanel detailPanel)
```
    Adds the given detail panel, and adds the detail model to the underlying model if it does not contain it already, and then sets includeDetailPanelTabPane to true
    
    Parameters:
    
    detailPanel - the detail panel to add
    
    Returns:
    
    this entity panel
    
    Throws:
    
    java.lang.IllegalStateException - if the panel has been initialized
  - initializePanel
```
public final EntityPanel initializePanel()
```
    Initializes this EntityPanels UI, in case of some specific initialization code you can override the initialize() method and add your code there. This method marks this panel as initialized which prevents it from running again, whether or not an exception occurs.
    
    Returns:
    
    this EntityPanel instance
    
    See Also:
    
    initialize(), isPanelInitialized()
  - isPanelInitialized
```
public final boolean isPanelInitialized()
```
    Returns:
    
    true if the method initializePanel() has been called on this EntityPanel instance
    
    See Also:
    
    initializePanel()
  - getEditPanel
```
public final EntityEditPanel getEditPanel()
```
    Returns:
    
    the edit panel
  - containsEditPanel
```
public final boolean containsEditPanel()
```
    Returns:
    
    true if this panel contains a edit panel.
  - getTablePanel
```
public final EntityTablePanel getTablePanel()
```
    Returns:
    
    the EntityTablePanel used by this EntityPanel
  - containsTablePanel
```
public final boolean containsTablePanel()
```
    Returns:
    
    true if this panel contains a table panel.
  - getEditControlPanel
```
public final javax.swing.JPanel getEditControlPanel()
```
    Returns:
    
    the edit control panel
  - getLinkedDetailPanels
```
public final java.util.Collection<EntityPanel> getLinkedDetailPanels()
```
    Returns:
    
    the currently visible/linked detail EntityPanel, if any
  - getDetailPanel
```
public final EntityPanel getDetailPanel(java.lang.String entityId)
```
    Returns the detail panel for the given entityId, if one is available
    
    Parameters:
    
    entityId - the entity ID of the detail panel to retrieve
    
    Returns:
    
    the detail panel of the given type
    
    Throws:
    
    java.lang.IllegalArgumentException - in case the panel was not found
  - containsDetailPanel
```
public final boolean containsDetailPanel(java.lang.String entityId)
```
    Returns true if this panel contains a detail panel for the given entityId
    
    Parameters:
    
    entityId - the entityId
    
    Returns:
    
    true if a detail panel for the given entityId is found
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.awt.Component
  - getCaption
```
public final java.lang.String getCaption()
```
    Returns:
    
    the caption to use when presenting this entity panel
  - activatePanel
```
public final void activatePanel()
```
    Activates this panel, showing it and preparing it for input
    
    Specified by:
    
    activatePanel in interface MasterDetailPanel
  - getMasterPanel
```
public final MasterDetailPanel getMasterPanel()
```
    Specified by:
    
    getMasterPanel in interface MasterDetailPanel
    
    Returns:
    
    the parent master panel, if one exists
  - getActiveDetailPanel
```
public final EntityPanel getActiveDetailPanel()
```
    Specified by:
    
    getActiveDetailPanel in interface MasterDetailPanel
    
    Returns:
    
    a detail panel, if one exists, which child panel exactly is up the implementation
  - setActiveDetailPanel
```
public final void setActiveDetailPanel(MasterDetailPanel detailPanel)
```
    Activates (and shows) the given detail panel
    
    Specified by:
    
    setActiveDetailPanel in interface MasterDetailPanel
    
    Parameters:
    
    detailPanel - the detail panel to activate and show
  - getPreviousPanel
```
public final MasterDetailPanel getPreviousPanel()
```
    Specified by:
    
    getPreviousPanel in interface MasterDetailPanel
    
    Returns:
    
    the previous detail panel, if one exists, with wrap around
  - getNextPanel
```
public final MasterDetailPanel getNextPanel()
```
    Specified by:
    
    getNextPanel in interface MasterDetailPanel
    
    Returns:
    
    the next detail panel, if one exists, with wrap around
  - getDetailPanels
```
public final java.util.List<MasterDetailPanel> getDetailPanels()
```
    Specified by:
    
    getDetailPanels in interface MasterDetailPanel
    
    Returns:
    
    the detail panels, an empty list if no detail panels exist
  - getToggleEditPanelControl
```
public final Control getToggleEditPanelControl()
```
    Returns:
    
    a control for toggling the edit panel
  - getToggleDetailPanelControl
```
public final Control getToggleDetailPanelControl()
```
    Returns:
    
    a control for toggling the detail panel
  - displayException
```
public final void displayException(java.lang.Exception exception)
```
    Displays the exception in a dialog
    
    Parameters:
    
    exception - the exception to handle
    
    See Also:
    
    DefaultDialogExceptionHandler
  - getDetailSplitPaneResizeWeight
```
public final double getDetailSplitPaneResizeWeight()
```
    Returns:
    
    the resize weight value to use when initializing the left/right split pane, which controls the initial divider placement (0 - 1). Override to control the initial divider placement
  - setDetailSplitPanelResizeWeight
```
public final EntityPanel setDetailSplitPanelResizeWeight(double detailSplitPanelResizeWeight)
```
    Parameters:
    
    detailSplitPanelResizeWeight - the detail panel split size weight
    
    Returns:
    
    this entity panel
    
    Throws:
    
    java.lang.IllegalStateException - if the panel has been initialized
  - isIncludeDetailPanelTabPane
```
public final boolean isIncludeDetailPanelTabPane()
```
    Returns:
    
    true if the detail panel tab pane should be included
  - setIncludeDetailPanelTabPane
```
public final EntityPanel setIncludeDetailPanelTabPane(boolean includeDetailPanelTabPane)
```
    Parameters:
    
    includeDetailPanelTabPane - true if the detail panel tab pane should be included
    
    Returns:
    
    this entity panel
    
    Throws:
    
    java.lang.IllegalStateException - if the panel has been initialized
  - isShowToggleEditPanelControl
```
public final boolean isShowToggleEditPanelControl()
```
    Returns:
    
    true if the edit panel control should be shown
    
    See Also:
    
    SHOW_TOGGLE_EDIT_PANEL_CONTROL
  - setShowToggleEditPanelControl
```
public final EntityPanel setShowToggleEditPanelControl(boolean showToggleEditPanelControl)
```
    Parameters:
    
    showToggleEditPanelControl - true if a control for toggling the edit panel should be shown
    
    Returns:
    
    this EntityPane instance
    
    Throws:
    
    java.lang.IllegalStateException - if the panel has been initialized
  - isShowDetailPanelControls
```
public final boolean isShowDetailPanelControls()
```
    Returns:
    
    true if detail panel controls should be shown
    
    See Also:
    
    SHOW_DETAIL_PANEL_CONTROLS
  - setShowDetailPanelControls
```
public final EntityPanel setShowDetailPanelControls(boolean showDetailPanelControls)
```
    Parameters:
    
    showDetailPanelControls - true if detail panel controls should be shown
    
    Returns:
    
    this EntityPane instance
    
    Throws:
    
    java.lang.IllegalStateException - if the panel has been initialized
  - isIncludeControlPanel
```
public final boolean isIncludeControlPanel()
```
    Returns:
    
    true if the control panel should be included
  - setIncludeControlPanel
```
public final EntityPanel setIncludeControlPanel(boolean includeControlPanel)
```
    Parameters:
    
    includeControlPanel - true if the control panel should be included
    
    Returns:
    
    this EntityPane instance
    
    Throws:
    
    java.lang.IllegalStateException - if the panel has been initialized
  - isDisposeEditDialogOnEscape
```
public final boolean isDisposeEditDialogOnEscape()
```
    Returns:
    
    true if the edit dialog is disposed of on ESC
    
    See Also:
    
    DISPOSE_EDIT_DIALOG_ON_ESCAPE
  - setDisposeEditDialogOnEscape
```
public final void setDisposeEditDialogOnEscape(boolean disposeEditDialogOnEscape)
```
    Parameters:
    
    disposeEditDialogOnEscape - if true then the edit dialog is disposed of on ESC
    
    See Also:
    
    DISPOSE_EDIT_DIALOG_ON_ESCAPE
  - toggleDetailPanelState
```
public final void toggleDetailPanelState()
```
    Toggles the detail panel state between DIALOG, HIDDEN and EMBEDDED
  - toggleEditPanelState
```
public final void toggleEditPanelState()
```
    Toggles the edit panel state between DIALOG, HIDDEN and EMBEDDED
  - getDetailPanelState
```
public final EntityPanel.PanelState getDetailPanelState()
```
    Returns:
    
    the detail panel state, either HIDDEN, EMBEDDED or DIALOG
  - getEditPanelState
```
public final EntityPanel.PanelState getEditPanelState()
```
    Returns:
    
    the edit panel state, either HIDDEN, EMBEDDED or DIALOG
  - setDetailPanelState
```
public final void setDetailPanelState(EntityPanel.PanelState state)
```
    Parameters:
    
    state - the detail panel state (HIDDEN or EMBEDDED, DIALOG)
  - setEditPanelState
```
public final void setEditPanelState(EntityPanel.PanelState state)
```
    Parameters:
    
    state - the edit panel state, either HIDDEN, EMBEDDED or DIALOG
  - setFilterPanelsVisible
```
public final void setFilterPanelsVisible(boolean value)
```
    Hides or shows the active filter panels for this panel and all its child panels (detail panels and their detail panels etc.)
    
    Parameters:
    
    value - true if the active panels should be shown, false if they should be hidden
  - resizePanel
```
public final void resizePanel(EntityPanel.Direction direction,
                              int pixelAmount)
```
    Resizes this panel in the given direction
    
    Parameters:
    
    direction - the resize direction
    
    pixelAmount - the resize amount
  - prepareUI
```
public final void prepareUI(boolean setInitialFocus,
                            boolean clearUI)
```
    Prepares the UI, by clearing the input fields and setting the initial focus, if both parameters are set to false then there is no effect
    
    Parameters:
    
    setInitialFocus - if true the component defined as the initialFocusComponent gets the input focus, if none is defined the first child component of this EntityPanel is used, if no edit panel is available the table receives the focus
    
    clearUI - if true the the input components are cleared
    
    See Also:
    
    EntityEditPanel.setInitialFocusComponent(javax.swing.JComponent)
  - savePreferences
```
public void savePreferences()
```
    Saves any user preferences for all entity panels and associated elements
  - initializeUI
```
protected void initializeUI()
```
    Initializes this EntityPanels UI.
```
 The default layout is as follows:
 __________________________________
 |      edit panel        |control|
 |   (EntityEditPanel)    | panel | } edit control panel
 |________________________|_______|
 |                  |             |
 |   table panel    |   detail    |
 |(EntityTablePanel)|   panel     |
 |                  |             |
 |__________________|_____________|

 or in case of compact layout:
 __________________________________
 |  edit    |control|             |
 |  panel   | panel |             |
 |__________|_______|   detail    |
 |                  |   panel     |
 |   table panel    |             |
 |(EntityTablePanel)|             |
 |                  |             |
 |__________________|_____________|
 
```
  - initializeAssociatedPanels
```
protected void initializeAssociatedPanels()
```
    Called during initialization, before controls have been initialized
    
    See Also:
    
    initializePanel()
  - initializeControlPanels
```
protected void initializeControlPanels()
```
    Called during initialization, after controls have been initialized, use this method to initialize any application panels that rely on controls having been initialized
    
    See Also:
    
    initializePanel()
  - initialize
```
protected void initialize()
```
    Override to add code that should be called during the initialization routine after the panel has been initialized
    
    See Also:
    
    initializePanel()
  - createEditControlPanel
```
protected javax.swing.JComponent createEditControlPanel()
```
    Creates the control panel or component to place next to the edit panel, containing controls for managing records, such as insert, update and delete. Only called if includeControlPanel returns true. By default the control panel provided by the edit panel is returned.
    
    Returns:
    
    the control panel for managing records
    
    See Also:
    
    EntityEditPanel.createControlPanel(boolean), EntityEditPanel.createControlToolBar(int), TOOLBAR_BUTTONS
  - setMasterPanel
```
protected final void setMasterPanel(EntityPanel masterPanel)
```
    Parameters:
    
    masterPanel - the panel serving as master panel for this entity panel
    
    Throws:
    
    java.lang.IllegalStateException - in case a master panel has already been set

Class EntityPanel

Nested Class Summary

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

USE_FOCUS_ACTIVATION

USE_KEYBOARD_NAVIGATION

CENTER_APPLICATION_DIALOGS

DISPOSE_EDIT_DIALOG_ON_ESCAPE

SHOW_TOGGLE_EDIT_PANEL_CONTROL

SHOW_DETAIL_PANEL_CONTROLS

SPLIT_PANE_DIVIDER_SIZE

COMPACT_ENTITY_PANEL_LAYOUT

TOOLBAR_BUTTONS

Constructor Detail

EntityPanel

EntityPanel

EntityPanel

EntityPanel

EntityPanel

EntityPanel

EntityPanel

EntityPanel

Method Detail

getModel

getEditModel

getTableModel

getControlPanelConstraints

setControlPanelConstraints

isCompactDetailLayout

setCompactDetailLayout

addDetailPanels

addDetailPanel

initializePanel

isPanelInitialized

getEditPanel

containsEditPanel

getTablePanel

containsTablePanel

getEditControlPanel

getLinkedDetailPanels

getDetailPanel

containsDetailPanel

toString

getCaption

activatePanel

getMasterPanel

getActiveDetailPanel

setActiveDetailPanel

getPreviousPanel

getNextPanel

getDetailPanels

getToggleEditPanelControl

getToggleDetailPanelControl

displayException

getDetailSplitPaneResizeWeight

setDetailSplitPanelResizeWeight

isIncludeDetailPanelTabPane

setIncludeDetailPanelTabPane

isShowToggleEditPanelControl

setShowToggleEditPanelControl

isShowDetailPanelControls

setShowDetailPanelControls

isIncludeControlPanel

setIncludeControlPanel

isDisposeEditDialogOnEscape

setDisposeEditDialogOnEscape