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

is.codion.swing.framework.ui.EntityEditPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public abstract class EntityEditPanel
extends EntityEditComponentPanel

A UI component based on a EntityEditModel.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EntityEditPanel.Confirmer	Handles displaying confirmation messages for common actions to the user.
static enum	EntityEditPanel.ControlCode	The standard controls available to the EditPanel

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

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	INCLUDE_ENTITY_MENU	Specifies whether to include a EntityPopupMenu on this edit panel, triggered with CTRL-ALT-V. Value type: Boolean Default value: true
static final PropertyValue<Boolean>	USE_FOCUS_ACTIVATION	Specifies whether edit panels should be activated when the panel (or its parent EntityPanel) receives focus Value type: Boolean Default value: true
static final PropertyValue<Boolean>	USE_SAVE_CAPTION	Specifies whether the add/insert button caption should be 'Save' (mnemonic S), instead of 'Add' (mnemonic A) Value type: Boolean Default value: false

Fields inherited from class is.codion.swing.framework.ui.EntityEditComponentPanel

MODIFIED_INDICATOR_UNDERLINE_STYLE, USE_MODIFIED_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	Description
EntityEditPanel(SwingEntityEditModel editModel)	Instantiates a new EntityEditPanel based on the given EntityEditModel
EntityEditPanel(SwingEntityEditModel editModel, EntityComponents entityComponents)	Instantiates a new EntityEditPanel based on the given EntityEditModel
EntityEditPanel(SwingEntityEditModel editModel, EntityComponents entityComponents, EntityEditPanel.ControlCode... controlCodes)	Instantiates a new EntityEditPanel based on the given EntityEditModel
EntityEditPanel(SwingEntityEditModel editModel, EntityEditPanel.ControlCode... controlCodes)	Instantiates a new EntityEditPanel based on the given EntityEditModel

Method Summary

Modifier and Type	Method	Description
final State	active()
protected void	beforeDelete()	Called before delete is performed.
protected void	beforeInsert()	Called before insert is performed.
protected void	beforeUpdate()	Called before update is performed.
final State	clearAfterInsert()
final void	clearAndRequestFocus()	Clears the underlying edit model and requests the initial focus.
final boolean	containsControl(EntityEditPanel.ControlCode controlCode)
final Control	control(EntityEditPanel.ControlCode controlCode)
protected Controls	createControls()	Creates a Controls instance containing all the controls available in this edit panel
final boolean	delete()	Performs delete on the active entity without asking for confirmation
final boolean	deleteWithConfirmation()	Performs delete on the active entity after asking for confirmation using the EntityEditPanel.Confirmer associated with the EntityEditPanel.Confirmer.Action.DELETE action.
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 boolean	insert()	Performs insert on the active entity without asking for confirmation
final boolean	insertWithConfirmation()	Performs insert on the active entity after asking for confirmation using the EntityEditPanel.Confirmer associated with the EntityEditPanel.Confirmer.Action.INSERT action.
protected void	onReferentialIntegrityException(ReferentialIntegrityException exception)	Called when a ReferentialIntegrityException occurs during a delete operation on the active entity.
protected void	onValidationException(ValidationException exception)	Displays the exception message after which the component involved receives the focus.
final Value<ReferentialIntegrityErrorHandling>	referentialIntegrityErrorHandling()
final State	requestFocusAfterInsert()
final void	setConfirmer(EntityEditPanel.Confirmer.Action action, EntityEditPanel.Confirmer confirmer)	Sets the confirmer to use for the given action.
protected final void	setControl(EntityEditPanel.ControlCode controlCode, Control control)	Associates control with controlCode
final String	toString()
final boolean	update()	Performs update on the active entity without asking for confirmation.
final boolean	updateWithConfirmation()	Performs update on the active entity after asking for confirmation using the EntityEditPanel.Confirmer associated with the EntityEditPanel.Confirmer.Action.UPDATE action.

Methods inherited from class is.codion.swing.framework.ui.EntityEditComponentPanel

