org.eclipse.nebula.widgets.nattable.edit

Interface EditConfigAttributes

public interface EditConfigAttributes

The configuration attributes for configuring editing behaviour.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigAttribute<IEditableRule>	CELL_EDITABLE_RULE The configuration attribute for the IEditableRule that is used to determine whether a cell is editable or not.
static ConfigAttribute<ICellEditor>	CELL_EDITOR The configuration attribute for the ICellEditor that should be used for editing a cell value.
static ConfigAttribute<IEditErrorHandler>	CONVERSION_ERROR_HANDLER The configuration attribute for the IEditErrorHandler that should be used for conversion failure handling.
static ConfigAttribute<IStyle>	CONVERSION_ERROR_STYLE The configuration attribute for the style that should be used on just in time conversion error rendering within an editor control.
static ConfigAttribute<IDataValidator>	DATA_VALIDATOR The configuration attribute to register the IDataValidator that should be used for validation if a value is committed by an editor.
static ConfigAttribute<Map<String,Object>>	EDIT_DIALOG_SETTINGS The configuration attribute to specify custom dialog settings for edit dialogs.
static ConfigAttribute<Boolean>	OPEN_ADJACENT_EDITOR The configuration attribute to specify behaviour after committing a value inline.
static ConfigAttribute<Boolean>	OPEN_IN_DIALOG The configuration attribute to specify if cell editors should be opened inline or in a dialog.
static ConfigAttribute<Boolean>	SUPPORT_MULTI_EDIT The configuration attribute to specify whether an editor supports multi edit behaviour or not.
static ConfigAttribute<IEditErrorHandler>	VALIDATION_ERROR_HANDLER The configuration attribute for the IEditErrorHandler that should be used for validation failure handling.
static ConfigAttribute<IStyle>	VALIDATION_ERROR_STYLE The configuration attribute for the style that should be used on just in time validation error rendering within an editor control.

Field Detail

CELL_EDITABLE_RULE

static final ConfigAttribute<IEditableRule> CELL_EDITABLE_RULE

The configuration attribute for the IEditableRule that is used to determine whether a cell is editable or not.

CELL_EDITOR

static final ConfigAttribute<ICellEditor> CELL_EDITOR

The configuration attribute for the ICellEditor that should be used for editing a cell value.

DATA_VALIDATOR

static final ConfigAttribute<IDataValidator> DATA_VALIDATOR

The configuration attribute to register the IDataValidator that should be used for validation if a value is committed by an editor. Note that the IDisplayConverter is not part of the EditConfigAttributes as it might also be used without editing, e.g. converting a date for correct display.

CONVERSION_ERROR_HANDLER

static final ConfigAttribute<IEditErrorHandler> CONVERSION_ERROR_HANDLER

The configuration attribute for the IEditErrorHandler that should be used for conversion failure handling.

VALIDATION_ERROR_HANDLER

static final ConfigAttribute<IEditErrorHandler> VALIDATION_ERROR_HANDLER

The configuration attribute for the IEditErrorHandler that should be used for validation failure handling.

CONVERSION_ERROR_STYLE

static final ConfigAttribute<IStyle> CONVERSION_ERROR_STYLE

The configuration attribute for the style that should be used on just in time conversion error rendering within an editor control.

Note: Currently this configuration attribute is only evaluated by the TextCellEditor in combination with the RenderErrorHandling for just in time conversion error rendering.

VALIDATION_ERROR_STYLE

static final ConfigAttribute<IStyle> VALIDATION_ERROR_STYLE

The configuration attribute for the style that should be used on just in time validation error rendering within an editor control.

Note: Currently this configuration attribute is only evaluated by the TextCellEditor in combination with the RenderErrorHandling for just in time validation error rendering.

OPEN_IN_DIALOG

static final ConfigAttribute<Boolean> OPEN_IN_DIALOG

The configuration attribute to specify if cell editors should be opened inline or in a dialog. If this configuration is not set, the editors will open inline, unless the editors themself specify different behaviour.

See Also:

ICellEditor.openInline(IConfigRegistry configRegistry, List configLabels)

OPEN_ADJACENT_EDITOR

static final ConfigAttribute<Boolean> OPEN_ADJACENT_EDITOR

The configuration attribute to specify behaviour after committing a value inline. If the value for this attribute is set to true and the cell selection is specified to move after a successful commit operation, the editor for the selected cell will be activated immediately. If there is no value for this configuration attribute registered, the default value used is false as this is the default behaviour prior to this.

SUPPORT_MULTI_EDIT

static final ConfigAttribute<Boolean> SUPPORT_MULTI_EDIT

The configuration attribute to specify whether an editor supports multi edit behaviour or not. If this attribute is set to true, on selecting and pressing F2 on several cells that are editable, having the same editor type and converter registered, a multi edit dialog will open. You should consider setting the value for this attribute to false e.g. if the update operation is complex or you use conditional validation, where a value is validated against another value in the data model.

EDIT_DIALOG_SETTINGS

static final ConfigAttribute<Map<String,Object>> EDIT_DIALOG_SETTINGS

The configuration attribute to specify custom dialog settings for edit dialogs. Registering a map with matching key-value pairs for this attribute allows to modify the appearance of edit dialogs. To see which key-value-pairs are interpreted have a look at the constants configured in ICellEditDialog.

See Also:

ICellEditDialog.DIALOG_SHELL_TITLE, ICellEditDialog.DIALOG_SHELL_ICON, ICellEditDialog.DIALOG_SHELL_LOCATION, ICellEditDialog.DIALOG_SHELL_SIZE, ICellEditDialog.DIALOG_SHELL_RESIZABLE, ICellEditDialog.DIALOG_MESSAGE