Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui

Class EntityPanel.Config

java.lang.Object

is.codion.swing.framework.ui.EntityPanel.Config

Enclosing class:

EntityPanel

public static final class EntityPanel.Config
extends Object

Contains configuration settings for a EntityPanel which must be set before the panel is initialized.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<String>	CONTROL_PANEL_CONSTRAINTS	Specifies where the control panel should be placed in a BorderLayout Value type: String Default value: BorderLayout.EAST
static final PropertyValue<String>	CONTROL_TOOLBAR_CONSTRAINTS	Specifies where the control toolbar should be placed in a BorderLayout Value type: String Default value: BorderLayout.WEST
static final PropertyValue<Boolean>	DISPOSE_EDIT_DIALOG_ON_ESCAPE	Indicates whether entity edit panel dialogs should be closed on escape Value type: Boolean Default value: true
static final PropertyValue<String>	EDIT_PANEL_CONSTRAINTS	Specifies where the edit panel should be placed in a BorderLayout Value type: Boolean Default value: BorderLayout.NORTH
static final PropertyValue<Boolean>	INCLUDE_CONTROLS	Specifies whether entity panels should include controls by default Value type: Boolean Default value: true
static final PropertyValue<Boolean>	INCLUDE_TOGGLE_EDIT_PANEL_CONTROL	Specifies whether a control for toggling the edit panel is available to the user Value type: Boolean Default value: true
static final PropertyValue<Boolean>	TOOLBAR_CONTROLS	Specifies whether the edit controls (Save, update, delete, clear, refresh) should be on a toolbar instead of a button panel Value type: Boolean Default value: false
static final PropertyValue<Boolean>	USE_KEYBOARD_NAVIGATION	Indicates whether keyboard navigation will be enabled Value type: Boolean Default value: true
static final PropertyValue<EntityPanel.WindowType>	WINDOW_TYPE	Specifies how detail and edit panels should be displayed.

Method Summary

Modifier and Type	Method	Description
EntityPanel.Config	caption(String caption)
EntityPanel.Config	controlComponent(Function<Controls,JComponent> controlComponent)	Creates the component to place next to the edit panel, containing the available controls, such as insert, update, delete, clear and refresh.
EntityPanel.Config	controlComponentConstraints(String controlComponentConstraints)	Sets the layout constraints to use for the control panel.
EntityPanel.Config	description(String description)
EntityPanel.Config	detailLayout(Function<EntityPanel,EntityPanel.DetailLayout> detailLayout)
EntityPanel.Config	disposeEditDialogOnEscape(boolean disposeEditDialogOnEscape)
EntityPanel.Config	editBasePanel(Function<EntityEditPanel,JPanel> editBasePanel)	Creates a base panel containing the given edit panel.
EntityPanel.Config	editPanelConstraints(String editPanelConstraints)
EntityPanel.Config	enabledEditStates(EntityPanel.PanelState... editStates)	Sets the enabled edit panel states.
<T extends EntityPanel> T	entityPanel()
EntityPanel.Config	icon(ImageIcon icon)
EntityPanel.Config	includeControls(boolean includeControls)
EntityPanel.Config	includeToggleEditPanelControl(boolean includeToggleEditPanelControl)
EntityPanel.Config	initialEditState(EntityPanel.PanelState initialState)	Default EntityPanel.PanelState.EMBEDDED
EntityPanel.Config	keyStroke(ControlKey<?> controlKey, Consumer<Value<KeyStroke>> keyStroke)
EntityPanel.Config	toolbarControls(boolean toolbarControls)	Overridden by controlComponent(Function).
EntityPanel.Config	useKeyboardNavigation(boolean useKeyboardNavigation)
EntityPanel.Config	windowType(EntityPanel.WindowType windowType)

Methods inherited from class java.lang.Object

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

Field Details

USE_KEYBOARD_NAVIGATION

public static final PropertyValue<Boolean> USE_KEYBOARD_NAVIGATION

Indicates whether keyboard navigation will be enabled

• Value type: Boolean
• Default value: true

DISPOSE_EDIT_DIALOG_ON_ESCAPE

public static final PropertyValue<Boolean> DISPOSE_EDIT_DIALOG_ON_ESCAPE

Indicates whether entity edit panel dialogs should be closed on escape

• Value type: Boolean
• Default value: true

INCLUDE_TOGGLE_EDIT_PANEL_CONTROL

public static final PropertyValue<Boolean> INCLUDE_TOGGLE_EDIT_PANEL_CONTROL

Specifies whether a control for toggling the edit panel is available to the user

• Value type: Boolean
• Default value: true

TOOLBAR_CONTROLS

public static final PropertyValue<Boolean> TOOLBAR_CONTROLS

Specifies whether the edit controls (Save, update, delete, clear, refresh) should be on a toolbar instead of a button panel

• Value type: Boolean
• Default value: false

WINDOW_TYPE

public static final PropertyValue<EntityPanel.WindowType> WINDOW_TYPE

Specifies how detail and edit panels should be displayed.

• Value type: EntityPanel.WindowType
• Default value: EntityPanel.WindowType.DIALOG

CONTROL_PANEL_CONSTRAINTS

public static final PropertyValue<String> CONTROL_PANEL_CONSTRAINTS

Specifies where the control panel should be placed in a BorderLayout

• Value type: String
• Default value: BorderLayout.EAST

See Also:

• TOOLBAR_CONTROLS

CONTROL_TOOLBAR_CONSTRAINTS

public static final PropertyValue<String> CONTROL_TOOLBAR_CONSTRAINTS

Specifies where the control toolbar should be placed in a BorderLayout

• Value type: String
• Default value: BorderLayout.WEST

See Also:

• TOOLBAR_CONTROLS

EDIT_PANEL_CONSTRAINTS

