Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui

Class EntityPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

is.codion.swing.framework.ui.EntityPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class EntityPanel
extends JPanel

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

   EntityConnectionProvider connectionProvider = createConnectionProvider();
   SwingEntityModel entityModel = new SwingEntityModel(Employee.TYPE, connectionProvider);
   EntityPanel entityPanel = new EntityPanel(entityModel);
   entityPanel.initialize();
   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	Description
static interface	EntityPanel.Builder	A builder for EntityPanel instances.
static final class	EntityPanel.Config	Contains configuration settings for a EntityPanel which must be set before the panel is initialized.
static final class	EntityPanel.ControlKeys	The standard controls available in a entity panel
static interface	EntityPanel.DetailController	Controls the detail panels for a EntityPanel instance.
static interface	EntityPanel.DetailLayout	Handles the layout of a EntityPanel with one or more detail panels.
final class	EntityPanel.DetailPanels	Manages the detail panels for a EntityPanel
static enum	EntityPanel.Direction	The navigation directions.
final class	EntityPanel.Display	Manages display requests for an EntityPanel.
static enum	EntityPanel.PanelState	The possible states of a detail or edit panel.
static enum	EntityPanel.WindowType	Specifies the window type.

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
EntityPanel(SwingEntityModel entityModel)	Instantiates 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, EntityEditPanel editPanel, EntityTablePanel tablePanel, Consumer<EntityPanel.Config> config)	Instantiates a new EntityPanel instance.
EntityPanel(SwingEntityModel entityModel, EntityEditPanel editPanel, Consumer<EntityPanel.Config> config)	Instantiates a new EntityPanel instance.
EntityPanel(SwingEntityModel entityModel, EntityTablePanel tablePanel)	Instantiates a new EntityPanel instance.
EntityPanel(SwingEntityModel entityModel, EntityTablePanel tablePanel, Consumer<EntityPanel.Config> config)	Instantiates a new EntityPanel instance.
EntityPanel(SwingEntityModel entityModel, Consumer<EntityPanel.Config> config)	Instantiates a new EntityPanel instance.

Method Summary

Modifier and Type	Method	Description
final void	activate()	Activates this panel, by initializing it, bringing its parent window to front and requesting initial focus.
final Observer<EntityPanel>	activated()
final void	addKeyEvent(KeyEvents.Builder keyEventBuilder)	Enables the given key event on this panel
void	applyPreferences(Preferences preferences)	Applies any user preferences previously written via writePreferences(Preferences) for this panel and its detail panels.
static EntityPanel.Builder.EntityTypeStep	builder()
final String	caption()
protected final void	configureControls(Consumer<Controls.Layout> controlsLayout)	Configures the controls layout. Note that the Controls.Layout instance has pre-configured defaults, which must be cleared in order to start with an empty configuration.
final boolean	containsEditPanel()
final boolean	containsTablePanel()
final <T extends Control> Value<T>	control(ControlKey<T> controlKey)	Returns a Value containing the control associated with controlKey, an empty Value if no such control is available.
protected final JComponent	createMainComponent()	Creates the main component, which is mainPanel() in case of no detail panels or the result of EntityPanel.DetailLayout.layout() in case of one or more detail panels.
final Optional<String>	description()
protected final EntityPanel.DetailController	detailController()
protected final EntityPanel.DetailLayout	detailLayout()
final EntityPanel.DetailPanels	detailPanels()
final void	displayException(Exception exception)	Displays the exception in a dialog, with the dialog owner as the current focus owner or this panel if none is available.
final SwingEntityEditModel	editModel()
final EntityEditPanel	editPanel()
final Value<EntityPanel.PanelState>	editPanelState()
final Optional<ImageIcon>	icon()
final EntityPanel	initialize()	Initializes this EntityPanel, in case of some specific initialization code you can override the initializeUI() method and add your code there.
protected final void	initializeEditPanel()	Initializes the edit panel, if one is available.
protected final void	initializeTablePanel()	Initializes the table panel, if one is available.
protected void	initializeUI()	Initializes this EntityPanels UI.
protected final JPanel	mainPanel()
final SwingEntityModel	model()
final Optional<EntityPanel>	parentPanel()
final void	removeKeyEvent(KeyEvents.Builder keyEventBuilder)	Disables the given key event on this panel
final void	requestInitialFocus()	Requests focus for this panel.
protected void	setupControls()	Override to set up any custom controls.
protected final void	setupKeyboardActions()	Sets up the keyboard actions.
protected final void	setupNavigation()	Sets up the navigation keyboard shortcuts.
final SwingEntityTableModel	tableModel()
final EntityTablePanel	tablePanel()
final String	toString()
void	updateUI()
void	writePreferences(Preferences preferences)	Saves user preferences for this entity panel and its detail panels.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

