Top Description Fields Constructors Methods
org.controlsfx.control.cell

public Class ImageGridCell

extends GridCell<Image>
Class Inheritance
Imports
javafx.scene.image.Image, .ImageView, org.controlsfx.control.GridCell, .GridView

A GridCell that can be used to show images inside the GridView control.
See Also
GridView

Field Summary

Modifier and TypeField and Description
private final ImageView
private final boolean

Constructor Summary

AccessConstructor and Description
public
ImageGridCell()

Creates a default ImageGridCell instance, which will preserve image properties

public
ImageGridCell(boolean
if set to true will preserve image aspect ratio and smoothness
preserveImageProperties
)

Create ImageGridCell instance

Method Summary

Modifier and TypeMethod and Description
protected void
updateItem(Image 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 org.controlsfx.control.GridCell:
createDefaultSkingetGridViewgridViewPropertyupdateGridView

Field Detail

imageViewback to summary
private final ImageView imageView
preserveImagePropertiesback to summary
private final boolean preserveImageProperties

Constructor Detail

ImageGridCellback to summary
public ImageGridCell()

Creates a default ImageGridCell instance, which will preserve image properties

ImageGridCellback to summary
public ImageGridCell(boolean preserveImageProperties)

Create ImageGridCell instance

Parameters
preserveImageProperties:boolean

if set to true will preserve image aspect ratio and smoothness

Method Detail

updateItemback to summary
protected void updateItem(Image 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