Class EditConfigAttributes
- java.lang.Object
-
- org.eclipse.nebula.widgets.nattable.edit.EditConfigAttributes
-
public final class EditConfigAttributes extends Object
The configuration attributes for configuring editing behavior.
-
-
Field Summary
Fields Modifier and Type Field Description static ConfigAttribute<Boolean>
ACTIVATE_EDITOR_ON_TRAVERSAL
The configuration attribute to specify whether an editor should be activated if the activation was triggered by traversal, where traversal also includes selection and activation after commit.static ConfigAttribute<IEditableRule>
CELL_EDITABLE_RULE
The configuration attribute for theIEditableRule
that is used to determine whether a cell is editable or not.static ConfigAttribute<ICellEditor>
CELL_EDITOR
The configuration attribute for theICellEditor
that should be used for editing a cell value.static ConfigAttribute<IEditErrorHandler>
CONVERSION_ERROR_HANDLER
The configuration attribute for theIEditErrorHandler
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 theIDataValidator
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 behavior 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 behavior or not.static ConfigAttribute<IEditErrorHandler>
VALIDATION_ERROR_HANDLER
The configuration attribute for theIEditErrorHandler
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
public static final ConfigAttribute<IEditableRule> CELL_EDITABLE_RULE
The configuration attribute for theIEditableRule
that is used to determine whether a cell is editable or not.
-
CELL_EDITOR
public static final ConfigAttribute<ICellEditor> CELL_EDITOR
The configuration attribute for theICellEditor
that should be used for editing a cell value.
-
DATA_VALIDATOR
public static final ConfigAttribute<IDataValidator> DATA_VALIDATOR
The configuration attribute to register theIDataValidator
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
public static final ConfigAttribute<IEditErrorHandler> CONVERSION_ERROR_HANDLER
The configuration attribute for theIEditErrorHandler
that should be used for conversion failure handling.
-
VALIDATION_ERROR_HANDLER
public static final ConfigAttribute<IEditErrorHandler> VALIDATION_ERROR_HANDLER
The configuration attribute for theIEditErrorHandler
that should be used for validation failure handling.
-
CONVERSION_ERROR_STYLE
public 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
public 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
public 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 behavior.
-
OPEN_ADJACENT_EDITOR
public static final ConfigAttribute<Boolean> OPEN_ADJACENT_EDITOR
The configuration attribute to specify behavior after committing a value inline. If the value for this attribute is set totrue
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 isfalse
as this is the default behavior prior to this.
-
ACTIVATE_EDITOR_ON_TRAVERSAL
public static final ConfigAttribute<Boolean> ACTIVATE_EDITOR_ON_TRAVERSAL
The configuration attribute to specify whether an editor should be activated if the activation was triggered by traversal, where traversal also includes selection and activation after commit. If there is no value for this configuration attribute registered, the default value used istrue
as this is the default behavior prior to this.- See Also:
OPEN_ADJACENT_EDITOR
-
SUPPORT_MULTI_EDIT
public static final ConfigAttribute<Boolean> SUPPORT_MULTI_EDIT
The configuration attribute to specify whether an editor supports multi edit behavior or not. If this attribute is set totrue
, 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 tofalse
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
public 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 inICellEditDialog
.
-
-