SpreadsheetCellEditor are used by SpreadsheetCellType and SpreadsheetCell in order to control how each value will be entered.

General behavior:

Editors will be displayed if the user double-click in an editable cell ( see SpreadsheetCell#setEditable(boolean) ).
If the user does anything outside the editor, the editor will be forced to try to commit the edition and close itself. If the value is not valid, the editor will cancel the value and close itself. The editor is just here to allow communication between the user and the SpreadsheetView. It will just be given a value, and it will just give back another one after. The policy regarding validation of a given value is defined in SpreadsheetCellType#match(Object). If the value doesn't meet the requirements when saving the cell, nothing happens and the editor keeps editing.
You can abandon a current modification by pressing "esc" key.
You can specify a maximum height to your spreadsheetCellEditor with getMaxHeight(). This can be used in order to control the display of your editor. If they should grow or not in a big cell. (for example a TextAreaEditor want to grow with the cell in order to take full space for display.

Specific behavior:

This class offers some static classes in order to create a SpreadsheetCellEditor. Here are their properties:

• StringEditor: Basic TextField, can accept all data and save it as a string.
• ListEditor: Display a ComboBox with the different values.
• DoubleEditor: Display a TextField which accepts only double value. If the entered value is incorrect, the background will turn red so that the user will know in advance if the data will be saved or not.
• IntegerEditor: Display a TextField which accepts only Integer value. If the entered value is incorrect, the background will turn red so that the user will know in advance if the data will be saved or not.
• DateEditor: Display a DatePicker.
• ObjectEditor: Display a TextField , accept an Object.

Creating your editor:

You can of course create your own SpreadsheetCellEditor for displaying other controls.
You just have to override the four abstract methods. Remember that you will never call those methods directly. They will be called by the SpreadsheetView when needed.

• startEdit(Object): You will configure your control with the given value which is SpreadsheetCell#getItem() converted to an object. You do not instantiate your control here, you do it in the constructor.
• getEditor(): You will return which control you're using (for display).
• getControlValue(): You will return the value inside your editor in order to submit it for validation.
• end(): When editing is finished, you can properly close your own control.

Keep in mind that you will interact only with endEdit(boolean) where a true value means you want to commit, and a false means you want to cancel. The SpreadsheetView will handle all the rest for you and call your methods at the right moment.

Use case :

Visual:

String
List
Double
Date