Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui

Class TabbedDetailLayout

java.lang.Object

is.codion.swing.framework.ui.TabbedDetailLayout

All Implemented Interfaces:

EntityPanel.DetailLayout, EntityPanel.Selector

public final class TabbedDetailLayout
extends Object
implements EntityPanel.DetailLayout

A EntityPanel.DetailLayout implementation based on a JTabbedPane.

 The default layout is as follows:
 __________________________________
 |  edit    |control|             |
 |  panel   | panel |             |
 |__________|_______|   detail    |
 |                  |   panel     |
 |   table panel    |             |
 |(EntityTablePanel)|             |
 |                  |             |
 |__________________|_____________|
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TabbedDetailLayout.Builder	Builds a TabbedDetailLayout.
static enum	TabbedDetailLayout.KeyboardShortcut	The available keyboard shortcuts.

Field Summary

Fields

Modifier and Type	Field	Description
static final is.codion.common.property.PropertyValue<Boolean>	INCLUDE_CONTROLS	Specifies whether actions to hide detail panels or show them in a dialog should be available to the user, for example in a popup menu or on a toolbar. Value type: Boolean Default value: true
static final is.codion.swing.common.ui.key.KeyboardShortcuts<TabbedDetailLayout.KeyboardShortcut>	KEYBOARD_SHORTCUTS	The default keyboard shortcut keyStrokes.

Method Summary

Modifier and Type	Method	Description
static TabbedDetailLayout.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.
void	updateUI()	Updates the UI of all associated components.

Methods inherited from class java.lang.Object

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

Field Details

INCLUDE_CONTROLS

public static final is.codion.common.property.PropertyValue<Boolean> INCLUDE_CONTROLS

Specifies whether actions to hide detail panels or show them in a dialog should be available to the user, for example in a popup menu or on a toolbar.
Value type: Boolean
Default value: true

KEYBOARD_SHORTCUTS

public static final is.codion.swing.common.ui.key.KeyboardShortcuts<TabbedDetailLayout.KeyboardShortcut> KEYBOARD_SHORTCUTS

The default keyboard shortcut keyStrokes.

Method Details

updateUI

public void updateUI()

Description copied from interface: EntityPanel.DetailLayout

Updates the UI of all associated components. Override to update the UI of components that may be hidden and therefore not updated along with the component tree.

Specified by:

updateUI in interface EntityPanel.DetailLayout

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

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

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

builder

public static TabbedDetailLayout.Builder builder()

Returns:

a new TabbedDetailLayout.Builder instance