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

public static final class EntityEditPanel.Config
extends Object

Contains configuration settings for a EntityEditPanel which must be set before the panel is initialized.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	CONFIRM_DELETE	Indicates whether the panel should ask for confirmation before deleting Value type: Boolean Default value: true
static final PropertyValue<Boolean>	CONFIRM_INSERT	Indicates whether the panel should ask for confirmation before inserting Value type: Boolean Default value: false
static final PropertyValue<Boolean>	CONFIRM_UPDATE	Indicates whether the panel should ask for confirmation before updating Value type: Boolean Default value: true
static final PropertyValue<Boolean>	INCLUDE_ENTITY_VIEWER	Specifies whether to include a EntityViewer action on this edit panel, triggered with CTRL-ALT-V by default.
static final PropertyValue<Boolean>	INCLUDE_QUERY_INSPECTOR	Specifies whether to include a Query Inspector on this edit panel, triggered with CTRL-ALT-Q.
static final PropertyValue<Boolean>	MODIFIED_INDICATOR	Specifies whether components should indicate that the value is modified Value type: Boolean Default value: true
static final PropertyValue<Boolean>	MODIFIED_WARNING	Indicates whether the panel should ask for confirmation before discarding unsaved modifications Value type: Boolean Default value: false
static final PropertyValue<Integer>	TEXT_FIELD_COLUMNS	Specifies the default number of text field columns Value type: Integer Default value: 12
static final PropertyValue<Boolean>	TRANSFER_FOCUS_ON_ENTER	Specifies whether components should transfer focus on enter 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
static final PropertyValue<Boolean>	VALID_INDICATOR	Specifies whether components should indicate the validity of their current value Value type: Boolean Default value: true

Method Summary

Modifier and Type	Method	Description
EntityEditPanel.Config	clearAfterInsert(boolean clearAfterInsert)
EntityEditPanel.Config	confirmDelete(boolean confirmDelete)
EntityEditPanel.Config	confirmInsert(boolean confirmInsert)
EntityEditPanel.Config	confirmUpdate(boolean confirmUpdate)
EntityEditPanel.Config	deleteConfirmer(EntityEditPanel.Confirmer deleteConfirmer)
EntityEditPanel.Config	excludeFromSelection(Collection<Attribute<?>> excludeFromSelection)	Specifies the attributes that should be excluded when presenting a component selection list.
EntityEditPanel.Config	focusActivation(boolean focusActivation)
EntityEditPanel.Config	includeEntityViewer(boolean includeEntityViewer)
EntityEditPanel.Config	includeQueryInspector(boolean includeQueryInspector)
EntityEditPanel.Config	insertConfirmer(EntityEditPanel.Confirmer insertConfirmer)
EntityEditPanel.Config	keyStroke(ControlKey<?> controlKey, Consumer<Value<KeyStroke>> keyStroke)
EntityEditPanel.Config	modifiedIndicator(boolean modifiedIndicator)	If set to true then component labels will indicate that the value is modified.
EntityEditPanel.Config	modifiedWarning(boolean modifiedWarning)
EntityEditPanel.Config	referentialIntegrityErrorHandling(ReferentialIntegrityErrorHandling referentialIntegrityErrorHandling)
EntityEditPanel.Config	requestFocusAfterInsert(boolean requestFocusAfterInsert)
EntityEditPanel.Config	textFieldColumns(int textFieldColumns)	Specifies the default number of text field columns
EntityEditPanel.Config	transferFocusOnEnter(boolean transferFocusOnEnter)
EntityEditPanel.Config	updateConfirmer(EntityEditPanel.Confirmer updateConfirmer)
EntityEditPanel.Config	validIndicator(boolean validIndicator)	If set to true then components will indicate whether the current value is valid.

Methods inherited from class java.lang.Object

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

Field Details

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_VIEWER

public static final PropertyValue<Boolean> INCLUDE_ENTITY_VIEWER

Specifies whether to include a EntityViewer action on this edit panel, triggered with CTRL-ALT-V by default.

• Value type: Boolean
• Default value: true

INCLUDE_QUERY_INSPECTOR

public static final PropertyValue<Boolean> INCLUDE_QUERY_INSPECTOR

Specifies whether to include a Query Inspector on this edit panel, triggered with CTRL-ALT-Q.

• Value type: Boolean
• Default value: false

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

CONFIRM_INSERT

public static final PropertyValue<Boolean> CONFIRM_INSERT

Indicates whether the panel should ask for confirmation before inserting

• Value type: Boolean
• Default value: false

CONFIRM_UPDATE

public static final PropertyValue<Boolean> CONFIRM_UPDATE

Indicates whether the panel should ask for confirmation before updating

• Value type: Boolean
• Default value: true

CONFIRM_DELETE

public static final PropertyValue<Boolean> CONFIRM_DELETE

Indicates whether the panel should ask for confirmation before deleting

• Value type: Boolean
• Default value: true

MODIFIED_WARNING

public static final PropertyValue<Boolean> MODIFIED_WARNING

Indicates whether the panel should ask for confirmation before discarding unsaved modifications

• Value type: Boolean
• Default value: false

VALID_INDICATOR

public static final PropertyValue<Boolean> VALID_INDICATOR

Specifies whether components should indicate the validity of their current value

• Value type: Boolean
• Default value: true

See Also:

• ValidIndicator

MODIFIED_INDICATOR

public static final PropertyValue<Boolean> MODIFIED_INDICATOR

Specifies whether components should indicate that the value is modified

• Value type: Boolean
• Default value: true

See Also:

• ModifiedIndicator

TRANSFER_FOCUS_ON_ENTER

public static final PropertyValue<Boolean> TRANSFER_FOCUS_ON_ENTER

