Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui

Class EntityEditPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

is.codion.swing.framework.ui.EntityEditPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public abstract class EntityEditPanel
extends JPanel

An abstract UI component for editing a single entity, based on a SwingEntityEditModel.

The edit model is a thin context-carrier; the panel's working surface is the SwingEntityEditor (accessible via editor()) — it holds the edited values, the validation state and the insert/update/delete tasks. Subclasses implement initializeUI() to create and lay out the input components.

class CustomerEditPanel extends EntityEditPanel {

  CustomerEditPanel(SwingEntityEditModel editModel) {
    super(editModel);
  }

  @Override
  protected void initializeUI() {
    create().textField(Customer.FIRSTNAME);
    create().textField(Customer.LASTNAME);

    setLayout(gridLayout(2, 1));

    addInputPanel(Customer.FIRSTNAME);
    addInputPanel(Customer.LASTNAME);
  }
}

See Also:

• editor()
• initializeUI()
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EntityEditPanel.Config	Contains configuration settings for a EntityEditPanel which must be set before the panel is initialized.
static interface	EntityEditPanel.Confirmer	Handles displaying confirmation messages for common actions to the user.
static final class	EntityEditPanel.ControlKeys	The controls available for EntityEditPanels.
static interface	EntityEditPanel.DeleteCommand	Performs delete.
final class	EntityEditPanel.EditPanelCommands	Provides async commands.
final class	EntityEditPanel.InputFocus	Manages the components that should receive the input focus.
static interface	EntityEditPanel.InsertCommand	Performs insert.
static interface	EntityEditPanel.RefreshCommand	Performs a refresh.
static interface	EntityEditPanel.UpdateCommand	Performs update.

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

Modifier	Constructor	Description
protected	EntityEditPanel(SwingEntityEditModel model)	Instantiates a new EntityEditPanel based on the given EntityEditModel
protected	EntityEditPanel(SwingEntityEditModel model, Consumer<EntityEditPanel.Config> config)	Instantiates a new EntityEditPanel based on the given EntityEditModel

Method Summary

Modifier and Type	Method	Description
final State	active()
protected final void	add(Supplier<? extends JComponent> component)
protected final void	add(Supplier<? extends JComponent> component, Object constraints)
protected final void	addInputPanel(Attribute<?> attribute)	Adds a panel for the given attribute to this panel
protected final void	addInputPanel(Attribute<?> attribute, Object constraints)	Adds a panel for the given attribute to this panel using the given layout constraints
void	addNotify()
final void	clearAndRequestFocus()	Clears the underlying edit model and requests the initial focus.
final EntityEditPanel.EditPanelCommands	commands()
protected final <T> EditorComponents.EditorComponent<T>	component(Attribute<T> attribute)
protected final EditorComponents	components()
protected final void	configureControls(Consumer<Controls.Layout> controlsConfig)	Configures the controls.
protected final boolean	confirmDelete()
protected final boolean	confirmInsert()
protected final boolean	confirmUpdate()
protected 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 Controls	controls()	Returns a Controls instance containing all the controls configured via configureControls(Consumer).
protected final EditorComponents.ComponentFactory	create()
final void	delete()	Performs delete on the active entity.
protected final void	displayException(Exception exception)	Displays the exception in a dialog
final SwingEntityEditor	editor()
final EntityEditPanel.InputFocus	focus()
final EntityEditPanel	initialize()	Initializes this EntityEditPanel.
final boolean	initialized()
protected abstract void	initializeUI()	Initializes this EntityEditPanel UI, that is, creates and lays out the components required for editing the underlying entity type.
final void	insert()	Performs insert on the active entity.
final SwingEntityEditModel	model()
protected void	onException(Exception exception)	Propagates the exception to onValidationException(EntityValidationException) or onReferentialIntegrityException(ReferentialIntegrityException) depending on type, otherwise forwards to the super implementation.
protected void	onReferentialIntegrityException(ReferentialIntegrityException exception)	Called when a ReferentialIntegrityException occurs.
protected void	onValidationException(EntityValidationException exception)	Displays the exception message after which the first invalid component receives the focus.
final void	refresh()	Refreshes the active entity.
void	removeNotify()
void	restore(Preferences preferences)	Restores preferences for this panel.
final void	selectInputComponent()	Displays a dialog allowing the user to select an input component which should receive the keyboard focus.
protected void	setupControls()	Override to set up any custom controls.
void	store(Preferences preferences)	Stores preferences for this panel.
final String	toString()
final void	update()	Performs update on the active entity.
void	updateUI()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

