Top Description Inners Fields Constructors Methods
javafx.scene.control

public Class TableColumn<S, T>

extends TableColumnBase<S, T>
implements EventTarget
Class Inheritance
All Implemented Interfaces
javafx.event.EventTarget
Type Parameters
<S>
The type of the TableView generic type (i.e. S == TableView<S>)
<T>
The type of the content in all cells in this TableColumn.
Imports
com.sun.javafx.scene.control.Properties, javafx.scene.control.skin.NestedTableColumnHeader, .TableColumnHeader, .TableHeaderRow, .TableViewSkin, javafx.beans.property.ObjectProperty, .SimpleObjectProperty, .ReadOnlyObjectProperty, .ReadOnlyObjectWrapper, javafx.collections.FXCollections, .ListChangeListener, .ObservableList, .WeakListChangeListener, javafx.css.CssMetaData, .Styleable, javafx.event.Event, .EventHandler, .EventTarget, .EventType, javafx.scene.Node, javafx.scene.control.cell.PropertyValueFactory, javafx.util.Callback, java.util.Collections, .List, .Map, javafx.beans.value.ObservableValue, .WritableValue

A TableView is made up of a number of TableColumn instances. Each TableColumn in a table is responsible for displaying (and editing) the contents of that column. As well as being responsible for displaying and editing data for a single column, a TableColumn also contains the necessary properties to: When creating a TableColumn instance, perhaps the two most important properties to set are the column text (what to show in the column header area), and the column cell value factory (which is used to populate individual cells in the column). This can be achieved using some variation on the following code:
ObservableList<Person> data = ...
TableView<Person> tableView = new TableView<Person>(data);

TableColumn<Person,String> firstNameCol = new TableColumn<Person,String>("First Name");
firstNameCol.setCellValueFactory(new Callback<CellDataFeatures<Person, String>, ObservableValue<String>>() {
    public ObservableValue<String> call(CellDataFeatures<Person, String> p) {
        // p.getValue() returns the Person instance for a particular TableView row
        return p.getValue().firstNameProperty();
    }
 });

tableView.getColumns().add(firstNameCol);}
This approach assumes that the object returned from p.getValue() has a JavaFX ObservableValue that can simply be returned. The benefit of this is that the TableView will internally create bindings to ensure that, should the returned ObservableValue change, the cell contents will be automatically refreshed.

In situations where a TableColumn must interact with classes created before JavaFX, or that generally do not wish to use JavaFX apis for properties, it is possible to wrap the returned value in a ReadOnlyObjectWrapper instance. For example:

firstNameCol.setCellValueFactory(new Callback<CellDataFeatures<Person, String>, ObservableValue<String>>() {
    public ObservableValue<String> call(CellDataFeatures<Person, String> p) {
        return new ReadOnlyObjectWrapper(p.getValue().getFirstName());
    }
 });
It is hoped that over time there will be convenience cell value factories developed and made available to developers. As of the JavaFX 2.0 release, there is one such convenience class: PropertyValueFactory. This class removes the need to write the code above, instead relying on reflection to look up a given property from a String. Refer to the PropertyValueFactory class documentation for more information on how to use this with a TableColumn. Finally, for more detail on how to use TableColumn, there is further documentation in the TableView class documentation.
Since
JavaFX 2.0
See Also
TableView, TableCell, TablePosition

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
TableColumn.CellDataFeatures<
The TableView type
S
,
The TableColumn type
T
>

A support class used in TableColumn as a wrapper class to provide all necessary information for a particular Cell.

public static class
TableColumn.CellEditEvent<
The type of the TableView generic type
S
,
The type of the content in all cells in this TableColumn
T
>

An event that is fired when a user performs an edit on a table cell.

public static enum
TableColumn.SortType

Enumeration that specifies the type of sorting being applied to a specific column.

Field Summary

Modifier and TypeField and Description
private final ObjectProperty<Callback<TableColumn<S, T>, TableCell<S, T>>>
cellFactory

The cell factory for all cells in this column.

private ObjectProperty<Callback<TableColumn.CellDataFeatures<S, T>, ObservableValue<T>>>
cellValueFactory

The cell value factory needs to be set to specify how to populate all cells within a single TableColumn.

private final ObservableList<TableColumn<S, ?>>
private ListChangeListener<TableColumn<S, ?>>
public static final Callback<TableColumn<?, ?>, TableCell<?, ?>>
DEFAULT_CELL_FACTORY

If no cellFactory is specified on a TableColumn instance, then this one will be used by default.

private EventHandler<TableColumn.CellEditEvent<S, T>>
private static final String
private static final EventType<?>
private static final EventType<?>
private static final EventType<?>
private static final EventType<?>
private ObjectProperty<EventHandler<TableColumn.CellEditEvent<S, T>>>
private ObjectProperty<EventHandler<TableColumn.CellEditEvent<S, T>>>
private ObjectProperty<EventHandler<TableColumn.CellEditEvent<S, T>>>
private ObjectProperty<TableColumn.SortType>
sortType

