Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui

Class EditorComponents

java.lang.Object

is.codion.swing.framework.ui.EditorComponents

public final class EditorComponents
extends Object

Manages the components for a SwingEntityEditor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EditorComponents.ComponentSettings	Manages settings that are applied to a component builder when set.
static final class	EditorComponents.CreateComponents	Creates SwingEntityEditor based components
final class	EditorComponents.EditorComponent<T>

Method Summary

Modifier and Type	Method	Description
<T> EditorComponents.EditorComponent<T>	component(Attribute<T> attribute)
EditorComponents.CreateComponents	create()
EditorComponents	detail(ForeignKey foreignKey)
EditorComponents	detail(String name)
SwingEntityEditor	editor()
static EditorComponents	editorComponents(SwingEntityEditor editor)
EditorComponents.ComponentSettings	settings()

Methods inherited from class java.lang.Object

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

Method Details

editor

public SwingEntityEditor editor()

Returns:

the underlying editor

settings

public EditorComponents.ComponentSettings settings()

Returns:

the component settings

create

public EditorComponents.CreateComponents create()

Returns:

the EditorComponents.CreateComponents instance

component

public <T> EditorComponents.EditorComponent<T> component(Attribute<T> attribute)

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

Returns:

the EditorComponents.EditorComponent containing the component associated with the given attribute

detail

public EditorComponents detail(ForeignKey foreignKey)

Parameters:

foreignKey - the foreign key

Returns:

a detail EditorComponents instance based on the given foreign key

Throws:

IllegalStateException - if no detail editor is registered for the foreign key, or if multiple detail editors are registered for it (use detail(String) with an explicit name in that case)

See Also:

• EntityEditor.detail()

detail

public EditorComponents detail(String name)

Parameters:

name - the detail editor name

Returns:

a detail EditorComponents instance based on the given name

Throws:

IllegalArgumentException - in case no detail editor has been set for the given name

See Also:

• EntityEditor.detail()

editorComponents

public static EditorComponents editorComponents(SwingEntityEditor editor)

Parameters:

editor - the editor

Returns:

a new EditorComponents instance