addInputPanel, addInputPanel, addInputPanel, addInputPanel, afterInsertFocusAttribute, afterInsertFocusComponent, attribute, attributes, component, createBigDecimalField, createBooleanComboBox, createCheckBox, createComboBox, createComboBox, createDoubleField, createDoubleSpinner, createForeignKeyComboBox, createForeignKeyComboBoxPanel, createForeignKeyLabel, createForeignKeySearchField, createForeignKeySearchFieldPanel, createForeignKeyTextField, createInputPanel, createInputPanel, createInputPanel, createInputPanel, createInputPanel, createInputPanel, createIntegerField, createIntegerSpinner, createItemComboBox, createItemSpinner, createLabel, createListSpinner, createLongField, createMaskedTextField, createSlider, createTemporalField, createTemporalField, createTemporalFieldPanel, createTemporalFieldPanel, createTextArea, createTextField, createTextFieldPanel, displayException, editModel, excludeComponentsFromSelection, getAfterInsertFocusComponent, getInitialFocusComponent, initialFocusAttribute, initialFocusComponent, onException, requestAfterInsertFocus, requestAfterUpdateFocus, requestComponentFocus, requestInitialFocus, selectComponentAttributes, selectInputComponent, setComponent, setDefaultTextFieldColumns, setTransferFocusOnEnter, setUseModifiedIndicator

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

Field Details

USE_FOCUS_ACTIVATION

public static final PropertyValue<Boolean> USE_FOCUS_ACTIVATION

Specifies whether edit panels should be activated when the panel (or its parent EntityPanel) receives focus
Value type: Boolean
Default value: true

USE_SAVE_CAPTION

public static final PropertyValue<Boolean> USE_SAVE_CAPTION

Specifies whether the add/insert button caption should be 'Save' (mnemonic S), instead of 'Add' (mnemonic A)
Value type: Boolean
Default value: false

INCLUDE_ENTITY_MENU

public static final PropertyValue<Boolean> INCLUDE_ENTITY_MENU

Specifies whether to include a EntityPopupMenu on this edit panel, triggered with CTRL-ALT-V.
Value type: Boolean
Default value: true

Constructor Details

EntityEditPanel

public EntityEditPanel(SwingEntityEditModel editModel)

Instantiates a new EntityEditPanel based on the given EntityEditModel

Parameters:

editModel - the EntityEditModel instance to base this EntityEditPanel on

EntityEditPanel

public EntityEditPanel(SwingEntityEditModel editModel,
 EntityComponents entityComponents)

Instantiates a new EntityEditPanel based on the given EntityEditModel

Parameters:

editModel - the EntityEditModel instance to base this EntityEditPanel on

entityComponents - the entity components instance to use when creating components

EntityEditPanel

public EntityEditPanel(SwingEntityEditModel editModel,
 EntityEditPanel.ControlCode... controlCodes)

Instantiates a new EntityEditPanel based on the given EntityEditModel

Parameters:

editModel - the EntityEditModel instance to base this EntityEditPanel on

controlCodes - if specified only controls with those keys are initialized, null or an empty array will result in no controls being initialized

EntityEditPanel

public EntityEditPanel(SwingEntityEditModel editModel,
 EntityComponents entityComponents,
 EntityEditPanel.ControlCode... controlCodes)

Instantiates a new EntityEditPanel based on the given EntityEditModel

Parameters:

editModel - the EntityEditModel instance to base this EntityEditPanel on

entityComponents - the entity components instance to use when creating components

controlCodes - if specified only controls with those keys are initialized, null or an empty array will result in no controls being initialized

Method Details

toString

public final String toString()

Overrides:

toString in class Component

active

public final State active()

Returns:

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

clearAndRequestFocus

public final void clearAndRequestFocus()

Clears the underlying edit model and requests the initial focus.

See Also:

• EntityEditModel.set(Entity)
• EntityEditComponentPanel.requestInitialFocus()

clearAfterInsert

public final State clearAfterInsert()

Returns:

the State controlling whether the UI should be cleared after insert has been performed

requestFocusAfterInsert

public final State requestFocusAfterInsert()

Returns:

the State controlling whether the UI should request focus after insert has been performed

See Also:

• EntityEditComponentPanel.requestInitialFocus()

referentialIntegrityErrorHandling

public final Value<ReferentialIntegrityErrorHandling> referentialIntegrityErrorHandling()

Returns:

the Value controlling the action to take on a referential integrity error on delete

setConfirmer

public final void setConfirmer(EntityEditPanel.Confirmer.Action action,
 EntityEditPanel.Confirmer confirmer)

Sets the confirmer to use for the given action.

Parameters:

action - the confirmation action

confirmer - the confirmer to use for the given action, null for the default one

containsControl

public final boolean containsControl(EntityEditPanel.ControlCode controlCode)

