Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui

Class EntityTablePanel.ControlKeys

java.lang.Object

is.codion.swing.framework.ui.EntityTablePanel.ControlKeys

Enclosing class:

EntityTablePanel

public static final class EntityTablePanel.ControlKeys
extends Object

The Controls available in a EntityTablePanel

A control given a key stroke is available while the table panel, or a component within it, has the focus, apart from the ones acting on the table, available while the table has the focus: ADD, EDIT, EDIT_ATTRIBUTE, DELETE, DECREMENT_SELECTION, INCREMENT_SELECTION, INSPECT_QUERY, VIEW_ENTITY, POPUP_MENU, CLEAR_SELECTION, COPY_CELL, COPY_COLUMN, COPY_ROWS and VIEW_DEPENDENCIES. Two controls available in the same place can not have the same key stroke, the panel throwing an IllegalStateException when initialized.

Note: CTRL in key stroke descriptions represents the platform menu shortcut key (CTRL on Windows/Linux, ⌘ on macOS).

Field Summary

Fields

Modifier and Type	Field	Description
static final ControlKey<CommandControl>	ADD	Add a new entity instance. Default key stroke: INSERT
static final ControlKey<Controls>	ADDITIONAL_POPUP_MENU_CONTROLS	A Controls instance containing any additional popup menu controls.
static final ControlKey<Controls>	ADDITIONAL_TOOLBAR_CONTROLS	A Controls instance containing any additional toolbar controls.
static final ControlKey<CommandControl>	CLEAR	A Control for clearing the data from the table.
static final ControlKey<CommandControl>	CLEAR_SELECTION	A Control for clearing the table selection.
static final Controls.ControlsKey	COLUMN_CONTROLS	A Controls instance containing controls for configuring columns.
static final ControlKey<Controls>	CONDITION_CONTROLS	A Controls instance containing the condition panel controls.
static final ControlKey<CommandControl>	COPY_CELL	A Control for copying the selected cell data. Default key stroke: CTRL-ALT-C
static final ControlKey<CommandControl>	COPY_COLUMN	A Control for copying the selected column data. Default key stroke: CTRL-ALT-SHIFT-C
static final Controls.ControlsKey	COPY_CONTROLS	A Controls instance containing controls for copying either cell or table data.
static final ControlKey<CommandControl>	COPY_ROWS	A Control for copying the table rows with header.
static final ControlKey<CommandControl>	DECREMENT_SELECTION	Decrements the selected indexes, moving the selection up. Default key stroke: CTRL-SHIFT-UP
static final ControlKey<CommandControl>	DELETE	Triggers the DELETE control. Default key stroke: DELETE
static final ControlKey<CommandControl>	EDIT	Edit the selected entity instance. Default key stroke: CTRL-INSERT
static final ControlKey<CommandControl>	EDIT_ATTRIBUTE	Select and edit a single attribute value for the selected entity instances. Default key stroke: SHIFT-INSERT
static final ControlKey<Controls>	EDIT_ATTRIBUTE_CONTROLS	A Controls instance containing edit controls for all editable attributes.
static final ControlKey<CommandControl>	EXPORT	A Control for exporting the table data.
static final ControlKey<Controls>	FILTER_CONTROLS	A Controls instance containing the filter panel controls.
static final ControlKey<CommandControl>	FOCUS_SEARCH_FIELD	Requests focus for the table search field, if one is available. Default key stroke: CTRL-F
static final ControlKey<CommandControl>	FOCUS_TABLE	Requests focus for the table. Default key stroke: CTRL-T
static final ControlKey<CommandControl>	INCREMENT_SELECTION	Increments the selected indexes, moving the selection down. Default key stroke: CTRL-SHIFT-DOWN
static final ControlKey<CommandControl>	INSPECT_QUERY	Displays the query inspector, if one is available. Default key stroke: CTRL-ALT-Q
static final ControlKey<CommandControl>	POPUP_MENU	Displays the table popup menu, if one is available. Default key stroke: CTRL-G
static final ControlKey<CommandControl>	PRINT	The main print action Default key stroke: CTRL-P
static final ControlKey<Controls>	PRINT_CONTROLS	A Controls instance containing controls for printing.
static final ControlKey<CommandControl>	REFRESH	A Control for refreshing the table items. Default key stroke: ALT-R
static final ControlKey<CommandControl>	RESET_COLUMNS	A Control for resetting the columns to their original visibility and location.
static final ControlKey<CommandControl>	SELECT_AUTO_RESIZE_MODE	A Control for displaying a dialog for configuring the column auto-resize-mode.
static final ControlKey<CommandControl>	SELECT_COLUMNS	A Control for displaying a dialog for selecting the visible table columns.
static final ControlKey<CommandControl>	SELECT_CONDITION	Displays a dialog for selecting a column condition panel. Default key stroke: CTRL-S
static final ControlKey<CommandControl>	SELECT_FILTER	Displays a dialog for selecting a column filter panel. Default key stroke: CTRL-SHIFT-F
static final ControlKey<ToggleControl>	SINGLE_SELECTION	A Control for toggling between single and multi selection mode.
static final ControlKey<Controls>	TOGGLE_AUTO_RESIZE_MODE_CONTROLS	A Controls instance containing a ToggleControl for each auto-resize-mode.
static final ControlKey<Controls>	TOGGLE_COLUMN_CONTROLS	A Controls instance containing a ToggleControl for each columns' visibility.
static final ControlKey<CommandControl>	TOGGLE_CONDITION_VIEW	Toggles the condition panel between the hidden, simple and advanced views. Default key stroke: CTRL-ALT-S
static final ControlKey<CommandControl>	TOGGLE_FILTER_VIEW	Toggles the filter panel between the hidden, simple and advanced views. Default key stroke: CTRL-ALT-F
static final ControlKey<ToggleControl>	TOGGLE_SUMMARIES	A ToggleControl for showing/hiding the summary panel.
static final ControlKey<CommandControl>	VIEW_DEPENDENCIES	A Control for viewing the dependencies of the selected entities.
static final ControlKey<CommandControl>	VIEW_ENTITY	Displays the entity viewer, if one is available. Default key stroke: CTRL-ALT-V

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

