Class TreeTableColumn<S,​T>

treeTableView

public final ReadOnlyObjectProperty<TreeTableView<S>> treeTableViewProperty

See Also:

getTreeTableView()

cellValueFactory

public final ObjectProperty<Callback<TreeTableColumn.CellDataFeatures<S,T>,​ObservableValue<T>>> cellValueFactoryProperty

 firstNameCol.setCellValueFactory(new Callback<CellDataFeatures<Person, String>, ObservableValue<String>>() {
     public ObservableValue<String> call(CellDataFeatures<Person, String> p) {
         // p.getValue() returns the TreeItem<Person> instance for a particular TreeTableView row,
         // p.getValue().getValue() returns the Person instance inside the TreeItem<Person>
         return p.getValue().getValue().firstNameProperty();
     }
  });
 }

 firstNameCol.setCellValueFactory(new TreeItemPropertyValueFactory<Person,String>("firstName"));
 

See Also:

getCellValueFactory(), setCellValueFactory(Callback)

cellFactory

public final ObjectProperty<Callback<TreeTableColumn<S,T>,​TreeTableCell<S,​T>>> cellFactoryProperty

See Also:

getCellFactory(), setCellFactory(Callback)

sortType

public final ObjectProperty<TreeTableColumn.SortType> sortTypeProperty

See Also:

getSortType(), setSortType(TreeTableColumn.SortType)

onEditStart

public final ObjectProperty<EventHandler<TreeTableColumn.CellEditEvent<S,T>>> onEditStartProperty

See Also:

getOnEditStart(), setOnEditStart(EventHandler)

onEditCommit

public final ObjectProperty<EventHandler<TreeTableColumn.CellEditEvent<S,T>>> onEditCommitProperty

See Also:

getOnEditCommit(), setOnEditCommit(EventHandler)

onEditCancel

public final ObjectProperty<EventHandler<TreeTableColumn.CellEditEvent<S,T>>> onEditCancelProperty

See Also:

getOnEditCancel(), setOnEditCancel(EventHandler)

DEFAULT_CELL_FACTORY

public static final Callback<TreeTableColumn<?,?>,​TreeTableCell<?,​?>> DEFAULT_CELL_FACTORY

TreeTableColumn

public TreeTableColumn()

TreeTableColumn

public TreeTableColumn(String text)

Parameters:

text - The string to show when the TreeTableColumn is placed within the TreeTableView.

editAnyEvent

public static <S, T> EventType<TreeTableColumn.CellEditEvent<S,​T>> editAnyEvent()

Type Parameters:

S - the type of the TreeTableView generic type

T - the type of the content in all cells in this TreeTableColumn

Returns:

the edit event

editStartEvent

public static <S, T> EventType<TreeTableColumn.CellEditEvent<S,​T>> editStartEvent()

Type Parameters:

S - the type of the TreeTableView generic type

T - the type of the content in all cells in this TreeTableColumn

Returns:

the edit start event

editCancelEvent

public static <S, T> EventType<TreeTableColumn.CellEditEvent<S,​T>> editCancelEvent()

Type Parameters:

S - the type of the TreeTableView generic type

T - the type of the content in all cells in this TreeTableColumn

Returns:

the edit cancel event

editCommitEvent

public static <S, T> EventType<TreeTableColumn.CellEditEvent<S,​T>> editCommitEvent()

Type Parameters:

S - the type of the TreeTableView generic type

T - the type of the content in all cells in this TreeTableColumn

Returns:

the edit commit event

treeTableViewProperty

public final ReadOnlyObjectProperty<TreeTableView<S>> treeTableViewProperty()

See Also:

getTreeTableView()

getTreeTableView

public final TreeTableView<S> getTreeTableView()

Property description:

The TreeTableView that this TreeTableColumn belongs to.

setCellValueFactory

public final void setCellValueFactory(Callback<TreeTableColumn.CellDataFeatures<S,​T>,​ObservableValue<T>> value)

Property description:

The cell value factory needs to be set to specify how to populate all cells within a single TreeTableColumn. A cell value factory is a Callback that provides a TreeTableColumn.CellDataFeatures instance, and expects an ObservableValue to be returned. The returned ObservableValue instance will be observed internally to allow for updates to the value to be immediately reflected on screen.

An example of how to set a cell value factory is:

 firstNameCol.setCellValueFactory(new Callback<CellDataFeatures<Person, String>, ObservableValue<String>>() {
     public ObservableValue<String> call(CellDataFeatures<Person, String> p) {
         // p.getValue() returns the TreeItem<Person> instance for a particular TreeTableView row,
         // p.getValue().getValue() returns the Person instance inside the TreeItem<Person>
         return p.getValue().getValue().firstNameProperty();
     }
  });
 }

A common approach is to want to populate cells in a TreeTableColumn using a single value from a Java bean. To support this common scenario, there is the TreeItemPropertyValueFactory class. Refer to this class for more information on how to use it, but briefly here is how the above use case could be simplified using the TreeItemPropertyValueFactory class:

 firstNameCol.setCellValueFactory(new TreeItemPropertyValueFactory<Person,String>("firstName"));
 

getCellValueFactory

public final Callback<TreeTableColumn.CellDataFeatures<S,T>,​ObservableValue<T>> getCellValueFactory()

Property description:

The cell value factory needs to be set to specify how to populate all cells within a single TreeTableColumn. A cell value factory is a Callback that provides a TreeTableColumn.CellDataFeatures instance, and expects an ObservableValue to be returned. The returned ObservableValue instance will be observed internally to allow for updates to the value to be immediately reflected on screen.