EntityPanel

public EntityPanel(SwingEntityModel entityModel)

Instantiates a new EntityPanel instance. The panel is not laid out and initialized until initialize() is called.

Parameters:

entityModel - the EntityModel

EntityPanel

public EntityPanel(SwingEntityModel entityModel,
 Consumer<EntityPanel.Config> config)

Instantiates a new EntityPanel instance. The panel is not laid out and initialized until initialize() is called.

Parameters:

entityModel - the EntityModel

config - provides access to the panel configuration

EntityPanel

public EntityPanel(SwingEntityModel entityModel,
 EntityEditPanel editPanel)

Instantiates a new EntityPanel instance. The panel is not laid out and initialized until initialize() is called.

Parameters:

entityModel - the EntityModel

editPanel - the edit panel

EntityPanel

public EntityPanel(SwingEntityModel entityModel,
 EntityEditPanel editPanel,
 Consumer<EntityPanel.Config> config)

Instantiates a new EntityPanel instance. The panel is not laid out and initialized until initialize() is called.

Parameters:

entityModel - the EntityModel

editPanel - the edit panel

config - provides access to the panel configuration

EntityPanel

public EntityPanel(SwingEntityModel entityModel,
 EntityTablePanel tablePanel)

Instantiates a new EntityPanel instance. The panel is not laid out and initialized until initialize() is called.

Parameters:

entityModel - the EntityModel

tablePanel - the table panel

EntityPanel

public EntityPanel(SwingEntityModel entityModel,
 EntityTablePanel tablePanel,
 Consumer<EntityPanel.Config> config)

Instantiates a new EntityPanel instance. The panel is not laid out and initialized until initialize() is called.

Parameters:

entityModel - the EntityModel

tablePanel - the table panel

config - provides access to the panel configuration

EntityPanel

public EntityPanel(SwingEntityModel entityModel,
 EntityEditPanel editPanel,
 EntityTablePanel tablePanel)

Instantiates a new EntityPanel instance. The panel is not laid out and initialized until initialize() is called.

Parameters:

entityModel - the EntityModel

editPanel - the edit panel

tablePanel - the table panel

EntityPanel

public EntityPanel(SwingEntityModel entityModel,
 EntityEditPanel editPanel,
 EntityTablePanel tablePanel,
 Consumer<EntityPanel.Config> config)

Instantiates a new EntityPanel instance. The panel is not laid out and initialized until initialize() is called.

Parameters:

entityModel - the EntityModel

editPanel - the edit panel

tablePanel - the table panel

config - provides access to the panel configuration

Method Details

updateUI

public void updateUI()

Overrides:

updateUI in class JPanel

model

public final SwingEntityModel model()

Returns:

the EntityModel

editModel

public final SwingEntityEditModel editModel()

Returns:

the EntityEditModel

tableModel

public final SwingEntityTableModel tableModel()

Returns:

the EntityTableModel

Throws:

IllegalStateException - in case no table model is available

parentPanel

public final Optional<EntityPanel> parentPanel()

Returns:

the parent panel or an empty Optional in case of a root panel

detailPanels

public final EntityPanel.DetailPanels detailPanels()

Returns:

the detail panels

initialize

public final EntityPanel initialize()

Initializes this EntityPanel, in case of some specific initialization code you can override the initializeUI() method and add your code there. Calling this method a second time has no effect.

Returns:

this EntityPanel instance

editPanel

public final EntityEditPanel editPanel()

Returns:

the edit panel

Throws:

IllegalStateException - in case no edit panel is available

See Also:

• containsEditPanel()

containsEditPanel

public final boolean containsEditPanel()

Returns:

true if this panel contains an edit panel.

tablePanel

public final EntityTablePanel tablePanel()

Returns:

the table panel

Throws:

IllegalStateException - in case no table panel is available

See Also:

• containsTablePanel()

containsTablePanel

public final boolean containsTablePanel()

Returns:

true if this panel contains a table panel.

control

public final <T extends Control> Value<T> control(ControlKey<T> controlKey)

Returns a Value containing the control associated with controlKey, an empty Value if no such control is available.

Type Parameters:

T - the control type

Parameters:

controlKey - the control key

Returns:

the Value containing the control associated with controlKey

addKeyEvent

public final void addKeyEvent(KeyEvents.Builder keyEventBuilder)

Enables the given key event on this panel

Parameters:

keyEventBuilder - the key event builder

removeKeyEvent

public final void removeKeyEvent(KeyEvents.Builder keyEventBuilder)