ADD

public static final ControlKey<CommandControl> ADD

Add a new entity instance.
Default key stroke: INSERT

See Also:

• EntityTablePanel(SwingEntityTableModel, EntityEditPanel)
• EntityTablePanel(SwingEntityTableModel, EntityEditPanel, Consumer)

EDIT

public static final ControlKey<CommandControl> EDIT

Edit the selected entity instance.
Default key stroke: CTRL-INSERT

See Also:

• EntityTablePanel(SwingEntityTableModel, EntityEditPanel)
• EntityTablePanel(SwingEntityTableModel, EntityEditPanel, Consumer)

EDIT_ATTRIBUTE

public static final ControlKey<CommandControl> EDIT_ATTRIBUTE

Select and edit a single attribute value for the selected entity instances.
Default key stroke: SHIFT-INSERT

See Also:

• EntityTablePanel.Config.editAttributeSelection(SelectionMode)

FOCUS_TABLE

public static final ControlKey<CommandControl> FOCUS_TABLE

Requests focus for the table.
Default key stroke: CTRL-T

TOGGLE_CONDITION_VIEW

public static final ControlKey<CommandControl> TOGGLE_CONDITION_VIEW

Toggles the condition panel between the hidden, simple and advanced views.
Default key stroke: CTRL-ALT-S

See Also:

• TableConditionPanel.view()

SELECT_CONDITION

public static final ControlKey<CommandControl> SELECT_CONDITION

Displays a dialog for selecting a column condition panel.
Default key stroke: CTRL-S

TOGGLE_FILTER_VIEW

public static final ControlKey<CommandControl> TOGGLE_FILTER_VIEW

Toggles the filter panel between the hidden, simple and advanced views.
Default key stroke: CTRL-ALT-F

See Also:

• TableConditionPanel.view()

SELECT_FILTER

public static final ControlKey<CommandControl> SELECT_FILTER

Displays a dialog for selecting a column filter panel.
Default key stroke: CTRL-SHIFT-F

DECREMENT_SELECTION

public static final ControlKey<CommandControl> DECREMENT_SELECTION

Decrements the selected indexes, moving the selection up.
Default key stroke: CTRL-SHIFT-UP

See Also:

• MultiSelection.Indexes.decrement()

INCREMENT_SELECTION

public static final ControlKey<CommandControl> INCREMENT_SELECTION

Increments the selected indexes, moving the selection down.
Default key stroke: CTRL-SHIFT-DOWN

See Also:

• MultiSelection.Indexes.increment()

PRINT

public static final ControlKey<CommandControl> PRINT

The main print action
Default key stroke: CTRL-P

DELETE

public static final ControlKey<CommandControl> DELETE

Triggers the DELETE control.
Default key stroke: DELETE

POPUP_MENU

public static final ControlKey<CommandControl> POPUP_MENU

Displays the table popup menu, if one is available.
Default key stroke: CTRL-G

INSPECT_QUERY

public static final ControlKey<CommandControl> INSPECT_QUERY

Displays the query inspector, if one is available.
Default key stroke: CTRL-ALT-Q

VIEW_ENTITY

public static final ControlKey<CommandControl> VIEW_ENTITY

Displays the entity viewer, if one is available.
Default key stroke: CTRL-ALT-V

See Also:

• EntityTablePanel.Config.INCLUDE_ENTITY_VIEWER

PRINT_CONTROLS

public static final ControlKey<Controls> PRINT_CONTROLS

A Controls instance containing controls for printing.

ADDITIONAL_POPUP_MENU_CONTROLS

public static final ControlKey<Controls> ADDITIONAL_POPUP_MENU_CONTROLS

A Controls instance containing any additional popup menu controls.

See Also:

• EntityTablePanel.addPopupMenuControls(Controls)

ADDITIONAL_TOOLBAR_CONTROLS