Methods inherited from class javax.swing.JComponent

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

EntityEditPanel

protected EntityEditPanel(SwingEntityEditModel model)

Instantiates a new EntityEditPanel based on the given EntityEditModel

Parameters:

model - the EntityEditModel instance to base this EntityEditPanel on

EntityEditPanel

protected EntityEditPanel(SwingEntityEditModel model,
 Consumer<EntityEditPanel.Config> config)

Instantiates a new EntityEditPanel based on the given EntityEditModel

Parameters:

model - the EntityEditModel instance to base this EntityEditPanel on

config - provides access to the panel configuration

Method Details

model

public final SwingEntityEditModel model()

Returns:

the edit model this panel is based on

updateUI

public void updateUI()

Overrides:

updateUI in class JPanel

toString

public final String toString()

Overrides:

toString in class Component

focus

public final EntityEditPanel.InputFocus focus()

Returns:

the input focus manager

clearAndRequestFocus

public final void clearAndRequestFocus()

Clears the underlying edit model and requests the initial focus.

See Also:

• EntityEditor.EditorEntity.defaults()
• focus()

active

public final State active()

Returns:

a State controlling whether this panel is active, enabled and ready to receive input

selectInputComponent

public final void selectInputComponent()

Displays a dialog allowing the user to select an input component which should receive the keyboard focus.

Both master and detail editor components are included in the selection.

If only one input component is available, that component is selected automatically without displaying a dialog.

If no component is available, f.ex. when the panel is not visible or none of the available components is focusable, this method does nothing.

Input components can be excluded from this selection using EntityEditPanel.Config.excludeFromSelection(Collection).

See Also:

• EntityEditPanel.InputFocus.request(Attribute)
• EditorComponents.detail()

initialize

public final EntityEditPanel initialize()

Initializes this EntityEditPanel. This method marks this panel as initialized which prevents it from running again, whether an exception occurs or not. A call made while the initialization is in progress is ignored.

Returns:

this EntityEditPanel instance

restore

public void restore(Preferences preferences)

Restores preferences for this panel. Override to restore panel specific preferences.

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

Parameters:

preferences - the preferences instance from which to restore

store

public void store(Preferences preferences)

Stores preferences for this panel. Override to store panel specific preferences.

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

The given node is reserved for the edit panel, nothing else is stored in it.

Parameters:

preferences - the preferences instance to write to

refresh

public final void refresh()

Refreshes the active entity.

Throws:

IllegalStateException - in case the active entity does not exist (thrown synchronously)

insert

public final void insert()
                  throws EntityValidationException

Performs insert on the active entity.

If insert confirmation is enabled, confirmation is requested first using the EntityEditPanel.Confirmer specified via EntityEditPanel.Config.insertConfirmer(Confirmer).

Throws:

EntityValidationException - in case of validation failure

See Also:

• EntityEditPanel.Config.confirmInsert(boolean)
• EntityEditPanel.Config.insertConfirmer(Confirmer)

delete

public final void delete()

Performs delete on the active entity.

If delete confirmation is enabled, confirmation is requested first using the EntityEditPanel.Confirmer specified via EntityEditPanel.Config.deleteConfirmer(Confirmer).

See Also:

• confirmDelete()
• EntityEditPanel.Config.deleteConfirmer(Confirmer)

update

public final void update()
                  throws EntityValidationException

Performs update on the active entity.

If update confirmation is enabled, confirmation is requested first using the EntityEditPanel.Confirmer specified via EntityEditPanel.Config.updateConfirmer(Confirmer).

Throws:

EntityValidationException - in case of validation failure

IllegalStateException - in case the active entity is unmodified (thrown synchronously)

See Also:

• EntityEditPanel.Config.confirmUpdate(boolean)
• EntityEditPanel.Config.updateConfirmer(Confirmer)

initialized

public final boolean initialized()

Returns:

true if this panel has been initialized

