Module org.controlsfx.controls

Package org.controlsfx.control.spreadsheet

Class SpreadsheetCellEditor.TextAreaEditor

java.lang.Object

org.controlsfx.control.spreadsheet.SpreadsheetCellEditor

org.controlsfx.control.spreadsheet.SpreadsheetCellEditor.TextAreaEditor

Enclosing class:

SpreadsheetCellEditor

public static class SpreadsheetCellEditor.TextAreaEditor
extends SpreadsheetCellEditor

A SpreadsheetCellEditor for SpreadsheetCellType.StringType typed cells. It displays a TextField where the user can type different values.

Nested Class Summary

Nested classes/interfaces inherited from class org.controlsfx.control.spreadsheet.SpreadsheetCellEditor

SpreadsheetCellEditor.DateEditor, SpreadsheetCellEditor.DoubleEditor, SpreadsheetCellEditor.IntegerEditor, SpreadsheetCellEditor.ListEditor<R>, SpreadsheetCellEditor.ObjectEditor, SpreadsheetCellEditor.StringEditor, SpreadsheetCellEditor.TextAreaEditor

Constructor Summary

Constructors

Constructor	Description
TextAreaEditor(SpreadsheetView view)	Constructor for the StringEditor.

Method Summary

Modifier and Type	Method	Description
void	end()	This method will be called at the end of edition. You will be offered the possibility to do the configuration post editing.
String	getControlValue()	Return the value within your editor as a string.
TextArea	getEditor()	Return the control used for controlling the input.
double	getMaxHeight()	Return the maximum height of the editor.
void	startEdit(Object value, String format, Object... options)	************************************************************************* * Public Methods * * ************************************************************************

Methods inherited from class org.controlsfx.control.spreadsheet.SpreadsheetCellEditor

endEdit, startEdit

Methods inherited from class java.lang.Object

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

Constructor Details

TextAreaEditor

public TextAreaEditor(SpreadsheetView view)

Constructor for the StringEditor.

Parameters:

view - The SpreadsheetView

Method Details

startEdit

public void startEdit(Object value,
 String format,
 Object... options)

************************************************************************* * Public Methods * * ************************************************************************

Specified by:

startEdit in class SpreadsheetCellEditor

getControlValue

public String getControlValue()

Description copied from class: SpreadsheetCellEditor

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.

Specified by:

getControlValue in class SpreadsheetCellEditor

Returns:

the value within your editor as a string.

end

public void end()

Description copied from class: SpreadsheetCellEditor

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

Specified by:

end in class SpreadsheetCellEditor

getEditor

public TextArea getEditor()

Description copied from class: SpreadsheetCellEditor

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

Specified by:

getEditor in class SpreadsheetCellEditor

Returns:

the control used.

getMaxHeight

public double getMaxHeight()

Description copied from class: SpreadsheetCellEditor

Return the maximum height of the editor.

Overrides:

getMaxHeight in class SpreadsheetCellEditor

Returns:

50 by default.