org.eclipse.nebula.widgets.nattable.edit.editor

Class TextCellEditor

java.lang.Object

org.eclipse.nebula.widgets.nattable.edit.editor.AbstractCellEditor

org.eclipse.nebula.widgets.nattable.edit.editor.TextCellEditor

All Implemented Interfaces:

ICellEditor

Direct Known Subclasses:

MultiLineTextCellEditor, PasswordCellEditor

public class TextCellEditor
extends AbstractCellEditor

ICellEditor implementation that wraps a SWT Text control to support text editing. This is also the default editor in NatTable if you didn't configure something else.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	commitOnEnter Flag to determine whether this editor should try to commit and close on pressing the enter key.
protected ControlDecorationProvider	decorationProvider The ControlDecorationProvider responsible for adding a ControlDecoration to the wrapped editor control.

Fields inherited from class org.eclipse.nebula.widgets.nattable.edit.editor.AbstractCellEditor

cellStyle, configRegistry, conversionEditErrorHandler, dataValidator, displayConverter, editMode, labelStack, layerCell, validationEditErrorHandler

Constructor Summary

Constructors

Constructor and Description
TextCellEditor() Creates the default TextCellEditor that does not commit on pressing the up/down arrow keys and will not move the selection on committing a value by pressing enter.
TextCellEditor(boolean commitOnUpDown) Creates a TextCellEditor that will not move the selection on committing a value by pressing enter.
TextCellEditor(boolean commitOnUpDown, boolean moveSelectionOnEnter) Creates a TextCellEditor.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.eclipse.swt.widgets.Control	activateCell(org.eclipse.swt.widgets.Composite parent, Object originalCanonicalValue) This method will be called by AbstractCellEditor.activateCell(Composite, Object, EditModeEnum, ICellEditHandler, ILayerCell, IConfigRegistry) after initializing the activation values and before adding the default listeners.
void	close() Close/dispose the contained Control
org.eclipse.swt.widgets.Text	createEditorControl(org.eclipse.swt.widgets.Composite parent) Creates the editor control that is wrapped by this ICellEditor.
protected org.eclipse.swt.widgets.Text	createEditorControl(org.eclipse.swt.widgets.Composite parent, int style) Creates the editor control that is wrapped by this ICellEditor.
ControlDecorationProvider	getDecorationProvider()
org.eclipse.swt.widgets.Text	getEditorControl()
String	getEditorValue() Returns the current value in this editor prior to conversion.
IEditErrorHandler	getInputConversionErrorHandler()
IEditErrorHandler	getInputValidationErrorHandler()
EditorSelectionEnum	getSelectionMode() Returns the current configured selection mode that is used on activating the wrapped text editor control.
boolean	isEditable()
void	setDecorationPositionOverride(int decorationPositionOverride) Set the position of the control decoration relative to the control.
void	setEditable(boolean editable)
void	setEditorValue(Object value) Sets the given value to editor control.
void	setErrorDecorationEnabled(boolean enabled) Enables/disables the error decoration for the wrapped text control.
void	setErrorDecorationText(String errorText) Set the error description text that will be shown in the decoration hover.
void	setInputConversionErrorHandler(IEditErrorHandler inputConversionErrorHandler)
void	setInputValidationErrorHandler(IEditErrorHandler inputValidationErrorHandler)
void	setSelectionMode(EditorSelectionEnum selectionMode) Set the selection mode that should be used on the content of the wrapped text editor control when it gets activated.
void	showErrorDecorationHover(String customErrorText) Force the error decoration hover to show immediately.

Methods inherited from class org.eclipse.nebula.widgets.nattable.edit.editor.AbstractCellEditor

activateAtAnyPosition, activateCell, addEditorControlListeners, commit, commit, commit, getCanonicalValue, getCanonicalValue, getColumnIndex, getColumnPosition, getRowIndex, getRowPosition, handleConversion, isClosed, openAdjacentEditor, openInline, removeEditorControlListeners, setCanonicalValue, setDataValidator, supportMultiEdit, validateCanonicalValue, validateCanonicalValue

Methods inherited from class java.lang.Object

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

Field Detail

decorationProvider

protected final ControlDecorationProvider decorationProvider

The ControlDecorationProvider responsible for adding a ControlDecoration to the wrapped editor control. Can be configured via convenience methods of this TextCellEditor.

commitOnEnter

protected boolean commitOnEnter

Flag to determine whether this editor should try to commit and close on pressing the enter key. The default is of course true, but for a multi line text editor, the enter key should be treated as inserting a new line instead of committing.

Constructor Detail

TextCellEditor

public TextCellEditor()

Creates the default TextCellEditor that does not commit on pressing the up/down arrow keys and will not move the selection on committing a value by pressing enter.

TextCellEditor

public TextCellEditor(boolean commitOnUpDown)

Creates a TextCellEditor that will not move the selection on committing a value by pressing enter.

Parameters:

commitOnUpDown - Flag to configure whether the editor should commit and move the selection in the corresponding way if the up or down key is pressed.

TextCellEditor

public TextCellEditor(boolean commitOnUpDown,
              boolean moveSelectionOnEnter)

Creates a TextCellEditor.

Parameters:

commitOnUpDown - Flag to configure whether the editor should commit and move the selection in the corresponding way if the up or down key is pressed.

moveSelectionOnEnter - Flag to configure whether the selection should move after a value was committed after pressing enter.

Method Detail

activateCell

protected org.eclipse.swt.widgets.Control activateCell(org.eclipse.swt.widgets.Composite parent,
                                           Object originalCanonicalValue)

Description copied from class: AbstractCellEditor

