Module is.codion.swing.framework.ui
Package is.codion.swing.framework.ui
Class EntityEditPanel.Config
java.lang.Object
is.codion.swing.framework.ui.EntityEditPanel.Config
- Enclosing class:
- EntityEditPanel
Contains configuration settings for a
EntityEditPanel
which must be set before the panel is initialized.-
Field Summary
Modifier and TypeFieldDescriptionstatic final PropertyValue<Boolean>
Specifies whether to include aEntityPopupMenu
on this edit panel, triggered with CTRL-ALT-V by default.
Value type: Boolean
Default value: truestatic final KeyboardShortcuts<EntityEditPanel.KeyboardShortcut>
The default keyboard shortcut keyStrokes.static final PropertyValue<Boolean>
Specifies whether edit panels should be activated when the panel (or its parent EntityPanel) receives focus
Value type: Boolean
Default value: truestatic final PropertyValue<Boolean>
Specifies whether the add/insert button caption should be 'Save' (mnemonic S), instead of 'Add' (mnemonic A)
Value type: Boolean
Default value: false -
Method Summary
Modifier and TypeMethodDescriptionclearAfterInsert
(boolean clearAfterInsert) deleteConfirmer
(EntityEditPanel.Confirmer deleteConfirmer) editControls
(EntityEditPanel.EditControl... editControls) focusActivation
(boolean focusActivation) includeEntityMenu
(boolean includeEntityMenu) insertConfirmer
(EntityEditPanel.Confirmer insertConfirmer) referentialIntegrityErrorHandling
(ReferentialIntegrityErrorHandling referentialIntegrityErrorHandling) requestFocusAfterInsert
(boolean requestFocusAfterInsert) updateConfirmer
(EntityEditPanel.Confirmer updateConfirmer)
-
Field Details
-
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
Specifies whether to include aEntityPopupMenu
on this edit panel, triggered with CTRL-ALT-V by default.
Value type: Boolean
Default value: true -
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 -
KEYBOARD_SHORTCUTS
The default keyboard shortcut keyStrokes.
-
-
Method Details
-
editPanel
- Returns:
- the edit panel
-
editControls
- Parameters:
editControls
- if specified only controls with those keys are initialized, null or an empty array will result in no controls being initialized- Returns:
- this Config instance
-
keyStrokes
public EntityEditPanel.Config keyStrokes(Consumer<KeyboardShortcuts<EntityEditPanel.KeyboardShortcut>> shortcuts) - Parameters:
shortcuts
- provides this panelsKeyboardShortcuts
instance.- Returns:
- this Config instance
-
clearAfterInsert
- Parameters:
clearAfterInsert
- controls whether the UI should be cleared after insert has been performed- Returns:
- this Config instance
-
requestFocusAfterInsert
- Parameters:
requestFocusAfterInsert
- controls whether the UI should request focus after insert has been performed- Returns:
- this Config instance
- See Also:
-
referentialIntegrityErrorHandling
public EntityEditPanel.Config referentialIntegrityErrorHandling(ReferentialIntegrityErrorHandling referentialIntegrityErrorHandling) - Parameters:
referentialIntegrityErrorHandling
- controls which action to take on a referential integrity error on delete- Returns:
- this Config instance
-
focusActivation
- Parameters:
focusActivation
- true if the edit panel should be activated when it or its parent EntityPanel receives focus- Returns:
- this Config instance
- See Also:
-
includeEntityMenu
- Parameters:
includeEntityMenu
- true if a entity menu should be included- Returns:
- this Config instance
- See Also:
-
insertConfirmer
- Parameters:
insertConfirmer
- the insert confirmer- Returns:
- this Config instance
-
deleteConfirmer
- Parameters:
deleteConfirmer
- the delete confirmer- Returns:
- this Config instance
-
updateConfirmer
- Parameters:
updateConfirmer
- the update confirmer- Returns:
- this Config instance
-