Used to state whether this column, if it is part of a sort order (see TableView#getSortOrder() for more details), should be sorted in ascending or descending order.

private ReadOnlyObjectWrapper<TableView<S>>
tableView

The TableView that this TableColumn belongs to.

private WeakListChangeListener<TableColumn<S, ?>>
Inherited from javafx.scene.control.TableColumnBase:
DEFAULT_COMPARATORDEFAULT_MAX_WIDTHDEFAULT_MIN_WIDTHDEFAULT_WIDTHeventHandlerManager

Constructor Summary

AccessConstructor and Description
public
TableColumn()

Creates a default TableColumn with default cell factory, comparator, and onEditCommit implementation.

public
TableColumn(String
The string to show when the TableColumn is placed within the TableView.
text
)

Creates a TableColumn with the text set to the provided string, with default cell factory, comparator, and onEditCommit implementation.

Method Summary

Modifier and TypeMethod and Description
public final ObjectProperty<Callback<TableColumn<S, T>, TableCell<S, T>>>
public final ObjectProperty<Callback<TableColumn.CellDataFeatures<S, T>, ObservableValue<T>>>
public static <
The type of the TableView generic type
S
,
The type of the content in all cells in this TableColumn
T
>
EventType<TableColumn.CellEditEvent<S, T>>

Returns:

The any TableColumn edit event
editAnyEvent
()

Parent event for any TableColumn edit event.

public static <
The type of the TableView generic type
S
,
The type of the content in all cells in this TableColumn
T
>
EventType<TableColumn.CellEditEvent<S, T>>

Returns:

The cancel an edit event
editCancelEvent
()

Indicates that the editing has been canceled, meaning that no change should be made to the backing data source.

public static <
The type of the TableView generic type
S
,
The type of the content in all cells in this TableColumn
T
>
EventType<TableColumn.CellEditEvent<S, T>>

Returns:

The commit an edit event
editCommitEvent
()

Indicates that the editing has been committed by the user, meaning that a change should be made to the backing data source to reflect the new data.

public static <
The type of the TableView generic type
S
,
The type of the content in all cells in this TableColumn
T
>
EventType<TableColumn.CellEditEvent<S, T>>

Returns:

The start an edit event
editStartEvent
()

Indicates that the user has performed some interaction to start an edit event, or alternatively the TableView#edit(int, javafx.scene.control.TableColumn) method has been called.

public final Callback<TableColumn<S, T>, TableCell<S, T>>
public final ObservableValue<T>
getCellObservableValue(int
The index of the item (of type S) for which an ObservableValue<T> is sought.
index
)

Implements abstract javafx.scene.control.TableColumnBase.getCellObservableValue.

Attempts to return an ObservableValue<T> for the item in the given index (which is of type S).

public final ObservableValue<T>
getCellObservableValue(S
The item (of type S) for which an ObservableValue<T> is sought.
item
)

Implements abstract javafx.scene.control.TableColumnBase.getCellObservableValue.

Attempts to return an ObservableValue<T> for the given item (which is of type S).

public final Callback<TableColumn.CellDataFeatures<S, T>, ObservableValue<T>>
public static List<CssMetaData<? extends Styleable, ?>>

Returns:

the CssMetaData
getClassCssMetaData
()

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

public final ObservableList<TableColumn<S, ?>>
getColumns()

Implements abstract javafx.scene.control.TableColumnBase.getColumns.

This enables support for nested columns, which can be useful to group together related data.

public List<CssMetaData<? extends Styleable, ?>>
getCssMetaData()

Implements javafx.css.Styleable.getCssMetaData.

The CssMetaData of this Styleable.

public final EventHandler<TableColumn.CellEditEvent<S, T>>
public final EventHandler<TableColumn.CellEditEvent<S, T>>
public final EventHandler<TableColumn.CellEditEvent<S, T>>
public final TableColumn.SortType
public Node
getStyleableNode()

Overrides default javafx.css.Styleable.getStyleableNode.

Returns the Node that represents this Styleable object.

public Styleable

Returns:

getTableView()
getStyleableParent
()

Implements javafx.css.Styleable.getStyleableParent.

Return the parent of this Styleable, or null if there is no parent.

public final TableView<S>
public String

Returns:

"TableColumn"
getTypeSelector
()

Implements javafx.css.Styleable.getTypeSelector.

The type of this Styleable that is to be used in selector matching.

public final ObjectProperty<EventHandler<TableColumn.CellEditEvent<S, T>>>

Returns:

the on edit cancel property
onEditCancelProperty
()

This event handler will be fired when the user cancels editing a cell.

public final ObjectProperty<EventHandler<TableColumn.CellEditEvent<S, T>>>

Returns:

the on edit commit property
onEditCommitProperty
()

This event handler will be fired when the user successfully commits their editing.

public final ObjectProperty<EventHandler<TableColumn.CellEditEvent<S, T>>>

Returns:

the on edit start property
onEditStartProperty
()

This event handler will be fired when the user successfully initiates editing.

private TableColumnHeader
public final void
public final void
public final void
public final void
public final void
public final void
pack-priv final void
public final ObjectProperty<TableColumn.SortType>
public final ReadOnlyObjectProperty<TableView<S>>
Inherited from javafx.scene.control.TableColumnBase:
addEventFilteraddEventHandlerbuildEventDispatchChaincomparatorPropertycontextMenuPropertydoSetWidtheditablePropertygetCellDatagetCellDatagetComparatorgetContextMenugetGraphicgetIdgetMaxWidthgetMinWidthgetParentColumngetPrefWidthgetPropertiesgetPseudoClassStatesgetSortNodegetStylegetStyleClassgetTextgetUserDatagetWidthgraphicPropertyhasPropertiesidPropertyisEditableisReorderableisResizableisSortableisVisiblemaxWidthPropertyminWidthPropertyparentColumnPropertyprefWidthPropertyremoveEventFilterremoveEventHandlerreorderablePropertyresizablePropertysetComparatorsetContextMenusetEditablesetGraphicsetIdsetMaxWidthsetMinWidthsetParentColumnsetPrefWidthsetReorderablesetResizablesetSortablesetSortNodesetStylesetTextsetUserDatasetVisiblesetWidthsortablePropertysortNodePropertystylePropertytextPropertyupdateColumnWidthsvisiblePropertywidthProperty