Top Inners Fields Constructors Methods
org.kordamp.ikonli.javafx

public Class FontIconTableCell<S, T>

extends TableCell<S, T>
Class Inheritance
Imports
javafx.beans.property.ObjectProperty, .SimpleObjectProperty, javafx.beans.value.ChangeListener, .ObservableValue, javafx.geometry.Pos, javafx.scene.control.TableCell, .TableColumn, javafx.util.Callback, .StringConverter, org.kordamp.ikonli.Ikon

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static interface

Field Summary

Modifier and TypeField and Description
private final ObjectProperty<StringConverter<T>>
private static final String
private final FontIcon
private FontIconTableCell.Subscription

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
public final ObjectProperty<StringConverter<T>>
public static <S, T> Callback<TableColumn<S, T>, TableCell<S, T>>
public static <S, T> Callback<TableColumn<S, T>, TableCell<S, T>>
public final StringConverter<T>
public final void
private void
setIconCode(T value)

public void
updateItem(T
The new item for the cell.
item
,
boolean
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.
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

converterback to summary
private final ObjectProperty<StringConverter<T>> converter
ERROR_CONVERTER_NULLback to summary
private static final String ERROR_CONVERTER_NULL
iconback to summary
private final FontIcon icon
subscriptionback to summary
private FontIconTableCell.Subscription subscription

Constructor Detail

FontIconTableCellback to summary
public FontIconTableCell()
Annotations
@SuppressWarnings:unchecked
FontIconTableCellback to summary
public FontIconTableCell(StringConverter<T> converter)

Method Detail

converterPropertyback to summary
public final ObjectProperty<StringConverter<T>> converterProperty()
forTableColumnback to summary
public static <S, T> Callback<TableColumn<S, T>, TableCell<S, T>> forTableColumn()
forTableColumnback to summary
public static <S, T> Callback<TableColumn<S, T>, TableCell<S, T>> forTableColumn(StringConverter<T> converter)
getConverterback to summary
public final StringConverter<T> getConverter()
setConverterback to summary
public final void setConverter(StringConverter<T> converter)
setIconCodeback to summary
private void setIconCode(T value)
updateItemback to summary
public void updateItem(T 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.
Parameters
item:T

The new item for the cell.

empty:boolean

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.

Annotations
@Override
org.kordamp.ikonli.javafx back to summary

private Interface FontIconTableCell.Subscription


Method Summary

Modifier and TypeMethod and Description
public void

Method Detail

unsubscribeback to summary
public void unsubscribe()