This method will be called by AbstractCellEditor.activateCell(Composite, Object, EditModeEnum, ICellEditHandler, ILayerCell, IConfigRegistry) after initializing the activation values and before adding the default listeners. In this method the underlying editor control should be created and initialized, hiding default configuration from editor implementors.

Specified by:

activateCell in class AbstractCellEditor

Parameters:

parent - The parent Composite, needed for the creation of the editor control.

originalCanonicalValue - The value that should be put to the activated editor control.

Returns:

The SWT Control to be used for capturing the new cell value.

getEditorValue

public String getEditorValue()

Description copied from interface: ICellEditor

Returns the current value in this editor prior to conversion. For a text editor that is used to edit integer values, this would mean it returns the text value instead of the converted integer value. This method is only intended to be used internally .

Returns:

The current value in this editor prior to conversion.

setEditorValue

public void setEditorValue(Object value)

Description copied from interface: ICellEditor

Sets the given value to editor control. This method is used to put the display values to the wrapped editor.

Parameters:

value - The display value to set to the wrapped editor control.

getEditorControl

public org.eclipse.swt.widgets.Text getEditorControl()

Returns:

The editor control that is wrapped by this ICellEditor.

createEditorControl

public org.eclipse.swt.widgets.Text createEditorControl(org.eclipse.swt.widgets.Composite parent)

Description copied from interface: ICellEditor

Creates the editor control that is wrapped by this ICellEditor. Will use the style configurations in ConfigRegistry for styling the control.

Parameters:

parent - The Composite that will be the parent of the new editor control. Can not be null

Returns:

The created editor control that is wrapped by this ICellEditor.

createEditorControl

protected org.eclipse.swt.widgets.Text createEditorControl(org.eclipse.swt.widgets.Composite parent,
                                               int style)

Creates the editor control that is wrapped by this ICellEditor. Will use the style configurations in ConfigRegistry for styling the control.

Parameters:

parent - The Composite that will be the parent of the new editor control. Can not be null

style - The SWT style of the text control to create.

Returns:

The created editor control that is wrapped by this ICellEditor.

close

public void close()

Description copied from interface: ICellEditor

Close/dispose the contained Control

Specified by:

close in interface ICellEditor

Overrides:

close in class AbstractCellEditor

isEditable

public boolean isEditable()

Returns:

true if the wrapped Text control is editable, false if not.

setEditable

public void setEditable(boolean editable)

Parameters:

editable - true if the wrapped Text control should be editable, false if not.

getSelectionMode

public final EditorSelectionEnum getSelectionMode()

Returns the current configured selection mode that is used on activating the wrapped text editor control. By default this is null which causes the following default behaviour. If the text editor control is activated with an initial value then the selection is set at the end of the containing text. If it is activated only specifying the original canonical value, the default behaviour is to select the whole text contained in the text editor control.

Returns:

The current configured selection mode, null for default behaviour.

setSelectionMode

public final void setSelectionMode(EditorSelectionEnum selectionMode)

Set the selection mode that should be used on the content of the wrapped text editor control when it gets activated. By setting a value explicitly you configure the selection mode for both cases, activating the wrapped text editor control with and without an initial value. Setting this value to null will reactivate the default behaviour like described here getSelectionMode().

Parameters:

selectionMode - The selection mode that should be used on the content of the wrapped text editor control when it gets activated.

getDecorationProvider

public ControlDecorationProvider getDecorationProvider()

Returns:

The ControlDecorationProvider responsible for adding a ControlDecoration to the wrapped editor control.

setErrorDecorationEnabled

public void setErrorDecorationEnabled(boolean enabled)

Enables/disables the error decoration for the wrapped text control.

Parameters:

enabled - true if an error decoration should be added to the wrapped text control, false if not.

setErrorDecorationText

public void setErrorDecorationText(String errorText)

Set the error description text that will be shown in the decoration hover.

Parameters:

errorText - The text to be shown as a description for the decoration, or null if there should be no description.

See Also:

ControlDecoration.setDescriptionText(String)

showErrorDecorationHover

public void showErrorDecorationHover(String customErrorText)

Force the error decoration hover to show immediately.

Parameters:

customErrorText - The text to show in the hover popup.

See Also:

ControlDecoration.show(), ControlDecoration.showHoverText(String)

setDecorationPositionOverride

public void setDecorationPositionOverride(int decorationPositionOverride)

Set the position of the control decoration relative to the control. It should include style bits describing both the vertical and horizontal orientation.

Parameters:

decorationPositionOverride - bit-wise or of position constants (SWT.TOP, SWT.BOTTOM, SWT.LEFT, SWT.RIGHT, and SWT.CENTER).

See Also:

ControlDecoration.ControlDecoration(Control, int)

getInputConversionErrorHandler

public IEditErrorHandler getInputConversionErrorHandler()

Returns:

The IEditErrorHandler that is used for showing conversion errors on typing into this editor. By default this is the RenderErrorHandling which will render the content in the editor red to indicate a conversion error.

setInputConversionErrorHandler

public void setInputConversionErrorHandler(IEditErrorHandler inputConversionErrorHandler)

Parameters:

inputConversionErrorHandler - The IEditErrorHandler that is should be used for showing conversion errors on typing into this editor.

getInputValidationErrorHandler

public IEditErrorHandler getInputValidationErrorHandler()

Returns:

The IEditErrorHandler that is used for showing validation errors on typing into this editor. By default this is the RenderErrorHandling which will render the content in the editor red to indicate a validation error.

setInputValidationErrorHandler

public void setInputValidationErrorHandler(IEditErrorHandler inputValidationErrorHandler)

Parameters:

inputValidationErrorHandler - The IEditErrorHandler that is should used for showing validation errors on typing into this editor.