SpreadsheetCell (ControlsFX Project 8.40.18)

All Known Implementing Classes:

SpreadsheetCellBase
```
public interface SpreadsheetCell
```
Interface of the cells used in the SpreadsheetView. See SpreadsheetCellBase for a complete and detailed documentation.

See Also:

SpreadsheetCellBase

Property Summary

All Methods Instance Methods Abstract Methods
Type	Property and Description
`javafx.beans.property.StringProperty`	`format` Returns the `StringProperty` linked with the format.
`javafx.beans.property.ObjectProperty<javafx.scene.Node>`	`graphic` Returns the `ObjectProperty` representing this cell graphic.
`javafx.beans.property.ObjectProperty<java.lang.Object>`	`item` The item property represents the currently-set value inside this `SpreadsheetCell`.
`javafx.beans.property.StringProperty`	`style` A string representation of the CSS style associated with this specific Node.
`javafx.beans.property.ReadOnlyStringProperty`	`text` Returns the StringProperty of the representation of the value.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`SpreadsheetCell.CornerPosition` This enum states the four different corner available for positioning some elements in a cell.

Field Summary

Fields
Modifier and Type	Field and Description
`static javafx.event.EventType<javafx.event.Event>`	`CORNER_EVENT_TYPE` This EventType can be used with an `EventHandler` in order to catch when a corner state of a SpreadsheetCell is changed.
`static javafx.event.EventType<javafx.event.Event>`	`EDITABLE_EVENT_TYPE` This EventType can be used with an `EventHandler` in order to catch when the editable state of a SpreadsheetCell is changed.
`static javafx.event.EventType<javafx.event.Event>`	`WRAP_EVENT_TYPE` This EventType can be used with an `EventHandler` in order to catch when the wrap text state of a SpreadsheetCell is changed.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`activateCorner(SpreadsheetCell.CornerPosition position)` Activates the given `CornerPosition` in order to display a little triangle in the cell.
`void`	`addEventHandler(javafx.event.EventType<javafx.event.Event> eventType, javafx.event.EventHandler<javafx.event.Event> eventHandler)` Registers an event handler to this SpreadsheetCell.
`void`	`deactivateCorner(SpreadsheetCell.CornerPosition position)` This deactivates the given `CornerPosition` so that no triangle will be shown for this cell.
`javafx.beans.property.StringProperty`	`formatProperty()` Returns the `StringProperty` linked with the format.
`SpreadsheetCellType`	`getCellType()` Returns the `SpreadsheetCellType` of this cell.
`int`	`getColumn()` Returns the column index of this cell.
`int`	`getColumnSpan()` Returns how much this cell is spanning in column, 1 means the cell is not spanning.
`java.lang.String`	`getFormat()` Returns the format of this cell or an empty string if no format has been specified.
`javafx.scene.Node`	`getGraphic()` Returns the graphic node associated with this cell.
`java.lang.Object`	`getItem()` Returns the value contained in this cell.
`java.util.List<java.lang.Object>`	`getOptionsForEditor()` If some options cannot be factorized in a `SpreadsheetCellType` and are specific to a cell, you can return them here and the `SpreadsheetCellEditor` will receive them.
`java.util.List<javafx.scene.control.MenuItem>`	`getPopupItems()` If `hasPopup()` is set to `true`, this method will be called when the user clicks on the cell in order to gather the `MenuItem` to show in the Popup.
`int`	`getRow()` Returns the row index of this cell.
`int`	`getRowSpan()` Returns how much this cell is spanning in row, 1 means the cell is not spanning.
`java.lang.String`	`getStyle()` A string representation of the CSS style associated with this specific Node.
`javafx.collections.ObservableSet<java.lang.String>`	`getStyleClass()` Returns an `ObservableList` of `String` of all the style class associated with this cell.
`java.lang.String`	`getText()` Returns the String representation currently used for display in the `SpreadsheetView`.
`java.util.Optional<java.lang.String>`	`getTooltip()` Returns the tooltip for this cell.
`javafx.beans.property.ObjectProperty<javafx.scene.Node>`	`graphicProperty()` Returns the `ObjectProperty` representing this cell graphic.
`boolean`	`hasPopup()` Returns true if this cell needs to display a popup when clicked in order to show some `MenuItem` like a `MenuButton`.
`boolean`	`isCellGraphic()` Returns `true` if this cell contains something particular in its item and a `Node` given by the `CellGraphicFactory` will be used to display it.
`boolean`	`isCornerActivated(SpreadsheetCell.CornerPosition position)` Returns `true` if a triangle is displayed in the cell for the given `CornerPosition`.
`boolean`	`isEditable()` Returns `true` if this cell can be edited.
`boolean`	`isWrapText()` If a run of text exceeds the width of the Labeled, then this variable indicates whether the text should wrap onto another line.
`javafx.beans.property.ObjectProperty<java.lang.Object>`	`itemProperty()` The item property represents the currently-set value inside this `SpreadsheetCell`.
`boolean`	`match(java.lang.Object value)` Verifies that the upcoming cell value can be set to the current cell.
`void`	`removeEventHandler(javafx.event.EventType<javafx.event.Event> eventType, javafx.event.EventHandler<javafx.event.Event> eventHandler)` Unregisters a previously registered event handler from this SpreadsheetCell.
`void`	`setCellGraphic(boolean isCellGraphic)` If `isCellGraphic` is `true`, this cell item contains something particular and should be display by using a Node provided by `CellGraphicFactory` object in the CellView.
`void`	`setColumnSpan(int columnSpan)` Sets how much this cell is spanning in column.
`void`	`setEditable(boolean editable)` Change the editable state of this cell
`void`	`setFormat(java.lang.String format)` Sets a new format for this cell.
`void`	`setGraphic(javafx.scene.Node graphic)` Sets a graphic for this cell.
`void`	`setHasPopup(boolean value)` Sets to `true` if this cell needs to display a popup when clicked in order to show some `MenuItem` like a `MenuButton`.
`void`	`setItem(java.lang.Object value)` Sets the value of the property Item.
`void`	`setRowSpan(int rowSpan)` Sets how much this cell is spanning in row.
`void`	`setStyle(java.lang.String style)` A string representation of the CSS style associated with this specific Node.
`void`	`setWrapText(boolean wrapText)` If a run of text exceeds the width of the Labeled, then this variable indicates whether the text should wrap onto another line.
`javafx.beans.property.StringProperty`	`styleProperty()` A string representation of the CSS style associated with this specific Node.
`javafx.beans.property.ReadOnlyStringProperty`	`textProperty()` Returns the StringProperty of the representation of the value.

