Verified Owner
Top Fields Constructors Methods
org.jabref.gui.externalfiles

public Class UnlinkedFilesCellFactory

extends CheckBoxTreeCell<FileNodeViewModel>
Class Inheritance
Imports
javafx.collections.ObservableList, javafx.scene.control.Button, .CheckBox, .ComboBox, .Label, .Tooltip, javafx.scene.control.cell.CheckBoxTreeCell, javafx.scene.layout.HBox, .Priority, org.jabref.gui.StateManager, org.jabref.gui.icon.IconTheme, org.jabref.gui.util.FileNodeViewModel, .ViewModelListCellFactory, org.jabref.logic.l10n.Localization, org.jabref.model.entry.BibEntry

Field Summary

Modifier and TypeField and Description
private final HBox
private final Button
private final HBox
private final Button
private final HBox
private final ComboBox<BibEntry>
private final StateManager
private final UnlinkedFilesDialogViewModel

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
updateItem(FileNodeViewModel item, boolean empty)

Overrides javafx.scene.control.cell.CheckBoxTreeCell.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.cell.CheckBoxTreeCell:
converterPropertyforTreeViewforTreeViewforTreeViewgetConvertergetSelectedStateCallbackqueryAccessibleAttributeselectedStateCallbackPropertysetConvertersetSelectedStateCallback

Field Detail

cellContentback to summary
private final HBox cellContent
doNotLinkButtonback to summary
private final Button doNotLinkButton
jumpIconback to summary
private final HBox jumpIcon
jumpToEntryButtonback to summary
private final Button jumpToEntryButton
leftSideback to summary
private final HBox leftSide
relatedEntriesback to summary
private final ComboBox<BibEntry> relatedEntries
stateManagerback to summary
private final StateManager stateManager
viewModelback to summary
private final UnlinkedFilesDialogViewModel viewModel

Constructor Detail

UnlinkedFilesCellFactoryback to summary
public UnlinkedFilesCellFactory(StateManager stateManager, UnlinkedFilesDialogViewModel viewModel)

Method Detail

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

Overrides javafx.scene.control.cell.CheckBoxTreeCell.updateItem.

Doc from javafx.scene.control.cell.CheckBoxTreeCell.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