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

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    |
 |                  |   panels    |
 |   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.

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

NONE

Method Summary

Modifier and Type	Method	Description
static TabbedDetailLayout.Builder	builder(EntityPanel entityPanel)
Optional<EntityPanel.DetailController>	controller()
Optional<JComponent>	layout()	Lays out a given EntityPanel along with its detail panels.
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 Optional<JComponent> layout()

Description copied from interface: EntityPanel.DetailLayout

Lays out a given EntityPanel along with its detail panels. In case of no special detail panel layout requirements, this method should return an empty Optional.

Specified by:

layout in interface EntityPanel.DetailLayout

Returns:

the panel laid out with it detail panels or an empty Optional in case of no special layout component.

controller

public Optional<EntityPanel.DetailController> controller()

Specified by:

controller in interface EntityPanel.DetailLayout

Returns:

the detail controller for this layout, an empty Optional if none is available

builder

public static TabbedDetailLayout.Builder builder(EntityPanel entityPanel)

Parameters:

entityPanel - the entity panel

Returns:

a new TabbedDetailLayout.Builder instance