- Property Detail
  - item
```
javafx.beans.property.ObjectProperty<java.lang.Object> itemProperty
```
    The item property represents the currently-set value inside this SpreadsheetCell.
    
    See Also:
    
    getItem(), setItem(Object)
  - style
```
javafx.beans.property.StringProperty styleProperty
```
    A string representation of the CSS style associated with this specific Node. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule.
    
    See Also:
    
    getStyle(), setStyle(String)
  - format
```
javafx.beans.property.StringProperty formatProperty
```
    Returns the StringProperty linked with the format.
    
    See Also:
    
    getFormat(), setFormat(String)
  - text
```
javafx.beans.property.ReadOnlyStringProperty textProperty
```
    Returns the StringProperty of the representation of the value.
    
    See Also:
    
    getText()
  - graphic
```
javafx.beans.property.ObjectProperty<javafx.scene.Node> graphicProperty
```
    Returns the ObjectProperty representing this cell graphic.
    
    See Also:
    
    getGraphic(), setGraphic(Node)
- Field Detail
  - EDITABLE_EVENT_TYPE
```
static final javafx.event.EventType<javafx.event.Event> EDITABLE_EVENT_TYPE
```
    This EventType can be used with an EventHandler in order to catch when the editable state of a SpreadsheetCell is changed.
  - WRAP_EVENT_TYPE
```
static final javafx.event.EventType<javafx.event.Event> WRAP_EVENT_TYPE
```
    This EventType can be used with an EventHandler in order to catch when the wrap text state of a SpreadsheetCell is changed.
  - CORNER_EVENT_TYPE
```
static final javafx.event.EventType<javafx.event.Event> CORNER_EVENT_TYPE
```
    This EventType can be used with an EventHandler in order to catch when a corner state of a SpreadsheetCell is changed.
- Method Detail
  - match
```
boolean match(java.lang.Object value)
```
    Verifies that the upcoming cell value can be set to the current cell. This is currently used by the Copy/Paste.
    
    Parameters:
    
    value - the value that needs to be tested
    
    Returns:
    
    true if the upcoming cell value can be set to the current cell
  - setItem
```
void setItem(java.lang.Object value)
```
    Sets the value of the property Item. This should be used only at initialization. Prefer Grid.setCellValue(int, int, Object) after because it will compute correctly the modifiedCell. If isEditable() return false, nothing is done.
    
    Parameters:
    
    value -
  - getItem
```
java.lang.Object getItem()
```
    Returns the value contained in this cell.
    
    Returns:
    
    the value contained in this cell
  - itemProperty
```
javafx.beans.property.ObjectProperty<java.lang.Object> itemProperty()
```
    The item property represents the currently-set value inside this SpreadsheetCell.
    
    See Also:
    
    getItem(), setItem(Object)
  - isEditable
```
boolean isEditable()
```
    Returns true if this cell can be edited.
    
    Returns:
    
    true if this cell is editable
  - setEditable
