Module is.codion.framework.model

Package is.codion.framework.model

Interface EditorLink.Builder

All Known Subinterfaces:

ForeignKeyEditorLink.Builder

Enclosing interface:

EditorLink

public static interface EditorLink.Builder

Builds an EditorLink.

The required steps are:

1. EditorLink.Builder.EditorStep.editor(EntityEditor) — bind the detail editor.
2. Then either EditorLink.Builder.ForeignKeyNameStep.foreignKey(ForeignKey) (FK case, all callbacks defaulted from the FK) or EditorLink.Builder.ForeignKeyNameStep.name(String) followed by EditorLink.Builder.LoadStep.condition(DetailCondition), EditorLink.Builder.LoadStep.select(DetailSelect) or EditorLink.Builder.LoadStep.entity(DetailEntity) (non-FK case).

present(Predicate) and beforeInsert(BeforeInsert) are optional.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EditorLink.Builder.EditorStep	The first step — binds the detail editor that the link will describe.
static interface	EditorLink.Builder.ForeignKeyNameStep	The second step — choose whether the link is foreign-key based or named.
static interface	EditorLink.Builder.LoadStep	Required after EditorLink.Builder.ForeignKeyNameStep.name(String) — supplies the load source for the detail entity, expressed as a EditorLink.DetailCondition, EditorLink.DetailSelect or EditorLink.DetailEntity.

Method Summary

Modifier and Type	Method	Description
EditorLink.Builder	beforeInsert(EditorLink.BeforeInsert beforeInsert)	Overrides the EditorLink.BeforeInsert action.
EditorLink	build()
EditorLink.Builder	caption(String caption)	Sets the link caption.
EditorLink.Builder	clearEmpty(boolean clearEmpty)	Specifies whether to clear all values instead of setting defaults when the detail editor is emptied on load, when no detail entity exists.
EditorLink.Builder	present(Predicate<Entity> present)	Sets the presence predicate for the detail editor.

Method Details

present

EditorLink.Builder present(Predicate<Entity> present)

Sets the presence predicate for the detail editor.

At registration time (EntityEditor.DetailEditors.add(EditorLink)) the supplied predicate is installed on the detail editor's EntityEditor.EditorEntity.present() state, replacing any previously-set predicate (it is not wrapped). The predicate is then locked: subsequent attempts to replace it via EntityEditor.Present.predicate() will fail. If a custom presence predicate is needed on a detail editor, supply it here rather than setting it directly on the editor before registration.

Parameters:

present - the presence predicate

Returns:

this builder

beforeInsert

EditorLink.Builder beforeInsert(EditorLink.BeforeInsert beforeInsert)

Overrides the EditorLink.BeforeInsert action.

For FK-based links this overrides the default FK-set; the user must still ensure the foreign key gets set correctly if the framework's default is replaced.

Parameters:

beforeInsert - the action applied to the detail prior to insertion

Returns:

this builder

caption

EditorLink.Builder caption(String caption)

Sets the link caption.

The caption is the human-readable label used by the UI layer when disambiguating components — for example, the suffix in the "Select input field" dialog when the same attribute appears in multiple slots ("Tag (1)", "Tag (Manager)").

Defaults to the link name. Override when the link name is a structural identifier (e.g., the auto-derived foreignKey.name() or sequential numbers used to keep slot names unique) and a different label reads better in the UI.

Parameters:

caption - the link caption

Returns:

this builder

Throws:

IllegalArgumentException - if the caption is null or empty

clearEmpty

EditorLink.Builder clearEmpty(boolean clearEmpty)

Specifies whether to clear all values instead of setting defaults when the detail editor is emptied on load, when no detail entity exists.

Parameters:

clearEmpty - specifies whether to clear the values when the editor is emptied

Returns:

this builder

build

EditorLink build()

Returns:

a new EditorLink