See Also:

• initialize()

editor

public final SwingEntityEditor editor()

Returns:

the underlying SwingEntityEditor

commands

public final EntityEditPanel.EditPanelCommands commands()

Returns:

the EntityEditPanel.EditPanelCommands instance

confirmInsert

protected final boolean confirmInsert()

Returns:

true if confirmed

confirmUpdate

protected final boolean confirmUpdate()

Returns:

true if confirmed

confirmDelete

protected final boolean confirmDelete()

Returns:

true if confirmed

create

protected final EditorComponents.ComponentFactory create()

Returns:

the EditorComponents.ComponentFactory instance

components

protected final EditorComponents components()

Returns:

the EditorComponents instance

component

protected final <T>
EditorComponents.EditorComponent<T> component(Attribute<T> attribute)

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

Returns:

the EditorComponents.EditorComponent containing the component associated with the given attribute

addInputPanel

protected final void addInputPanel(Attribute<?> attribute)

Adds a panel for the given attribute to this panel

Parameters:

attribute - the attribute

See Also:

• EditorComponents.ComponentFactory.inputPanel(Attribute)

addInputPanel

protected final void addInputPanel(Attribute<?> attribute,
 Object constraints)

Adds a panel for the given attribute to this panel using the given layout constraints

Parameters:

attribute - the attribute

constraints - the layout constraints

See Also:

• EditorComponents.ComponentFactory.inputPanel(Attribute)

add

protected final void add(Supplier<? extends JComponent> component)

Parameters:

component - the component to add

See Also:

• Container.add(Component)

add

protected final void add(Supplier<? extends JComponent> component,
 Object constraints)

Parameters:

component - the component to add

constraints - the constraints

See Also:

• Container.add(Component, Object)

onException

protected void onException(Exception exception)

Propagates the exception to onValidationException(EntityValidationException) or onReferentialIntegrityException(ReferentialIntegrityException) depending on type, otherwise forwards to the super implementation.

Parameters:

exception - the exception to handle

onReferentialIntegrityException

protected void onReferentialIntegrityException(ReferentialIntegrityException exception)

Called when a ReferentialIntegrityException occurs. If a Operation.DELETE operation is being performed and the referential integrity error handling is ReferentialIntegrityErrorHandling.DISPLAY_DEPENDENCIES, the dependencies of the entity involved are displayed to the user, otherwise onException(Exception) is called.

Parameters:

exception - the exception

See Also:

• EntityEditPanel.Config.referentialIntegrityErrorHandling(ReferentialIntegrityErrorHandling)

onValidationException

protected void onValidationException(EntityValidationException exception)

Displays the exception message after which the first invalid component receives the focus. In multi-slot detail editor configurations the source slot is identified by walking each editor's per-attribute valid state — the focused component is the first invalid one in focus traversal order, not just the first registered for the attribute.

Parameters:

exception - the validation exception

displayException

protected final void displayException(Exception exception)

Displays the exception in a dialog

Parameters:

exception - the exception to display

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)

initializeUI

protected abstract void initializeUI()

Initializes this EntityEditPanel UI, that is, creates and lays out the components required for editing the underlying entity type.

@Override
protected void initializeUI() {
  create().textField(Employee.FIRSTNAME);
  create().textField(Employee.LASTNAME);

  setLayout(gridLayout(2, 1));

  addInputPanel(Employee.FIRSTNAME);
  addInputPanel(Employee.LASTNAME);
}

configureControls

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

Configures the controls.

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#INSERT
• ControlKeys#UPDATE
• ControlKeys#DELETE
• ControlKeys#CLEAR

Parameters:

controlsConfig - provides access to the controls configuration

Throws:

IllegalStateException - in case the panel has already been initialized

See Also:

• Controls.Layout.clear()

control

protected 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

controls

protected final Controls controls()

Returns a Controls instance containing all the controls configured via configureControls(Consumer).

Returns:

the Controls provided by this edit panel

Throws:

IllegalStateException - in case the panel has not been initialized

See Also:

• initialized()
• configureControls(Consumer)

addNotify

public void addNotify()

Overrides:

addNotify in class JComponent

removeNotify

public void removeNotify()

Overrides:

removeNotify in class JComponent