public interface ICellEditor
Modifier and Type | Method and Description |
---|---|
boolean |
activateAtAnyPosition()
This method is intended to be used by
IMouseEventMatcher implementations that need
to check for the editor and the click position to determine whether an editor should be
activated or not. |
org.eclipse.swt.widgets.Control |
activateCell(org.eclipse.swt.widgets.Composite parent,
Object originalCanonicalValue,
EditModeEnum editMode,
ICellEditHandler editHandler,
ILayerCell cell,
IConfigRegistry configRegistry)
This method will be called by the framework to activate this cell editor.
|
void |
addEditorControlListeners()
This method is intended to add listeners to the wrapped editor control to add context related
behaviour.
|
void |
close()
Close/dispose the contained
Control |
boolean |
commit(SelectionLayer.MoveDirectionEnum direction)
Commits the current value of this editor.
|
boolean |
commit(SelectionLayer.MoveDirectionEnum direction,
boolean closeAfterCommit)
Commits the current value of this editor.
|
boolean |
commit(SelectionLayer.MoveDirectionEnum direction,
boolean closeAfterCommit,
boolean skipValidation)
Commits the current value of this editor.
|
org.eclipse.swt.widgets.Control |
createEditorControl(org.eclipse.swt.widgets.Composite parent)
Creates the editor control that is wrapped by this ICellEditor.
|
Object |
getCanonicalValue()
Converts the current value in this editor using the configured
IDisplayConverter . |
Object |
getCanonicalValue(IEditErrorHandler conversionErrorHandler)
Converts the current value in this editor using the configured
IDisplayConverter . |
int |
getColumnIndex() |
int |
getColumnPosition() |
org.eclipse.swt.widgets.Control |
getEditorControl() |
Object |
getEditorValue()
Returns the current value in this editor prior to conversion.
|
int |
getRowIndex() |
int |
getRowPosition() |
boolean |
isClosed() |
boolean |
openAdjacentEditor()
Determines behaviour after committing the value of this editor in combination with selection
movement.
|
boolean |
openInline(IConfigRegistry configRegistry,
List<String> configLabels)
Determines whether the editor should be opened inline or using a dialog.
|
void |
removeEditorControlListeners()
This method is intended to remove listeners from the wrapped editor control that was added by
addEditorControlListeners() before to add context related behaviour. |
void |
setCanonicalValue(Object canonicalValue)
Sets the given canonical value to the wrapped editor control.
|
void |
setEditorValue(Object value)
Sets the given value to editor control.
|
boolean |
supportMultiEdit(IConfigRegistry configRegistry,
List<String> configLabels)
Determines whether this editor supports multi edit behaviour or not.
|
boolean |
validateCanonicalValue(Object canonicalValue)
Validates the given value using the configured
IDataValidator . |
boolean |
validateCanonicalValue(Object canonicalValue,
IEditErrorHandler validationErrorHandler)
Validates the current value in this editor using the configured
IDataValidator . |
org.eclipse.swt.widgets.Control activateCell(org.eclipse.swt.widgets.Composite parent, Object originalCanonicalValue, EditModeEnum editMode, ICellEditHandler editHandler, ILayerCell cell, IConfigRegistry configRegistry)
parent
- The parent Composite, needed for the creation of the editor control.originalCanonicalValue
- The value that should be put to the activated editor
control.editMode
- The EditModeEnum
which is used to activate special behaviour
and styling. This is needed because activating an editor inline will have
different behaviour (e.g. moving the selection after commit) and styling
than rendering the editor on a subdialog.editHandler
- The ICellEditHandler
that will be used on commit.cell
- The cell whose corresponding editor should be activated.configRegistry
- The IConfigRegistry
containing the configuration of the
current NatTable instance.
This is necessary because the editors in the current architecture
are not aware of the NatTable instance they are running in.Control
to be used for capturing the new cell value.int getColumnIndex()
int getRowIndex()
int getColumnPosition()
int getRowPosition()
Object getEditorValue()
void setEditorValue(Object value)
value
- The display value to set to the wrapped editor control.Object getCanonicalValue()
IDisplayConverter
.
If there is no IDisplayConverter
registered for this editor, the value itself
will be returned.IDisplayConverter
is configured.RuntimeException
- for conversion failures. As the IDisplayConverter
interface
does not specify throwing checked Exceptions on converting data, only unchecked
Exceptions can occur. This is needed to stop further commit processing if the
conversion failed.IDisplayConverter
Object getCanonicalValue(IEditErrorHandler conversionErrorHandler)
IDisplayConverter
.
If there is no IDisplayConverter
registered for this editor, the value itself
will be returned. Will use the specified IEditErrorHandler
for handling
conversion errors.conversionErrorHandler
- The error handler that will be activated in case of
conversion errors.IDisplayConverter
is configured.RuntimeException
- for conversion failures. As the IDisplayConverter
interface
does not specify throwing checked Exceptions on converting data, only unchecked
Exceptions can occur. This is needed to stop further commit processing if the
conversion failed.IDisplayConverter
void setCanonicalValue(Object canonicalValue)
IDisplayConverter
.canonicalValue
- The canonical value to be set to the wrapped editor control.boolean validateCanonicalValue(Object canonicalValue)
IDataValidator
. This method should
be called with the value converted before by using getCanonicalValue()
.canonicalValue
- The canonical value to validate.true
if the current value in this editor is valid or no
IDataValidator
is registered, false
if the value is not valid.boolean validateCanonicalValue(Object canonicalValue, IEditErrorHandler validationErrorHandler)
IDataValidator
.
Validates the given value using the configured IDataValidator
. This method should
be called with the value converted before by using getCanonicalValue()
.
Will use the specified IEditErrorHandler
for handling validation errors.canonicalValue
- The canonical value to validate.validationErrorHandler
- The error handler that will be activated in case of
validation errors.true
if the current value in this editor is valid or no
IDataValidator
is registered, false
if the value is not valid.boolean commit(SelectionLayer.MoveDirectionEnum direction)
direction
- The direction the selection within the NatTable should move
after commit has finished.true
if the commit operation succeeded,
false
if the current value could not be committed.
A value might not be committed for example if the conversion or
the validation failed.boolean commit(SelectionLayer.MoveDirectionEnum direction, boolean closeAfterCommit)
direction
- The direction the selection within the NatTable should move
after commit has finished.closeAfterCommit
- flag to tell whether this editor needs to closed after
the commit or if it should stay open.true
if the commit operation succeeded,
false
if the current value could not be committed.
A value might not be committed for example if the conversion or
the validation failed.boolean commit(SelectionLayer.MoveDirectionEnum direction, boolean closeAfterCommit, boolean skipValidation)
direction
- The direction the selection within the NatTable should move
after commit has finished.closeAfterCommit
- flag to tell whether this editor needs to closed after
the commit or if it should stay open.skipValidation
- Flag to specify whether the current value in this editor
should be validated or not.true
if the commit operation succeeded,
false
if the current value could not be committed.
A value might not be committed for example if the conversion or
the validation failed.void close()
Control
boolean isClosed()
true
if this editor has been closed already,
false
if it is still openorg.eclipse.swt.widgets.Control getEditorControl()
org.eclipse.swt.widgets.Control createEditorControl(org.eclipse.swt.widgets.Composite parent)
parent
- The Composite that will be the parent of the new editor control.
Can not be null
boolean openInline(IConfigRegistry configRegistry, List<String> configLabels)
EditConfigAttributes.OPEN_IN_DIALOG
.
If there is no configuration found for this, true
will be returned for
backwards compatibility.
If this method returns true
, the editor will be opened inline (default).
There might be editors that are only able to be opened in a dialog. These implementations
need to override this method to always return false
, so the editor never
gets opened inline.
configRegistry
- The IConfigRegistry
to retrieve the configuration for
inline/dialog editing out of. Needed here because the instance IConfigRegistry
might not be set on calling this method.configLabels
- The labels out of the LabelStack of the cell whose editor should be activated.
Needed here because this method needs to be called prior to activation to determine
where to activate it.true
if the editor should opened inline, false
if not.EditConfigAttributes.OPEN_IN_DIALOG
boolean supportMultiEdit(IConfigRegistry configRegistry, List<String> configLabels)
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.
By default this method will return true
. You can change this behaviour by setting
the configuration attribute EditConfigAttributes.SUPPORT_MULTI_EDIT
.
You should consider returning 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.
configRegistry
- The IConfigRegistry
to retrieve the configuration for
multi edit support out of. Needed here because the instance IConfigRegistry
might not be set on calling this method.configLabels
- The labels out of the LabelStack of the cell whose editor should be activated.
Needed here because this method needs to be called prior to activation to determine
where to activate it.true
if this editor will open in a subdialog for multi editing, false
if the multi editing of this kind of cell editor is not supported.EditConfigAttributes.SUPPORT_MULTI_EDIT
boolean openAdjacentEditor()
true
and the selection is moved after committing,
the editor for the newly selected cell will be activated immediately. If this method returns
false
or the selection is not moved after commit, no action should be executed.
The behaviour previous to this configuration was to not open the adjacent editor. So if there
is no configuration registered for this, false
will be returned by default.
Note: It only makes sense to call this method if the editor is already activated. Calling this method on an editor that has not been activated already will lead to exceptions.
true
if the adjacent editor should be opened if the selection moves after
commit, false
if not.EditConfigAttributes.OPEN_ADJACENT_EDITOR
boolean activateAtAnyPosition()
IMouseEventMatcher
implementations that need
to check for the editor and the click position to determine whether an editor should be
activated or not. By default this method will return true
. Special implementations
that need a different behaviour need to return false
instead. E.g. checkbox editors
should only be activated in case the icon that represents the checkbox is clicked.true
if this ICellEditor
should be activated by clicking at any
position in the corresponding cell, false
if there need to be a special
position clicked.void addEditorControlListeners()
EditModeEnum.INLINE
by default this should add a FocusListener
that commits the current value if the editor control loses focus.
This method was introduced mainly because of two issues:
EditController.editCell(ILayerCell, Composite,
Object, IConfigRegistry)
.void removeEditorControlListeners()
addEditorControlListeners()
before to add context related behaviour.
This method was introduced to add the possibilty to create an ICellEditor
whose
wrapped editor control should not be disposed on closing the editor.
The main concept for cell editor activation is, that the editor control is disposed on closing the editor. This way everytime the cell editor is activated, a new editor control will be created. If an editor is implemented that needs to keep the editor control after closing the editor, it needs to be ensured that the listeners are removed again. Otherwise the listeners would be added again everytime the editor is activated.
This method needs to be called onclose()
. There is no automatical call
by the framework if you are not using the abstract implementation of ICellEditor
.Copyright © 2013. All Rights Reserved.