Module javafx.controls
Package javafx.scene.control.cell

Class ProgressBarTableCell<S>

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
javafx.scene.control.Labeled
javafx.scene.control.Cell<T>
javafx.scene.control.IndexedCell<T>
javafx.scene.control.TableCell<S,Double>
javafx.scene.control.cell.ProgressBarTableCell<S>
Type Parameters:
S - The type of the elements contained within the TableView.
All Implemented Interfaces:
Styleable, EventTarget, Skinnable
public class ProgressBarTableCell<S> extends TableCell<S,Double>
A class containing a TableCell implementation that draws a ProgressBar node inside the cell.
Since:
JavaFX 2.2

  • Constructor Details

    • ProgressBarTableCell

      public ProgressBarTableCell()
      Creates a default ProgressBarTableCell instance

  • Method Details

    • forTableColumn

      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.
      Type Parameters:
      S - The type of the TableView generic type
      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.

    • updateItem

      public void updateItem(Double item, boolean empty)
      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 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.
      Overrides:
      updateItem in class Cell<Double>
      Parameters:
      item - The new item for the cell.
      empty - whether or not this cell represents data from the list. If it is empty, then it does not represent any domain data, but is a cell being used to render an "empty" row.