Module is.codion.swing.framework.model

Package is.codion.swing.framework.model

Class SwingEntityEditModel

java.lang.Object

is.codion.framework.model.AbstractEntityEditModel

is.codion.swing.framework.model.SwingEntityEditModel

All Implemented Interfaces:

EntityEditModel

public class SwingEntityEditModel
extends AbstractEntityEditModel

A Swing implementation of EntityEditModel.

Field Summary

Fields inherited from interface is.codion.framework.model.EntityEditModel

EDIT_EVENTS, PERSIST_FOREIGN_KEYS, WARN_ABOUT_UNSAVED_DATA

Constructor Summary

Constructors

Constructor	Description
SwingEntityEditModel(EntityType entityType, EntityConnectionProvider connectionProvider)	Instantiates a new SwingEntityEditModel based on the given entity type.

Method Summary

Modifier and Type	Method	Description
final void	add(ForeignKey foreignKey, Collection<Entity> entities)	Adds the given entities to all foreign key models based on that entity type
final void	clearComboBoxModels()	Clears all combobox models
final <T> FilteredComboBoxModel<T>	comboBoxModel(Column<T> column)	Returns the FilteredComboBoxModel for the given column.
final boolean	containsComboBoxModel(Attribute<?> attribute)
<T> FilteredComboBoxModel<T>	createComboBoxModel(Column<T> column)	Creates a combo box model containing the current values of the given column.
EntityComboBoxModel	createForeignKeyComboBoxModel(ForeignKey foreignKey)	Creates a EntityComboBoxModel for the given foreign key, override to provide a custom EntityComboBoxModel implementation.
final EntityComboBoxModel	foreignKeyComboBoxModel(ForeignKey foreignKey)	Returns the EntityComboBoxModel for the given foreign key attribute.
final void	initializeComboBoxModels(Attribute<?>... attributes)	Creates and refreshes combo box models for the given attributes.
final void	refreshComboBoxModels()	Refreshes all combobox models
final void	refreshForeignKeyComboBoxModels()	Refreshes all foreign key combobox models
final void	remove(ForeignKey foreignKey, Collection<Entity> entities)	Removes the given entities from all foreign key models based on that entity type and clears any foreign key values referencing them.
protected void	replaceForeignKey(ForeignKey foreignKey, Collection<Entity> entities)	For every field referencing the given foreign key values, replaces that foreign key instance with the corresponding entity from values, useful when attribute values have been changed in the referenced entity that must be reflected in the edit model.

Methods inherited from class is.codion.framework.model.AbstractEntityEditModel

addAfterDeleteListener, addAfterInsertListener, addAfterUpdateListener, addBeforeDeleteListener, addBeforeInsertListener, addBeforeUpdateListener, addConfirmOverwriteListener, addEditListener, addEntityListener, addInsertUpdateOrDeleteListener, addValueChangeListener, addValueListener, connectionProvider, containsSearchModel, createForeignKeySearchModel, delete, delete, delete, deleteEnabled, editEvents, entities, entity, entityDefinition, entityType, exists, existsPredicate, foreignKeySearchModel, get, insert, insert, insert, insertEnabled, isNotNull, isNull, modified, modified, modifiedPredicate, notifyAfterDelete, notifyAfterInsert, notifyAfterUpdate, notifyBeforeDelete, notifyBeforeInsert, notifyBeforeUpdate, nullable, optional, overwriteWarning, persist, primaryKeyNull, put, readOnly, referencedEntity, refreshEntity, remove, removeAfterDeleteListener, removeAfterInsertListener, removeAfterUpdateListener, removeBeforeDeleteListener, removeBeforeInsertListener, removeBeforeUpdateListener, removeConfirmOverwriteListener, removeEditListener, removeEntityListener, removeInsertUpdateOrDeleteListener, removeValueChangeListener, removeValueListener, replace, set, setDefault, setDefaults, toString, update, update, update, updateEnabled, updateModifiedState, updateMultipleEnabled, valid, valid, validate, validate, validate, validate, validator, value

Methods inherited from class java.lang.Object

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

Constructor Details

SwingEntityEditModel

public SwingEntityEditModel(EntityType entityType,
 EntityConnectionProvider connectionProvider)

