class: TableColumn

[18:7] extends: TableColumnBase

TableColumn wraps javafx.scene.control.TableColumn, a single column of a TableView. It adds the column value and cell rendering, the sort type, and edit events on top of the shared TableColumnBase surface. A column needs a cell value factory to know what to display. Use mapValue(key) for map-shaped rows (the common case), or setCellValueFactory(callback) for full control.

Members

valueKey

Methods

TableColumn (Header = null)

Creates a TableColumn with an optional header.
- @p Header is the header text, or null for a headerless column.
setSortType (SortType)

Sets the column's sort direction.
- @p SortType is an fxsorttype value or the name string ("ASCENDING" or "DESCENDING"), or an AJO.
- @r this object for chaining.
getSortType ()

Returns the column's sort direction.
- @r An AJO around the SortType enum value (call name() for the string).
sortTypeProperty ()

Returns the sortType ObjectProperty for binding.
- @r An AJO around the ObjectProperty.
setCellValueFactory (callback Factory)

Sets the cell value factory that supplies each cell's value.
- @p Factory is a callback receiving a CellDataFeatures AJO and returning an ObservableValue (for example a ReadOnlyObjectWrapper).
- @r this object for chaining.
mapValue (string Key)

Convenience cell value factory for map-shaped rows: displays row[Key] for each row. This is the same behavior as the descriptor-based TableView.setColumns path, on a first-class column.
- @p Key is the row-map key whose value this column shows.
- @r this object for chaining.
onMapValue (Param)
getCellValueFactory ()

Returns the cell value factory.
- @r An AJO around the Callback.
cellValueFactoryProperty ()

Returns the cellValueFactory ObjectProperty for binding.
- @r An AJO around the ObjectProperty.
setCellFactory (callback Factory)

Sets the cell factory that builds each cell node. For custom rendering with a simpler callback, see setCellRenderer.
- @p Factory is a callback receiving the TableColumn and returning a TableCell.
- @r this object for chaining.
setCellRenderer (callback Renderer)

Sets a custom cell renderer, the easy path to custom cell display. The renderer runs for each non-empty cell and receives the cell value (as a native Aussom value) and the cell itself (an AJO), on which it can call setText, setGraphic, or setStyle. Empty cells are cleared automatically, and the text defaults to the value's string form before the renderer runs, so a renderer that only sets a style still shows the value.
- @p Renderer is a callback receiving (item, cell).
- @r this object for chaining.
getCellFactory ()

Returns the cell factory.
- @r An AJO around the Callback.
cellFactoryProperty ()

Returns the cellFactory ObjectProperty for binding.
- @r An AJO around the ObjectProperty.
setOnEditCommit (callback Cb)

Sets a handler for commit of an edit in this column.
- @p Cb is a callback receiving the CellEditEvent.
- @r this object for chaining.
setOnEditStart (callback Cb)

Sets a handler for the start of an edit in this column.
- @p Cb is a callback receiving the CellEditEvent.
- @r this object for chaining.
setOnEditCancel (callback Cb)

Sets a handler for cancellation of an edit in this column.
- @p Cb is a callback receiving the CellEditEvent.
- @r this object for chaining.
getOnEditCommit ()

Returns the edit-commit handler.
- @r An AJO around the EventHandler, or null.
getOnEditStart ()

Returns the edit-start handler.
- @r An AJO around the EventHandler, or null.
getOnEditCancel ()

Returns the edit-cancel handler.
- @r An AJO around the EventHandler, or null.
getTableView ()

Returns the TableView this column belongs to.
- @r An AJO around the TableView, or null when not added to a table.
tableViewProperty ()

Returns the tableView ReadOnlyObjectProperty for binding.
- @r An AJO around the ReadOnlyObjectProperty.