public static final ControlKey<Controls> ADDITIONAL_TOOLBAR_CONTROLS

A Controls instance containing any additional toolbar controls.

See Also:

• EntityTablePanel.addToolBarControls(Controls)

VIEW_DEPENDENCIES

public static final ControlKey<CommandControl> VIEW_DEPENDENCIES

A Control for viewing the dependencies of the selected entities.

EDIT_ATTRIBUTE_CONTROLS

public static final ControlKey<Controls> EDIT_ATTRIBUTE_CONTROLS

A Controls instance containing edit controls for all editable attributes.

See Also:

• EntityTablePanel.Config.editAttributeSelection(SelectionMode)

SELECT_COLUMNS

public static final ControlKey<CommandControl> SELECT_COLUMNS

A Control for displaying a dialog for selecting the visible table columns.

See Also:

• EntityTablePanel.Config.columnSelection(ColumnSelection)

TOGGLE_COLUMN_CONTROLS

public static final ControlKey<Controls> TOGGLE_COLUMN_CONTROLS

A Controls instance containing a ToggleControl for each columns' visibility.

See Also:

• EntityTablePanel.Config.columnSelection(ColumnSelection)

RESET_COLUMNS

public static final ControlKey<CommandControl> RESET_COLUMNS

A Control for resetting the columns to their original visibility and location.

SELECT_AUTO_RESIZE_MODE

public static final ControlKey<CommandControl> SELECT_AUTO_RESIZE_MODE

A Control for displaying a dialog for configuring the column auto-resize-mode.

See Also:

• JTable.setAutoResizeMode(int)

TOGGLE_AUTO_RESIZE_MODE_CONTROLS

public static final ControlKey<Controls> TOGGLE_AUTO_RESIZE_MODE_CONTROLS

A Controls instance containing a ToggleControl for each auto-resize-mode.

See Also:

• JTable.setAutoResizeMode(int)

SINGLE_SELECTION

public static final ControlKey<ToggleControl> SINGLE_SELECTION

A Control for toggling between single and multi selection mode.

CLEAR

public static final ControlKey<CommandControl> CLEAR

A Control for clearing the data from the table.

See Also:

• FilterModel.Items.clear()

REFRESH

public static final ControlKey<CommandControl> REFRESH

A Control for refreshing the table items.
Default key stroke: ALT-R

TOGGLE_SUMMARIES

public static final ControlKey<ToggleControl> TOGGLE_SUMMARIES

A ToggleControl for showing/hiding the summary panel.

CONDITION_CONTROLS

public static final ControlKey<Controls> CONDITION_CONTROLS

A Controls instance containing the condition panel controls.

FILTER_CONTROLS

public static final ControlKey<Controls> FILTER_CONTROLS

A Controls instance containing the filter panel controls.

CLEAR_SELECTION

public static final ControlKey<CommandControl> CLEAR_SELECTION

A Control for clearing the table selection.

COPY_CELL

public static final ControlKey<CommandControl> COPY_CELL

A Control for copying the selected cell data.
Default key stroke: CTRL-ALT-C

Replaces FilterTable.ControlKeys.COPY_CELL, which has no key stroke in a table panel.

COPY_COLUMN

public static final ControlKey<CommandControl> COPY_COLUMN

A Control for copying the selected column data.
Default key stroke: CTRL-ALT-SHIFT-C

Replaces FilterTable.ControlKeys.COPY_COLUMN, which has no key stroke in a table panel.

COPY_ROWS

public static final ControlKey<CommandControl> COPY_ROWS

A Control for copying the table rows with header.

EXPORT

public static final ControlKey<CommandControl> EXPORT

A Control for exporting the table data.

COPY_CONTROLS

public static final Controls.ControlsKey COPY_CONTROLS

A Controls instance containing controls for copying either cell or table data.

• ControlKeys#COPY_CELL
• ControlKeys#COPY_COLUMN
• ControlKeys#COPY_ROWS

See Also:

• COPY_CELL
• COPY_COLUMN
• COPY_ROWS

COLUMN_CONTROLS

public static final Controls.ControlsKey COLUMN_CONTROLS

A Controls instance containing controls for configuring columns.

• ControlKeys#SELECT_COLUMNS or ControlKeys#TOGGLE_COLUMN_CONTROLS
• ControlKeys#RESET_COLUMNS
• ControlKeys#SELECT_AUTO_RESIZE_MODE or ControlKeys#TOGGLE_AUTO_RESIZE_MODE_CONTROLS

See Also:

• SELECT_COLUMNS
• TOGGLE_COLUMN_CONTROLS
• RESET_COLUMNS
• SELECT_AUTO_RESIZE_MODE
• TOGGLE_AUTO_RESIZE_MODE_CONTROLS

FOCUS_SEARCH_FIELD

public static final ControlKey<CommandControl> FOCUS_SEARCH_FIELD

Requests focus for the table search field, if one is available.
Default key stroke: CTRL-F

Replaces FilterTable.ControlKeys.FOCUS_SEARCH_FIELD, which has no key stroke in a table panel.