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
A UI component based on a
EntityEditModel
.- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Contains configuration settings for aEntityEditPanel
which must be set before the panel is initialized.static interface
Handles displaying confirmation messages for common actions to the user.static enum
The standard controls available in a edit panelstatic enum
The keyboard shortcuts available forEntityEditPanel
s.Nested classes/interfaces inherited from class is.codion.swing.framework.ui.EntityEditComponentPanel
EntityEditComponentPanel.Defaults
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 is.codion.swing.framework.ui.EntityEditComponentPanel
DEFAULT_TEXT_FIELD_COLUMNS, MODIFIED_INDICATOR, MODIFIED_INDICATOR_UNDERLINE_STYLE
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
ConstructorDescriptionEntityEditPanel
(SwingEntityEditModel editModel) Instantiates a new EntityEditPanel based on the givenEntityEditModel
EntityEditPanel
(SwingEntityEditModel editModel, EntityComponents entityComponents) Instantiates a new EntityEditPanel based on the givenEntityEditModel
EntityEditPanel
(SwingEntityEditModel editModel, EntityComponents entityComponents, Consumer<EntityEditPanel.Config> configuration) Instantiates a new EntityEditPanel based on the givenEntityEditModel
EntityEditPanel
(SwingEntityEditModel editModel, Consumer<EntityEditPanel.Config> configuration) Instantiates a new EntityEditPanel based on the givenEntityEditModel
-
Method Summary
Modifier and TypeMethodDescriptionfinal State
active()
final void
Clears the underlying edit model and requests the initial focus.protected final boolean
protected final boolean
protected final boolean
control
(EntityEditPanel.EditControl editControl) final Controls
controls()
Returns aControls
instance containing all the controls this edit panel provides viacreateControls()
.protected Controls
Creates a Controls instance containing all the controls available in this edit panelfinal boolean
delete()
Performs delete on the active entity without asking for confirmationprotected final Control.Command
deleteCommand
(boolean confirm) Returns an async delete commandfinal boolean
Performs delete on the active entity after asking for confirmation using theEntityEditPanel.Confirmer
specified viaEntityEditPanel.Config.deleteConfirmer(Confirmer)
.final EntityEditPanel
Initializes this EntityEditPanel.final boolean
protected abstract void
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 confirmationprotected final Control.Command
insertCommand
(boolean confirm) Returns an async insert commandfinal boolean
Performs insert on the active entity after asking for confirmation using theEntityEditPanel.Confirmer
specified viaEntityEditPanel.Config.insertConfirmer(Confirmer)
.protected void
onException
(Exception exception) Propagates the exception toonValidationException(ValidationException)
oronReferentialIntegrityException(ReferentialIntegrityException)
depending on type, otherwise forwards to the super implementation.protected void
Called when aReferentialIntegrityException
occurs.protected void
onValidationException
(ValidationException exception) Displays the exception message after which the component involved receives the focus.protected void
Override to setup any custom controls.final String
toString()
final boolean
update()
Performs update on the active entity without asking for confirmation.protected final Control.Command
updateCommand
(boolean confirm) Returns an async update commandfinal boolean
Performs update on the active entity after asking for confirmation using theEntityEditPanel.Confirmer
specified viaEntityEditPanel.Config.updateConfirmer(Confirmer)
.Methods inherited from class is.codion.swing.framework.ui.EntityEditComponentPanel
addInputPanel, addInputPanel, addInputPanel, addInputPanel, addValidator, addValidator, afterInsertFocusAttribute, afterInsertFocusComponent, attribute, attributes, component, createBigDecimalField, createBooleanComboBox, createCheckBox, createComboBox, createComboBox, createDoubleField, createDoubleSpinner, createForeignKeyComboBox, createForeignKeyComboBoxPanel, createForeignKeyLabel, createForeignKeySearchField, createForeignKeySearchFieldPanel, createForeignKeySearchFieldPanel, createForeignKeyTextField, createInputPanel, createInputPanel, createInputPanel, createInputPanel, createInputPanel, createInputPanel, createIntegerField, createIntegerSpinner, createItemComboBox, createItemSpinner, createLabel, createList, createListSpinner, createLongField, createMaskedTextField, createSlider, createTemporalField, createTemporalField, createTemporalFieldPanel, createTemporalFieldPanel, createTextArea, createTextField, createTextFieldPanel, defaults, displayException, editModel, getAfterInsertFocusComponent, getInitialFocusComponent, initialFocusAttribute, initialFocusComponent, modifiedIndicator, requestAfterInsertFocus, requestAfterUpdateFocus, requestComponentFocus, requestInitialFocus, selectableComponents, selectInputComponent, transferFocusOnEnter
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
-
Constructor Details
-
EntityEditPanel
Instantiates a new EntityEditPanel based on the givenEntityEditModel
- Parameters:
editModel
- theEntityEditModel
instance to base this EntityEditPanel on
-
EntityEditPanel
Instantiates a new EntityEditPanel based on the givenEntityEditModel
- Parameters:
editModel
- theEntityEditModel
instance to base this EntityEditPanel onentityComponents
- the entity components instance to use when creating components
-
EntityEditPanel
public EntityEditPanel(SwingEntityEditModel editModel, Consumer<EntityEditPanel.Config> configuration) Instantiates a new EntityEditPanel based on the givenEntityEditModel
- Parameters:
editModel
- theEntityEditModel
instance to base this EntityEditPanel onconfiguration
- provides access to the panel configuration
-
EntityEditPanel
public EntityEditPanel(SwingEntityEditModel editModel, EntityComponents entityComponents, Consumer<EntityEditPanel.Config> configuration) Instantiates a new EntityEditPanel based on the givenEntityEditModel
- Parameters:
editModel
- theEntityEditModel
instance to base this EntityEditPanel onentityComponents
- the entity components instance to use when creating componentsconfiguration
- provides access to the panel configuration
-
-
Method Details
-
toString
-
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. -
control
Returns aValue
containing the control associated withcontrolCode
, an emptyValue
if no such control is available. Note that standard controls are populated during initialization, so until then, these values may be empty.- Parameters:
editControl
- the control code- Returns:
- the
Value
containing the control associated withcontrolCode
-
controls
Returns aControls
instance containing all the controls this edit panel provides viacreateControls()
.- Returns:
- the
Controls
provided by this edit panel - Throws:
IllegalStateException
- in case the panel has not been initialized- See Also:
-
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 theEntityEditPanel.Confirmer
specified viaEntityEditPanel.Config.insertConfirmer(Confirmer)
. Note that the default insertEntityEditPanel.Confirmer
simply returns true, so in order to implement a insert confirmation you must set theEntityEditPanel.Confirmer
viaEntityEditPanel.Config.insertConfirmer(Confirmer)
.- Returns:
- true in case of successful insert, false otherwise
- See Also:
-
insert
public final boolean insert()Performs insert on the active entity without asking for confirmation- Returns:
- true in case of successful insert, false otherwise
-
deleteWithConfirmation
public final boolean deleteWithConfirmation()Performs delete on the active entity after asking for confirmation using theEntityEditPanel.Confirmer
specified viaEntityEditPanel.Config.deleteConfirmer(Confirmer)
.- Returns:
- true if the delete operation was successful
- See Also:
-
delete
public final boolean delete()Performs delete on the active entity without asking for confirmation- Returns:
- true if the delete operation was successful
-
updateWithConfirmation
public final boolean updateWithConfirmation()Performs update on the active entity after asking for confirmation using theEntityEditPanel.Confirmer
specified viaEntityEditPanel.Config.updateConfirmer(Confirmer)
.- Returns:
- true if the update operation was successful
- See Also:
-
update
public final boolean update()Performs update on the active entity without asking for confirmation.- Returns:
- true if the update operation was successful
-
initialized
public final boolean initialized()- Returns:
- true if this panel has been initialized
- See Also:
-
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
-
insertCommand
Returns an async insert command- Parameters:
confirm
- true if confirmation should be performed- Returns:
- a new async insert command
-
updateCommand
Returns an async update command- Parameters:
confirm
- true if confirmation should be performed- Returns:
- a new async update command
-
deleteCommand
Returns an async delete command- Parameters:
confirm
- true if confirmation should be performed- Returns:
- a new async delete command
-
onException
Propagates the exception toonValidationException(ValidationException)
oronReferentialIntegrityException(ReferentialIntegrityException)
depending on type, otherwise forwards to the super implementation.- Overrides:
onException
in classEntityEditComponentPanel
- Parameters:
exception
- the exception to handle- See Also:
-
onReferentialIntegrityException
Called when aReferentialIntegrityException
occurs. If aDatabase.Operation.DELETE
operation is being performed and the referential integrity error handling isReferentialIntegrityErrorHandling.DISPLAY_DEPENDENCIES
, the dependencies of the entity involved are displayed to the user, otherwiseonException(Exception)
is called.- Parameters:
exception
- the exception- See Also:
-
onValidationException
Displays the exception message after which the component involved receives the focus.- Parameters:
exception
- the exception
-
createControls
Creates a Controls instance containing all the controls available in this edit panel- Returns:
- the Controls available in this edit panel
-
setupControls
protected void setupControls()Override to setup any custom controls. This default implementation is empty. This method is called after all standard controls have been initialized.- See Also:
-
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); }
-