APIdia Launch Partner
Top Description Fields Constructors Methods
javafx.scene.control.cell

public Class ProgressBarTableCell<S>

extends TableCell<S, Double>
Class Inheritance
Type Parameters
<S>
The type of the elements contained within the TableView.
Imports
javafx.beans.value.ObservableValue, javafx.scene.control.ProgressBar, .TableCell, .TableColumn, javafx.util.Callback

A class containing a TableCell implementation that draws a ProgressBar node inside the cell.
Since
JavaFX 2.2

Field Summary

Modifier and TypeField and Description
private ObservableValue<Double>
private final ProgressBar

Constructor Summary

AccessConstructor and Description
public
ProgressBarTableCell()

Creates a default ProgressBarTableCell instance

Method Summary

Modifier and TypeMethod and Description
public static <
The type of the TableView generic type
S
>
Callback<TableColumn<S, Double>, TableCell<S, Double>>

Returns:

A Callback that can be inserted into the cell factory property of a TableColumn, that enables visualisation of a Number as it progresses from 0.0 to 1.0.
forTableColumn
()

Provides a ProgressBar that allows easy visualisation of a Number value as it proceeds from 0.0 to 1.0.

public void
updateItem(Double item, boolean empty)

Overrides javafx.scene.control.Cell.updateItem.

The updateItem method should not be called by developers, but it is the best method for developers to override to allow for them to customise the visuals of the cell.

Inherited from javafx.scene.control.TableCell:
cancelEditcommitEditcreateDefaultSkinexecuteAccessibleActiongetTableColumngetTableRowgetTableViewlayoutChildrenqueryAccessibleAttributestartEdittableColumnPropertytableRowPropertytableViewPropertyupdateSelectedupdateTableColumnupdateTableRowupdateTableView

Field Detail

observableback to summary
private ObservableValue<Double> observable
progressBarback to summary
private final ProgressBar progressBar

Constructor Detail

ProgressBarTableCellback to summary
public ProgressBarTableCell()

Creates a default ProgressBarTableCell instance

Method Detail

forTableColumnback to summary
public static <S> Callback<TableColumn<S, Double>, TableCell<S, Double>> forTableColumn()

Provides a ProgressBar that allows easy visualisation of a Number value as it proceeds from 0.0 to 1.0. If the value is -1, the progress bar will appear indeterminate.

Parameters
<S>
The type of the TableView generic type
Returns:Callback<TableColumn<S, Double>, TableCell<S, Double>>

A Callback that can be inserted into the cell factory property of a TableColumn, that enables visualisation of a Number as it progresses from 0.0 to 1.0.

updateItemback to summary
public void updateItem(Double item, boolean empty)

Overrides javafx.scene.control.Cell.updateItem.

Doc from javafx.scene.control.Cell.updateItem.

The updateItem method should not be called by developers, but it is the best method for developers to override to allow for them to customise the visuals of the cell. To clarify, developers should never call this method in their code (they should leave it up to the UI control, such as the javafx.scene.control.ListView control) to call this method. However, the purpose of having the updateItem method is so that developers, when specifying custom cell factories (again, like the ListView cell factory), the updateItem method can be overridden to allow for complete customisation of the cell.

It is very important that subclasses of Cell override the updateItem method properly, as failure to do so will lead to issues such as blank cells or cells with unexpected content appearing within them. Here is an example of how to properly override the updateItem method:

protected void updateItem(T item, boolean empty) {
    super.updateItem(item, empty);

    if (empty || item == null) {
        setText(null);
        setGraphic(null);
    } else {
        setText(item.toString());
    }
}

Note in this code sample two important points:

  1. We call the super.updateItem(T, boolean) method. If this is not done, the item and empty properties are not correctly set, and you are likely to end up with graphical issues.
  2. We test for the empty condition, and if true, we set the text and graphic properties to null. If we do not do this, it is almost guaranteed that end users will see graphical artifacts in cells unexpectedly.
Annotations
@Override