Specifies whether components should transfer focus on enter

• Value type: Boolean
• Default value: true

TEXT_FIELD_COLUMNS

public static final PropertyValue<Integer> TEXT_FIELD_COLUMNS

Specifies the default number of text field columns

• Value type: Integer
• Default value: 12

Method Details

keyStroke

public EntityEditPanel.Config keyStroke(ControlKey<?> controlKey,
 Consumer<Value<KeyStroke>> keyStroke)

Parameters:

controlKey - the control key

keyStroke - provides access to the Value controlling the keyStroke for the given control

Returns:

this Config instance

clearAfterInsert

public EntityEditPanel.Config clearAfterInsert(boolean clearAfterInsert)

Parameters:

clearAfterInsert - controls whether the UI should be cleared after insert has been performed

Returns:

this Config instance

requestFocusAfterInsert

public EntityEditPanel.Config requestFocusAfterInsert(boolean requestFocusAfterInsert)

Parameters:

requestFocusAfterInsert - controls whether the UI should request focus after insert has been performed

Returns:

this Config instance

See Also:

• EntityEditPanel.InputFocus.afterInsert()

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

public EntityEditPanel.Config focusActivation(boolean 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:

• USE_FOCUS_ACTIVATION

includeEntityViewer

public EntityEditPanel.Config includeEntityViewer(boolean includeEntityViewer)

Parameters:

includeEntityViewer - true if a EntityViewer action should be available in this panel, triggered with CTRL-ALT-V.

Returns:

this Config instance

See Also:

• INCLUDE_ENTITY_VIEWER

includeQueryInspector

public EntityEditPanel.Config includeQueryInspector(boolean includeQueryInspector)

Parameters:

includeQueryInspector - true if a Query Inspector should be available in this edit panel, triggered with CTRL-ALT-Q.

Returns:

this Config instance

confirmInsert

public EntityEditPanel.Config confirmInsert(boolean confirmInsert)

Parameters:

confirmInsert - whether to confirm before inserting

Returns:

this Config instance

See Also:

• insertConfirmer(Confirmer)
• CONFIRM_INSERT

confirmUpdate

public EntityEditPanel.Config confirmUpdate(boolean confirmUpdate)

Parameters:

confirmUpdate - whether to confirm before updating

Returns:

this Config instance

See Also:

• updateConfirmer(Confirmer)
• CONFIRM_UPDATE

confirmDelete

public EntityEditPanel.Config confirmDelete(boolean confirmDelete)

Parameters:

confirmDelete - whether to confirm before deleting

Returns:

this Config instance

See Also:

• deleteConfirmer(Confirmer)
• CONFIRM_DELETE

insertConfirmer

public EntityEditPanel.Config insertConfirmer(EntityEditPanel.Confirmer insertConfirmer)

Parameters:

insertConfirmer - the insert confirmer

Returns:

this Config instance

See Also:

• confirmInsert(boolean)

deleteConfirmer

public EntityEditPanel.Config deleteConfirmer(EntityEditPanel.Confirmer deleteConfirmer)

Parameters:

deleteConfirmer - the delete confirmer

Returns:

this Config instance

See Also:

• confirmDelete(boolean)

updateConfirmer

public EntityEditPanel.Config updateConfirmer(EntityEditPanel.Confirmer updateConfirmer)

Parameters:

updateConfirmer - the update confirmer

Returns:

this Config instance

See Also:

• confirmUpdate(boolean)

excludeFromSelection

public EntityEditPanel.Config excludeFromSelection(Collection<Attribute<?>> excludeFromSelection)

Specifies the attributes that should be excluded when presenting a component selection list.

Parameters:

excludeFromSelection - a Collection containing the attributes to exclude from component selection

Returns:

this Config instance

Throws:

IllegalArgumentException - in case an attribute is not found in the underlying entity

See Also:

• EntityEditPanel.selectInputComponent()

modifiedWarning

public EntityEditPanel.Config modifiedWarning(boolean modifiedWarning)

Parameters:

modifiedWarning - specifies whether this edit panel presents a warning before discarding unsaved modifications

Returns:

this Config instance

See Also:

• MODIFIED_WARNING
• EntityEditor.modified()
• EntityEditor.EditorEntity.set(Entity)
• EntityEditor.defaults()

validIndicator

public EntityEditPanel.Config validIndicator(boolean validIndicator)

If set to true then components will indicate whether the current value is valid. This applies to all components created by this edit component panel as well as components set via EntityEditPanel.component(Attribute)

Parameters:

validIndicator - specifies whether components should indicate validity

Returns:

this Config instance

See Also:

• VALID_INDICATOR
• ValidIndicator

modifiedIndicator

public EntityEditPanel.Config modifiedIndicator(boolean modifiedIndicator)

If set to true then component labels will indicate that the value is modified. This applies to all components created by this edit component panel as well as components set via EntityEditPanel.component(Attribute) as long as the component has a JLabel associated with its 'labeledBy' client property.

Parameters:

modifiedIndicator - specifies whether components should indicate modification

Returns:

this Config instance

See Also:

• MODIFIED_INDICATOR
• JLabel.setLabelFor(Component)

textFieldColumns

public EntityEditPanel.Config textFieldColumns(int textFieldColumns)

Specifies the default number of text field columns

Parameters:

textFieldColumns - the default number of text field columns

Returns:

this Config instance

See Also:

• JTextField.setColumns(int)
• TEXT_FIELD_COLUMNS

transferFocusOnEnter

public EntityEditPanel.Config transferFocusOnEnter(boolean transferFocusOnEnter)

Parameters:

transferFocusOnEnter - specifies whether components will transfer focus on enter

Returns:

this Config instance

See Also:

• TRANSFER_FOCUS_ON_ENTER