public static final PropertyValue<String> EDIT_PANEL_CONSTRAINTS

Specifies where the edit panel should be placed in a BorderLayout

• Value type: Boolean
• Default value: BorderLayout.NORTH

INCLUDE_CONTROLS

public static final PropertyValue<Boolean> INCLUDE_CONTROLS

Specifies whether entity panels should include controls by default

• Value type: Boolean
• Default value: true

Method Details

entityPanel

public <T extends EntityPanel> T entityPanel()

Type Parameters:

T - the panel type

Returns:

the entity panel

caption

public EntityPanel.Config caption(String caption)

Parameters:

caption - the caption to use when presenting this panel

Returns:

this Config instance

description

public EntityPanel.Config description(String description)

Parameters:

description - the description to use when presenting this panel

Returns:

this Config instance

icon

public EntityPanel.Config icon(ImageIcon icon)

Parameters:

icon - the icon to use when presenting this panel

Returns:

this Config instance

detailLayout

public EntityPanel.Config detailLayout(Function<EntityPanel,EntityPanel.DetailLayout> detailLayout)

Parameters:

detailLayout - provides the detail panel layout

Returns:

this Config instance

controlComponent

public EntityPanel.Config controlComponent(Function<Controls,JComponent> controlComponent)

Creates the component to place next to the edit panel, containing the available controls, such as insert, update, delete, clear and refresh.

Parameters:

controlComponent - creates the controls panel

Returns:

this Config instance

See Also:

• EntityPanel.control(ControlKey)
• EntityEditPanel.controls()
• EntityPanel.configureControls(Consumer)
• TOOLBAR_CONTROLS
• CONTROL_PANEL_CONSTRAINTS
• CONTROL_TOOLBAR_CONSTRAINTS
• includeControls(boolean)

editBasePanel

public EntityPanel.Config editBasePanel(Function<EntityEditPanel,JPanel> editBasePanel)

Creates a base panel containing the given edit panel. The default layout is a FlowLayout with the alignment depending on controlComponentConstraints(String).

Parameters:

editBasePanel - creates the edit base panel

Returns:

this Config instance

See Also:

• controlComponentConstraints(String)

toolbarControls

public EntityPanel.Config toolbarControls(boolean toolbarControls)

Overridden by controlComponent(Function).

Parameters:

toolbarControls - true if the edit controls should be on a toolbar instead of a button panel

Returns:

this Config instance

See Also:

• TOOLBAR_CONTROLS

controlComponentConstraints

public EntityPanel.Config controlComponentConstraints(String controlComponentConstraints)

Sets the layout constraints to use for the control panel.

 The default layout is as follows (BorderLayout.WEST):
 __________________________________
 |   edit panel           |control|
 |  (EntityEditPanel)     | panel | } editControlPanel
 |________________________|_______|

 With (BorderLayout.SOUTH):
 __________________________
 |         edit           |
 |        panel           |
 |________________________| } editControlPanel
 |     control panel      |
 |________________________|

 etc.
 

Parameters:

controlComponentConstraints - the controls component layout constraints (BorderLayout constraints)

Returns:

this Config instance

Throws:

IllegalArgumentException - in case the given constraint is not one of BorderLayout.SOUTH, NORTH, EAST or WEST

editPanelConstraints

public EntityPanel.Config editPanelConstraints(String editPanelConstraints)

Parameters:

editPanelConstraints - the edit panel constraints

Returns:

this Config instance

Throws:

IllegalArgumentException - in case the given constraint is not one of BorderLayout.SOUTH, NORTH, EAST or WEST

includeToggleEditPanelControl

public EntityPanel.Config includeToggleEditPanelControl(boolean includeToggleEditPanelControl)

Parameters:

includeToggleEditPanelControl - true if a control for toggling the edit panel should be included

Returns:

this Config instance

includeControls

public EntityPanel.Config includeControls(boolean includeControls)

Parameters:

includeControls - true if the edit and table panel controls should be included

Returns:

this Config instance

useKeyboardNavigation

public EntityPanel.Config useKeyboardNavigation(boolean useKeyboardNavigation)

Parameters:

useKeyboardNavigation - true if keyboard navigation should be enabled

Returns:

this Config instance

windowType

public EntityPanel.Config windowType(EntityPanel.WindowType windowType)

Parameters:

windowType - the window type to use when presenting panels

Returns:

this Config instance

See Also:

• WINDOW_TYPE

keyStroke

public EntityPanel.Config keyStroke(ControlKey<?> controlKey,
 Consumer<Value<KeyStroke>> keyStroke)

Parameters:

controlKey - the control key

keyStroke - provides access to the Value controlling the key stroke for the given control

Returns:

this Config instance

initialEditState

public EntityPanel.Config initialEditState(EntityPanel.PanelState initialState)

Default EntityPanel.PanelState.EMBEDDED

Parameters:

initialState - the initial edit panel state

Returns:

this Config instance

Throws:

IllegalArgumentException - in case the given state is EntityPanel.PanelState.WINDOW

IllegalArgumentException - in case the given state is not enabled

See Also:

• enabledEditStates(PanelState...)

enabledEditStates

public EntityPanel.Config enabledEditStates(EntityPanel.PanelState... editStates)

Sets the enabled edit panel states.

Parameters:

editStates - the enabled states

Returns:

this Config instance

Throws:

IllegalArgumentException - in case the given states do not include the initial state

IllegalArgumentException - in case no editStates are specified

See Also:

• initialEditState(PanelState)

disposeEditDialogOnEscape

public EntityPanel.Config disposeEditDialogOnEscape(boolean disposeEditDialogOnEscape)

Parameters:

disposeEditDialogOnEscape - specifies whether entity edit panel dialogs should be closed on escape

Returns:

this Config instance