Instantiates a new SwingEntityEditModel based on the given entity type.

Parameters:

entityType - the type of the entity to base this SwingEntityEditModel on

connectionProvider - the EntityConnectionProvider instance

Method Details

initializeComboBoxModels

public final void initializeComboBoxModels(Attribute<?>... attributes)

Creates and refreshes combo box models for the given attributes. Doing this avoids refreshing the data on the EDT when the actual combo boxes are initialized. In case of ForeignKey a foreign key combo box model and in case of a Attribute a attribute combo box model.

Parameters:

attributes - the attributes for which to initialize combo box models

See Also:

• createComboBoxModel(Column)
• createForeignKeyComboBoxModel(ForeignKey)

refreshForeignKeyComboBoxModels

public final void refreshForeignKeyComboBoxModels()

Refreshes all foreign key combobox models

refreshComboBoxModels

public final void refreshComboBoxModels()

Refreshes all combobox models

clearComboBoxModels

public final void clearComboBoxModels()

Clears all combobox models

foreignKeyComboBoxModel

public final EntityComboBoxModel foreignKeyComboBoxModel(ForeignKey foreignKey)

Returns the EntityComboBoxModel for the given foreign key attribute. If one does not exist one is created.

Parameters:

foreignKey - the foreign key attribute

Returns:

a EntityComboBoxModel based on the entity referenced by the given foreign key attribute

See Also:

• createForeignKeyComboBoxModel(ForeignKey)

comboBoxModel

public final <T> FilteredComboBoxModel<T> comboBoxModel(Column<T> column)

Returns the FilteredComboBoxModel for the given column. If one does not exist one is created.

Type Parameters:

T - the value type

Parameters:

column - the column

Returns:

a FilteredComboBoxModel for the given column

See Also:

• createComboBoxModel(Column)

containsComboBoxModel

public final boolean containsComboBoxModel(Attribute<?> attribute)

Parameters:

attribute - the attribute

Returns:

true if this edit model contains a combobox model for the attribute

createForeignKeyComboBoxModel

public EntityComboBoxModel createForeignKeyComboBoxModel(ForeignKey foreignKey)

Creates a EntityComboBoxModel for the given foreign key, override to provide a custom EntityComboBoxModel implementation. This method is called when creating a foreign key EntityComboBoxModel for the edit fields used when editing a single record. This default implementation returns a sorted EntityComboBoxModel with the default nullValueCaption if the underlying attribute is nullable. If the foreign key has select attributes defined, those are set in the combo box model.

Parameters:

foreignKey - the foreign key for which to create a EntityComboBoxModel

Returns:

a EntityComboBoxModel for the given foreign key

See Also:

• FilteredComboBoxModel.COMBO_BOX_NULL_CAPTION
• AttributeDefinition.nullable()
• EntityComboBoxModel.attributes()
• ForeignKeyDefinition.attributes()

createComboBoxModel

public <T> FilteredComboBoxModel<T> createComboBoxModel(Column<T> column)

Creates a combo box model containing the current values of the given column. This default implementation returns a sorted FilteredComboBoxModel with the default nullValueItem if the underlying column is nullable

Type Parameters:

T - the value type

Parameters:

column - the column

Returns:

a combo box model based on the given column

add

public final void add(ForeignKey foreignKey,
 Collection<Entity> entities)

Description copied from interface: EntityEditModel

Adds the given entities to all foreign key models based on that entity type

Parameters:

foreignKey - the foreign key

entities - the values

remove

public final void remove(ForeignKey foreignKey,
 Collection<Entity> entities)

Description copied from interface: EntityEditModel

Removes the given entities from all foreign key models based on that entity type and clears any foreign key values referencing them.

Parameters:

foreignKey - the foreign key

entities - the values

replaceForeignKey

protected void replaceForeignKey(ForeignKey foreignKey,
 Collection<Entity> entities)

Description copied from class: AbstractEntityEditModel

For every field referencing the given foreign key values, replaces that foreign key instance with the corresponding entity from values, useful when attribute values have been changed in the referenced entity that must be reflected in the edit model.

Overrides:

replaceForeignKey in class AbstractEntityEditModel

Parameters:

foreignKey - the foreign key attribute

entities - the foreign key entities