```
void setEditable(boolean editable)
```
    Change the editable state of this cell
    
    Parameters:
    
    editable - true if this cell should be editable
  - isWrapText
```
boolean isWrapText()
```
    If a run of text exceeds the width of the Labeled, then this variable indicates whether the text should wrap onto another line.
    
    Returns:
    
    true if the text should wrap onto another line if it exceeds the width of the Labeled
  - isCellGraphic
```
boolean isCellGraphic()
```
    Returns true if this cell contains something particular in its item and a Node given by the CellGraphicFactory will be used to display it.
    
    Returns:
    
    true if this cell item needs to be given to a particular Node
  - setCellGraphic
```
void setCellGraphic(boolean isCellGraphic)
```
    If isCellGraphic is true, this cell item contains something particular and should be display by using a Node provided by CellGraphicFactory object in the CellView. If you only seek to place a simple Node for this cell, simply use setGraphic(javafx.scene.Node).
    
    Parameters:
    
    isCellGraphic - if true, a Node will be used to display something particular for the cell
  - setWrapText
```
void setWrapText(boolean wrapText)
```
    If a run of text exceeds the width of the Labeled, then this variable indicates whether the text should wrap onto another line.
    
    Parameters:
    
    wrapText - true if the text should wrap onto another line if it exceeds the width of the Labeled
  - getOptionsForEditor
```
java.util.List<java.lang.Object> getOptionsForEditor()
```
    If some options cannot be factorized in a SpreadsheetCellType and are specific to a cell, you can return them here and the SpreadsheetCellEditor will receive them.
    
    Returns:
    
    a List of options for the SpreadsheetCellEditor
  - hasPopup
```
boolean hasPopup()
```
    Returns true if this cell needs to display a popup when clicked in order to show some MenuItem like a MenuButton. The items can be set in getPopupItems().
    
    Returns:
    
    true if this cell needs to display a popup
  - setHasPopup
```
void setHasPopup(boolean value)
```
    Sets to true if this cell needs to display a popup when clicked in order to show some MenuItem like a MenuButton.
    
    Parameters:
    
    value - true to display a Popup when clicked
  - getPopupItems
```
java.util.List<javafx.scene.control.MenuItem> getPopupItems()
```
    If hasPopup() is set to true, this method will be called when the user clicks on the cell in order to gather the MenuItem to show in the Popup.
    
    Returns:
    
    the MenuItem to show in the Popup
  - setStyle
```
void setStyle(java.lang.String style)
```
    A string representation of the CSS style associated with this specific Node. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule.
    
    Parameters:
    
    style - a string representation of the CSS style associated with this specific Node
  - getStyle
```
java.lang.String getStyle()
```
    A string representation of the CSS style associated with this specific Node. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule.
    
    Returns:
    
    The inline CSS style associated with this Node. If this Node does not have an inline style, an empty String is returned.
  - styleProperty
```
javafx.beans.property.StringProperty styleProperty()
```
    A string representation of the CSS style associated with this specific Node. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule.
    
    See Also:
    
    getStyle(), setStyle(String)
  - activateCorner
```
void activateCorner(SpreadsheetCell.CornerPosition position)
```
    Activates the given CornerPosition in order to display a little triangle in the cell.
    
    Parameters:
    
    position - the position where the triangle should be displayed
  - deactivateCorner
```
void deactivateCorner(SpreadsheetCell.CornerPosition position)
```
    This deactivates the given CornerPosition so that no triangle will be shown for this cell.
    
    Parameters:
    
    position - the position where the triangle should be removed if displayed
  - isCornerActivated
```
boolean isCornerActivated(SpreadsheetCell.CornerPosition position)
```
    Returns true if a triangle is displayed in the cell for the given CornerPosition.
    
    Parameters:
    
    position -
    
    Returns:
    
    true if a triangle is displayed in the cell for the given CornerPosition
  - formatProperty
```
javafx.beans.property.StringProperty formatProperty()
```
    Returns the StringProperty linked with the format.
    
    See Also:
    
    getFormat(), setFormat(String)
  - getFormat
```
java.lang.String getFormat()
```
    Returns the format of this cell or an empty string if no format has been specified.
    
    Returns:
    
    the format of this cell or an empty string if no format has been specified
  - setFormat
```
void setFormat(java.lang.String format)
```
    Sets a new format for this cell. This format will be used by SpreadsheetCellType.toString(java.lang.Object, java.lang.String). This should be used by numbers for example.
    
    Parameters:
    
    format - a string pattern understood by the SpreadsheetCellType
  - textProperty
```
javafx.beans.property.ReadOnlyStringProperty textProperty()
```
    Returns the StringProperty of the representation of the value.
    
    See Also:
    
    getText()
  - getText