Disables the given key event on this panel

Parameters:

keyEventBuilder - the key event builder

toString

public final String toString()

Overrides:

toString in class Component

caption

public final String caption()

Returns:

the caption used when presenting this entity panel

description

public final Optional<String> description()

Returns:

the description used when presenting this entity panel

icon

public final Optional<ImageIcon> icon()

Returns:

the icon used when presenting this entity panel

activated

public final Observer<EntityPanel> activated()

Returns:

an observer notified when this panel is activated

See Also:

• activate()

activate

public final void activate()

Activates this panel, by initializing it, bringing its parent window to front and requesting initial focus.

It is up the EntityApplicationPanel.ApplicationLayout (for top level panels) and the EntityPanel.DetailController (for detail panels) to make sure this panel is displayed when activated.

See Also:

• activated()
• EntityApplicationPanel.ApplicationLayout.activated(EntityPanel)
• EntityPanel.DetailController.activated(EntityPanel)

displayException

public final void displayException(Exception exception)

Displays the exception in a dialog, with the dialog owner as the current focus owner or this panel if none is available.

Parameters:

exception - the exception to display

editPanelState

public final Value<EntityPanel.PanelState> editPanelState()

Returns:

the Value controlling the edit panel state, either EntityPanel.PanelState.HIDDEN, EntityPanel.PanelState.EMBEDDED or EntityPanel.PanelState.WINDOW

requestInitialFocus

public final void requestInitialFocus()

Requests focus for this panel. If an edit panel is available and not hidden, the component defined as the initial focus component by EntityEditComponentPanel.focus() gets the input focus. If no edit panel is available the table panel gets the focus, otherwise the first child component of this EntityPanel is used.

See Also:

• EntityEditComponentPanel.focus()

writePreferences

public void writePreferences(Preferences preferences)

Saves user preferences for this entity panel and its detail panels.

Remember to call super.writePreferences(preferences) when overriding.

Parameters:

preferences - the Preferences instance into which to save the preferences

See Also:

• EntityTablePanel.writePreferences(Preferences)

applyPreferences

public void applyPreferences(Preferences preferences)

Applies any user preferences previously written via writePreferences(Preferences) for this panel and its detail panels.

Remember to call super.applyPreferences(preferences) when overriding.

Parameters:

preferences - the Preferences instance containing the preferences to apply

See Also:

• EntityTablePanel.applyPreferences(Preferences)

builder

public static EntityPanel.Builder.EntityTypeStep builder()

Returns:

a EntityPanel.Builder.EntityTypeStep

initializeUI

protected void initializeUI()

Initializes this EntityPanels UI.

See Also:

• detailLayout()
• createMainComponent()
• mainPanel()

setupControls

protected void setupControls()

Override to set up any custom controls. This default implementation is empty. This method is called after all standard controls have been initialized.

See Also:

• control(ControlKey)

configureControls

protected final void configureControls(Consumer<Controls.Layout> controlsLayout)

Configures the controls layout.
Note that the Controls.Layout instance has pre-configured defaults, which must be cleared in order to start with an empty configuration.

   configureControls(layout -> layout
           .separator()
           .control(createCustomControl()))

Defaults:

• ControlKeys#EDIT_CONTROLS
• ControlKeys#REFRESH

Parameters:

controlsLayout - provides access to the controls layout configuration

See Also:

• Controls.Layout.clear()

createMainComponent

protected final JComponent createMainComponent()

Creates the main component, which is mainPanel() in case of no detail panels or the result of EntityPanel.DetailLayout.layout() in case of one or more detail panels.

Returns:

the main component to base this entity panel on

mainPanel

protected final JPanel mainPanel()

Returns:

the main panel containing the table, edit and control panels

setupKeyboardActions

protected final void setupKeyboardActions()

Sets up the keyboard actions.

See Also:

• EntityPanel.ControlKeys

setupNavigation

protected final void setupNavigation()

Sets up the navigation keyboard shortcuts.

See Also:

• EntityPanel.ControlKeys.NAVIGATE_UP
• EntityPanel.ControlKeys.NAVIGATE_DOWN
• EntityPanel.ControlKeys.NAVIGATE_LEFT
• EntityPanel.ControlKeys.NAVIGATE_RIGHT

initializeEditPanel

protected final void initializeEditPanel()

Initializes the edit panel, if one is available.

initializeTablePanel

protected final void initializeTablePanel()

Initializes the table panel, if one is available.

detailLayout

protected final EntityPanel.DetailLayout detailLayout()

Returns:

the detail layout used by this panel

detailController

protected final EntityPanel.DetailController detailController()

Returns:

the detail controller used by this panel