An example of how to set a cell value factory is:

 firstNameCol.setCellValueFactory(new Callback<CellDataFeatures<Person, String>, ObservableValue<String>>() {
     public ObservableValue<String> call(CellDataFeatures<Person, String> p) {
         // p.getValue() returns the TreeItem<Person> instance for a particular TreeTableView row,
         // p.getValue().getValue() returns the Person instance inside the TreeItem<Person>
         return p.getValue().getValue().firstNameProperty();
     }
  });
 }

A common approach is to want to populate cells in a TreeTableColumn using a single value from a Java bean. To support this common scenario, there is the TreeItemPropertyValueFactory class. Refer to this class for more information on how to use it, but briefly here is how the above use case could be simplified using the TreeItemPropertyValueFactory class:

 firstNameCol.setCellValueFactory(new TreeItemPropertyValueFactory<Person,String>("firstName"));
 

cellValueFactoryProperty

public final ObjectProperty<Callback<TreeTableColumn.CellDataFeatures<S,T>,​ObservableValue<T>>> cellValueFactoryProperty()

 firstNameCol.setCellValueFactory(new Callback<CellDataFeatures<Person, String>, ObservableValue<String>>() {
     public ObservableValue<String> call(CellDataFeatures<Person, String> p) {
         // p.getValue() returns the TreeItem<Person> instance for a particular TreeTableView row,
         // p.getValue().getValue() returns the Person instance inside the TreeItem<Person>
         return p.getValue().getValue().firstNameProperty();
     }
  });
 }

 firstNameCol.setCellValueFactory(new TreeItemPropertyValueFactory<Person,String>("firstName"));
 

See Also:

getCellValueFactory(), setCellValueFactory(Callback)

setCellFactory

public final void setCellFactory(Callback<TreeTableColumn<S,​T>,​TreeTableCell<S,​T>> value)

Property description:

The cell factory for all cells in this column. The cell factory is responsible for rendering the data contained within each TreeTableCell for a single TreeTableColumn.

By default TreeTableColumn uses a default cell factory, but this can be replaced with a custom implementation, for example to show data in a different way or to support editing. There is a lot of documentation on creating custom cell factories elsewhere (see Cell and TreeTableView for example).

Finally, there are a number of pre-built cell factories available in the javafx.scene.control.cell package.

getCellFactory

public final Callback<TreeTableColumn<S,T>,​TreeTableCell<S,​T>> getCellFactory()

Property description:

The cell factory for all cells in this column. The cell factory is responsible for rendering the data contained within each TreeTableCell for a single TreeTableColumn.

By default TreeTableColumn uses a default cell factory, but this can be replaced with a custom implementation, for example to show data in a different way or to support editing. There is a lot of documentation on creating custom cell factories elsewhere (see Cell and TreeTableView for example).

Finally, there are a number of pre-built cell factories available in the javafx.scene.control.cell package.

cellFactoryProperty

public final ObjectProperty<Callback<TreeTableColumn<S,T>,​TreeTableCell<S,​T>>> cellFactoryProperty()

See Also:

getCellFactory(), setCellFactory(Callback)

sortTypeProperty

public final ObjectProperty<TreeTableColumn.SortType> sortTypeProperty()

See Also:

getSortType(), setSortType(TreeTableColumn.SortType)

setSortType

public final void setSortType(TreeTableColumn.SortType value)

Property description:

Used to state whether this column, if it is part of a sort order (see TreeTableView.getSortOrder() for more details), should be sorted in ascending or descending order. Simply toggling this property will result in the sort order changing in the TreeTableView, assuming of course that this column is in the sortOrder ObservableList to begin with.

getSortType

public final TreeTableColumn.SortType getSortType()

Property description:

Used to state whether this column, if it is part of a sort order (see TreeTableView.getSortOrder() for more details), should be sorted in ascending or descending order. Simply toggling this property will result in the sort order changing in the TreeTableView, assuming of course that this column is in the sortOrder ObservableList to begin with.

setOnEditStart

public final void setOnEditStart(EventHandler<TreeTableColumn.CellEditEvent<S,​T>> value)

Property description:

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

getOnEditStart

public final EventHandler<TreeTableColumn.CellEditEvent<S,T>> getOnEditStart()

Property description:

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

onEditStartProperty

public final ObjectProperty<EventHandler<TreeTableColumn.CellEditEvent<S,T>>> onEditStartProperty()

See Also:

getOnEditStart(), setOnEditStart(EventHandler)

setOnEditCommit

public final void setOnEditCommit(EventHandler<TreeTableColumn.CellEditEvent<S,​T>> value)

Property description:

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

getOnEditCommit

public final EventHandler<TreeTableColumn.CellEditEvent<S,T>> getOnEditCommit()

Property description:

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

onEditCommitProperty

public final ObjectProperty<EventHandler<TreeTableColumn.CellEditEvent<S,T>>> onEditCommitProperty()

See Also:

getOnEditCommit(), setOnEditCommit(EventHandler)

setOnEditCancel

public final void setOnEditCancel(EventHandler<TreeTableColumn.CellEditEvent<S,​T>> value)

Property description:

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

getOnEditCancel

public final EventHandler<TreeTableColumn.CellEditEvent<S,T>> getOnEditCancel()

Property description:

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

onEditCancelProperty

public final ObjectProperty<EventHandler<TreeTableColumn.CellEditEvent<S,T>>> onEditCancelProperty()

See Also:

getOnEditCancel(), setOnEditCancel(EventHandler)

getTypeSelector

public String getTypeSelector()

Specified by:

getTypeSelector in interface Styleable

Returns:

"TreeTableColumn"

getStyleableParent

public Styleable getStyleableParent()

Specified by:

getStyleableParent in interface Styleable

Returns:

getTreeTableView()

getClassCssMetaData

public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()