Module org.controlsfx.controls

Package org.controlsfx.control.spreadsheet

Class SpreadsheetCellEditor

java.lang.Object

org.controlsfx.control.spreadsheet.SpreadsheetCellEditor

Direct Known Subclasses:

SpreadsheetCellEditor.DateEditor, SpreadsheetCellEditor.DoubleEditor, SpreadsheetCellEditor.IntegerEditor, SpreadsheetCellEditor.ListEditor, SpreadsheetCellEditor.ObjectEditor, SpreadsheetCellEditor.StringEditor, SpreadsheetCellEditor.TextAreaEditor

public abstract class SpreadsheetCellEditor
extends Object

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 SpreadsheetCellEditor.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:

• SpreadsheetCellEditor.StringEditor: Basic TextField, can accept all data and save it as a string.
• SpreadsheetCellEditor.ListEditor: Display a ComboBox with the different values.
• SpreadsheetCellEditor.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.
• SpreadsheetCellEditor.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.
• SpreadsheetCellEditor.DateEditor: Display a DatePicker.
• SpreadsheetCellEditor.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

See Also:

SpreadsheetView, SpreadsheetCell, SpreadsheetCellType

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpreadsheetCellEditor.DateEditor	A SpreadsheetCellEditor for SpreadsheetCellType.DateType typed cells.
static class	SpreadsheetCellEditor.DoubleEditor	A SpreadsheetCellEditor for SpreadsheetCellType.DoubleType typed cells.
static class	SpreadsheetCellEditor.IntegerEditor	A SpreadsheetCellEditor for SpreadsheetCellType.DoubleType typed cells.
static class	SpreadsheetCellEditor.ListEditor<R>	A SpreadsheetCellEditor for SpreadsheetCellType.ListType typed cells.
static class	SpreadsheetCellEditor.ObjectEditor	A SpreadsheetCellEditor for SpreadsheetCellType.ObjectType typed cells.
static class	SpreadsheetCellEditor.StringEditor	A SpreadsheetCellEditor for SpreadsheetCellType.StringType typed cells.
static class	SpreadsheetCellEditor.TextAreaEditor	A SpreadsheetCellEditor for SpreadsheetCellType.StringType typed cells.

Constructor Summary

Constructors

Constructor	Description
SpreadsheetCellEditor(SpreadsheetView view)	Construct the SpreadsheetCellEditor.

Method Summary

Modifier and Type	Method	Description
abstract void	end()	This method will be called at the end of edition. You will be offered the possibility to do the configuration post editing.
void	endEdit(boolean b)	Whenever you want to stop the edition, you call that method. True means you're trying to commit the value, then SpreadsheetCellType.convertValue(Object) will be called in order to verify that the value is correct. False means you're trying to cancel the value and it will be follow by end(). See SpreadsheetCellEditor description
abstract String	getControlValue()	Return the value within your editor as a string.
abstract Control	getEditor()	Return the control used for controlling the input.
double	getMaxHeight()	Return the maximum height of the editor.
void	startEdit(Object item)	This method will be called when edition start. You will then do all the configuration of your editor.
abstract void	startEdit(Object item, String format, Object... options)	Does the same as startEdit(java.lang.Object) but you have also the SpreadsheetCell.getFormat() sent.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpreadsheetCellEditor

public SpreadsheetCellEditor(SpreadsheetView view)

Construct the SpreadsheetCellEditor.

Parameters:

view -

Method Detail

endEdit

public final void endEdit(boolean b)

Whenever you want to stop the edition, you call that method.
True means you're trying to commit the value, then SpreadsheetCellType.convertValue(Object) will be called in order to verify that the value is correct.
False means you're trying to cancel the value and it will be follow by end().
See SpreadsheetCellEditor description

Parameters:

b - true means commit, false means cancel

startEdit

public void startEdit(Object item)

This method will be called when edition start.
You will then do all the configuration of your editor.

Parameters:

item -

startEdit

public abstract void startEdit(Object item,
                               String format,
                               Object... options)

Does the same as startEdit(java.lang.Object) but you have also the SpreadsheetCell.getFormat() sent. This is useful when editing Date for example, when you want to display it with the cell format. Also options given by a Spreadsheetcell with SpreadsheetCell.getOptionsForEditor() are given.

Parameters:

item -

format -

options -

getEditor

public abstract Control getEditor()

Return the control used for controlling the input. This is called at the beginning in order to display your control in the cell.

Returns:

the control used.

getControlValue

public abstract String getControlValue()

Return the value within your editor as a string. This will be used by the SpreadsheetCellType.convertValue(Object) in order to compute whether the value is valid regarding the SpreadsheetCellType policy.

Returns:

the value within your editor as a string.

end

public abstract void end()

This method will be called at the end of edition.
You will be offered the possibility to do the configuration post editing.

getMaxHeight

public double getMaxHeight()

Return the maximum height of the editor.

Returns:

50 by default.