```
java.lang.String getText()
```
    Returns the String representation currently used for display in the SpreadsheetView.
    
    Returns:
    
    the text representation of the value
  - getCellType
```
SpreadsheetCellType getCellType()
```
    Returns the SpreadsheetCellType of this cell.
    
    Returns:
    
    the SpreadsheetCellType of this cell.
  - getRow
```
int getRow()
```
    Returns the row index of this cell.
    
    Returns:
    
    the row index of this cell
  - getColumn
```
int getColumn()
```
    Returns the column index of this cell.
    
    Returns:
    
    the column index of this cell
  - getRowSpan
```
int getRowSpan()
```
    Returns how much this cell is spanning in row, 1 means the cell is not spanning.
    
    Returns:
    
    how much this cell is spanning in row, 1 is normal
  - setRowSpan
```
void setRowSpan(int rowSpan)
```
    Sets how much this cell is spanning in row. See SpreadsheetCell description for information. You should use Grid.spanRow(int, int, int) instead of using this method directly. 1 means the cell is not spanning. Thus, the rowSpan should not be inferior to 1.
    
    Parameters:
    
    rowSpan - the rowSpan for this cell
  - getColumnSpan
```
int getColumnSpan()
```
    Returns how much this cell is spanning in column, 1 means the cell is not spanning.
    
    Returns:
    
    how much this cell is spanning in column, 1 is normal.
  - setColumnSpan
```
void setColumnSpan(int columnSpan)
```
    Sets how much this cell is spanning in column. See SpreadsheetCell description for information. You should use Grid.spanColumn(int, int, int) instead of using this method directly. 1 means the cell is not spanning. Thus, the rowSpan should not be inferior to 1.
    
    Parameters:
    
    columnSpan - the columnSpan for this cell
  - getStyleClass
```
javafx.collections.ObservableSet<java.lang.String> getStyleClass()
```
    Returns an ObservableList of String of all the style class associated with this cell. You can easily modify its appearance by adding a style class (previously set in CSS).
    
    Returns:
    
    an ObservableList of String of all the style class of this cell
  - graphicProperty
```
javafx.beans.property.ObjectProperty<javafx.scene.Node> graphicProperty()
```
    Returns the ObjectProperty representing this cell graphic.
    
    See Also:
    
    getGraphic(), setGraphic(Node)
  - setGraphic
```
void setGraphic(javafx.scene.Node graphic)
```
    Sets a graphic for this cell. It is displayed aside with the text if any is specified. Otherwise it's fully displayed in the cell.
    
    Parameters:
    
    graphic - a graphic to display for this cell
  - getGraphic
```
javafx.scene.Node getGraphic()
```
    Returns the graphic node associated with this cell. Returns null if nothing has been associated.
    
    Returns:
    
    the graphic node associated with this cell
  - getTooltip
```
java.util.Optional<java.lang.String> getTooltip()
```
    Returns the tooltip for this cell.
    
    Returns:
    
    the tooltip associated with this SpreadsheetCell
  - addEventHandler
```
void addEventHandler(javafx.event.EventType<javafx.event.Event> eventType,
                     javafx.event.EventHandler<javafx.event.Event> eventHandler)
```
    Registers an event handler to this SpreadsheetCell.
    
    Parameters:
    
    eventType - the type of the events to receive by the handler
    
    eventHandler - the handler to register
    
    Throws:
    
    java.lang.NullPointerException - if the event type or handler is null
  - removeEventHandler
```
void removeEventHandler(javafx.event.EventType<javafx.event.Event> eventType,
                        javafx.event.EventHandler<javafx.event.Event> eventHandler)
```
    Unregisters a previously registered event handler from this SpreadsheetCell.
    
    Parameters:
    
    eventType - the event type from which to unregister
    
    eventHandler - the handler to unregister
    
    Throws:
    
    java.lang.NullPointerException - if the event type or handler is null

Interface SpreadsheetCell

Property Summary

Nested Class Summary

Field Summary

Method Summary

Property Detail

item

style

format

text

graphic

Field Detail

EDITABLE_EVENT_TYPE

WRAP_EVENT_TYPE

CORNER_EVENT_TYPE

Method Detail

match

setItem

getItem

itemProperty

isEditable

setEditable

isWrapText

isCellGraphic

setCellGraphic

setWrapText

getOptionsForEditor

hasPopup

setHasPopup

getPopupItems

setStyle

getStyle

styleProperty

activateCorner

deactivateCorner

isCornerActivated

formatProperty

getFormat

setFormat

textProperty

getText

getCellType

getRow

getColumn

getRowSpan

setRowSpan

getColumnSpan

setColumnSpan

getStyleClass

graphicProperty

setGraphic

getGraphic

getTooltip

addEventHandler

removeEventHandler