Parameters:

controlCode - the control code

Returns:

true if this edit panel contains a control assocated with the given controlCode

control

public final Control control(EntityEditPanel.ControlCode controlCode)

Parameters:

controlCode - the control code

Returns:

the control associated with controlCode

Throws:

IllegalArgumentException - in case no control is associated with the given controlCode

See Also:

• containsControl(EntityEditPanel.ControlCode)

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.

Returns:

this EntityEditPanel instance

insertWithConfirmation

public final boolean insertWithConfirmation()

Performs insert on the active entity after asking for confirmation using the EntityEditPanel.Confirmer associated with the EntityEditPanel.Confirmer.Action.INSERT action. Note that the default insert EntityEditPanel.Confirmer simply returns true, so in order to implement a insert confirmation you must set the EntityEditPanel.Confirmer via setConfirmer(Confirmer.Action, Confirmer).

Returns:

true in case of successful insert, false otherwise

See Also:

• beforeInsert()
• setConfirmer(Confirmer.Action, Confirmer)

insert

public final boolean insert()

Performs insert on the active entity without asking for confirmation

Returns:

true in case of successful insert, false otherwise

See Also:

• beforeInsert()

deleteWithConfirmation

public final boolean deleteWithConfirmation()

Performs delete on the active entity after asking for confirmation using the EntityEditPanel.Confirmer associated with the EntityEditPanel.Confirmer.Action.DELETE action.

Returns:

true if the delete operation was successful

See Also:

• beforeDelete()
• setConfirmer(Confirmer.Action, Confirmer)

delete

public final boolean delete()

Performs delete on the active entity without asking for confirmation

Returns:

true if the delete operation was successful

See Also:

• beforeDelete()

updateWithConfirmation

public final boolean updateWithConfirmation()

Performs update on the active entity after asking for confirmation using the EntityEditPanel.Confirmer associated with the EntityEditPanel.Confirmer.Action.UPDATE action.

Returns:

true if the update operation was successful

See Also:

• beforeUpdate()
• setConfirmer(Confirmer.Action, Confirmer)

update

public final boolean update()

Performs update on the active entity without asking for confirmation.

Returns:

true if the update operation was successful

See Also:

• beforeUpdate()

initialized

public final boolean initialized()

Returns:

true if this panel has been initialized

See Also:

• initialize()

beforeInsert

protected void beforeInsert()
                     throws ValidationException

Called before insert is performed. To cancel the insert throw a CancelException.

Throws:

ValidationException - in case of a validation failure

beforeUpdate

protected void beforeUpdate()
                     throws ValidationException

Called before update is performed. To cancel the update throw a CancelException.

Throws:

ValidationException - in case of a validation failure

beforeDelete

protected void beforeDelete()

Called before delete is performed. To cancel the delete throw a CancelException.

onReferentialIntegrityException

protected void onReferentialIntegrityException(ReferentialIntegrityException exception)

Called when a ReferentialIntegrityException occurs during a delete operation on the active entity. If the referential integrity error handling is ReferentialIntegrityErrorHandling.DISPLAY_DEPENDENCIES, the dependencies of the entity involved are displayed to the user, otherwise EntityEditComponentPanel.onException(Throwable) is called.

Parameters:

exception - the exception

See Also:

• referentialIntegrityErrorHandling()

onValidationException

protected void onValidationException(ValidationException exception)

Displays the exception message after which the component involved receives the focus.

Parameters:

exception - the exception

setControl

protected final void setControl(EntityEditPanel.ControlCode controlCode,
 Control control)

Associates control with controlCode

Parameters:

controlCode - the control code

control - the control to associate with controlCode, null for none

Throws:

IllegalStateException - in case the panel has already been initialized

createControls

protected Controls createControls()

Creates a Controls instance containing all the controls available in this edit panel

Returns:

the Controls available in this edit panel

Throws:

IllegalStateException - in case the panel has not been initialized

See Also:

• initialized()

initializeUI

protected abstract void initializeUI()

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

   protected void initializeUI() {
      initialFocusAttribute().set(DomainModel.USER_NAME);

      createTextField(DomainModel.USER_NAME);
      createTextField(DomainModel.USER_ADDRESS);

      setLayout(new GridLayout(2, 1, 5, 5);

      addInputPanel(DomainModel.USER_NAME);
      addInputPanel(DomainModel.USER_ADDRESS);
  }