Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui

Class WindowDetailLayout

java.lang.Object

is.codion.swing.framework.ui.WindowDetailLayout

All Implemented Interfaces:

EntityPanel.DetailLayout, EntityPanel.Selector

public final class WindowDetailLayout
extends Object
implements EntityPanel.DetailLayout

A detail layout which displays detail panels in a window, opened via the table popup menu.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WindowDetailLayout.Builder	Builds a WindowDetailLayout instance.
static enum	WindowDetailLayout.WindowType	Specifies the window type.

Method Summary

Modifier and Type	Method	Description
static WindowDetailLayout.Builder	builder()
JComponent	layout(EntityPanel entityPanel)	Creates and lays out the component to use as the main component of the given entity panel, including its detail panels.
is.codion.common.value.Value<EntityPanel.PanelState>	panelState(EntityPanel detailPanel)	Note that the detail panel state may be shared between detail panels, as they may be displayed in a shared window.
void	select(EntityPanel entityPanel)	Selects the given entity panel.
static WindowDetailLayout	windowDetailLayout()
static WindowDetailLayout	windowDetailLayout(WindowDetailLayout.WindowType windowType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface is.codion.swing.framework.ui.EntityPanel.DetailLayout

updateUI

Method Details

layout

public JComponent layout(EntityPanel entityPanel)

Description copied from interface: EntityPanel.DetailLayout

Creates and lays out the component to use as the main component of the given entity panel, including its detail panels. In case of no detail panels, this method should return the EntityPanel.mainPanel().

Specified by:

layout in interface EntityPanel.DetailLayout

Parameters:

entityPanel - the panel to lay out and configure

Returns:

the main component

panelState

public is.codion.common.value.Value<EntityPanel.PanelState> panelState(EntityPanel detailPanel)

Description copied from interface: EntityPanel.DetailLayout

Note that the detail panel state may be shared between detail panels, as they may be displayed in a shared window.

Specified by:

panelState in interface EntityPanel.DetailLayout

Parameters:

detailPanel - the detail panel

Returns:

the value controlling the state of the given detail panel

select

public void select(EntityPanel entityPanel)

Description copied from interface: EntityPanel.Selector

Selects the given entity panel. If the entityPanel is not available, calling this method has no effect.

Specified by:

select in interface EntityPanel.Selector

Parameters:

entityPanel - the entity panel to select

windowDetailLayout

public static WindowDetailLayout windowDetailLayout()

Returns:

a new WindowDetailLayout instance based on WindowDetailLayout.WindowType.DIALOG.

windowDetailLayout

public static WindowDetailLayout windowDetailLayout(WindowDetailLayout.WindowType windowType)

Parameters:

windowType - the window type

Returns:

a new WindowDetailLayout instance based on the given window type.

builder

public static WindowDetailLayout.Builder builder()

Returns:

a new WindowDetailLayout.Builder instance