Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui

Interface EntityPanel.Builder

Enclosing class:

EntityPanel

public static interface EntityPanel.Builder

A builder for EntityPanel instances.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityPanel.Builder.EntityTypeStep	Provides a EntityPanel.Builder.PanelBuilder
static interface	EntityPanel.Builder.PanelBuilder	Provides a EntityPanel.Builder

Method Summary

Modifier and Type	Method	Description
EntityPanel	build(EntityConnectionProvider connectionProvider)	Builds an EntityPanel based on this builder configuration.
Optional<String>	caption()
EntityPanel.Builder	caption(@Nullable String caption)
Optional<String>	description()
EntityPanel.Builder	description(@Nullable String description)
EntityType	entityType()
Optional<ControlIcon>	icon()
EntityPanel.Builder	icon(@Nullable ControlIcon icon)

Method Details

entityType

EntityType entityType()

Returns:

the entityType

caption

EntityPanel.Builder caption(@Nullable String caption)

Parameters:

caption - the panel caption

Returns:

this builder instance

caption

Optional<String> caption()

Returns:

the caption, an empty Optional if none has been set

description

EntityPanel.Builder description(@Nullable String description)

Parameters:

description - the panel description

Returns:

this builder instance

description

Optional<String> description()

Returns:

the description, an empty Optional if none has been set

icon

EntityPanel.Builder icon(@Nullable ControlIcon icon)

Parameters:

icon - the panel icon

Returns:

this builder instance

icon

Optional<ControlIcon> icon()

Returns:

the icon, an empty Optional if none has been set

build

EntityPanel build(EntityConnectionProvider connectionProvider)

Builds an EntityPanel based on this builder configuration.

Parameters:

connectionProvider - the connection provider

Returns:

an EntityPanel based on this builder