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.

Method Summary

Modifier and Type	Method	Description
EntityPanel	build(EntityConnectionProvider connectionProvider)	Builds an EntityPanel based on this builder configuration.
EntityPanel	build(SwingEntityModel model)	Builds an EntityPanel based on this builder configuration
Optional<String>	caption()
EntityPanel.Builder	caption(String caption)
EntityPanel.Builder	conditionView(ConditionPanel.ConditionView conditionView)
Optional<String>	description()
EntityPanel.Builder	description(String description)
EntityPanel.Builder	detailLayout(Function<EntityPanel,EntityPanel.DetailLayout> detailLayout)
EntityPanel.Builder	detailPanel(EntityPanel.Builder panelBuilder)	Adds the given detail panel builder to this panel builder, if it hasn't been previously added
EntityPanel.Builder	editPanel(Class<? extends EntityEditPanel> editPanelClass)
EntityType	entityType()
EntityPanel.Builder	filterView(ConditionPanel.ConditionView filterView)
Optional<ImageIcon>	icon()
EntityPanel.Builder	icon(ImageIcon icon)
EntityPanel.Builder	onBuildEditPanel(Consumer<EntityEditPanel> onBuildEditPanel)
EntityPanel.Builder	onBuildPanel(Consumer<EntityPanel> onBuildPanel)
EntityPanel.Builder	onBuildTablePanel(Consumer<EntityTablePanel> onBuildTablePanel)
EntityPanel.Builder	panel(Class<? extends EntityPanel> panelClass)	Note that setting the EntityPanel class overrides any EntityTablePanel or EntityEditPanel classes that have been set.
EntityPanel.Builder	preferredSize(Dimension preferredSize)
EntityPanel.Builder	refreshWhenInitialized(boolean refreshWhenInitialized)	Default true.
EntityPanel.Builder	tablePanel(Class<? extends EntityTablePanel> tablePanelClass)

Method Details

entityType

EntityType entityType()

Returns:

the entityType

caption

EntityPanel.Builder caption(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(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(ImageIcon icon)

Parameters:

icon - the panel icon

Returns:

this builder instance

icon

Optional<ImageIcon> icon()

Returns:

the icon, an empty Optional if none has been set

detailPanel

EntityPanel.Builder detailPanel(EntityPanel.Builder panelBuilder)

Adds the given detail panel builder to this panel builder, if it hasn't been previously added

Parameters:

panelBuilder - the detail panel provider

Returns:

this builder instance

refreshWhenInitialized

EntityPanel.Builder refreshWhenInitialized(boolean refreshWhenInitialized)

Default true.

Parameters:

refreshWhenInitialized - if true then the table model this panel is based on will be refreshed when the panel is initialized

Returns:

this builder instance

conditionView

EntityPanel.Builder conditionView(ConditionPanel.ConditionView conditionView)

Parameters:

conditionView - the initial condition panel view

Returns:

this builder instance

filterView

EntityPanel.Builder filterView(ConditionPanel.ConditionView filterView)

Parameters:

filterView - the initial filter panel view

Returns:

this builder instance

detailLayout

EntityPanel.Builder detailLayout(Function<EntityPanel,EntityPanel.DetailLayout> detailLayout)

Parameters:

detailLayout - provides the detail panel layout to use

Returns:

this builder instane

preferredSize

EntityPanel.Builder preferredSize(Dimension preferredSize)

Parameters:

preferredSize - the preferred panel size

Returns:

this builder instance

panel

EntityPanel.Builder panel(Class<? extends EntityPanel> panelClass)

Note that setting the EntityPanel class overrides any EntityTablePanel or EntityEditPanel classes that have been set.

Parameters:

panelClass - the EntityPanel class to use when creating the panel

Returns:

this builder instance

See Also:

• EntityPanel.editPanel()
• EntityPanel.tablePanel()

editPanel

EntityPanel.Builder editPanel(Class<? extends EntityEditPanel> editPanelClass)

Parameters:

editPanelClass - the EntityEditPanel class to use when creating the panel

Returns:

this builder instance

tablePanel

EntityPanel.Builder tablePanel(Class<? extends EntityTablePanel> tablePanelClass)

Parameters:

tablePanelClass - the EntityTablePanel class to use when creating the panel

Returns:

this builder instance

onBuildPanel

EntityPanel.Builder onBuildPanel(Consumer<EntityPanel> onBuildPanel)

Parameters:

onBuildPanel - called after the EntityPanel has been built

Returns:

this builder instance

onBuildEditPanel

EntityPanel.Builder onBuildEditPanel(Consumer<EntityEditPanel> onBuildEditPanel)

Parameters:

onBuildEditPanel - called after the EntityEditPanel has been built

Returns:

this builder instance

onBuildTablePanel

EntityPanel.Builder onBuildTablePanel(Consumer<EntityTablePanel> onBuildTablePanel)

Parameters:

onBuildTablePanel - called after the EntityTablePanel has been built

Returns:

this builder instance

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

Throws:

IllegalStateException - in case no SwingEntityModel.Builder has been set

build

EntityPanel build(SwingEntityModel model)

Builds an EntityPanel based on this builder configuration

Parameters:

model - the SwingEntityModel to base the panel on

Returns:

an EntityPanel based on this builder