TableViewBindings.java

  1. /*
  2.  * *************************************************************************************************************************************************************
  3.  *
  4.  * SteelBlue: DCI User Interfaces
  5.  * http://tidalwave.it/projects/steelblue
  6.  *
  7.  * Copyright (C) 2015 - 2025 by Tidalwave s.a.s. (http://tidalwave.it)
  8.  *
  9.  * *************************************************************************************************************************************************************
  10.  *
  11.  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
  12.  * You may obtain a copy of the License at
  13.  *
  14.  *     http://www.apache.org/licenses/LICENSE-2.0
  15.  *
  16.  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
  17.  * CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and limitations under the License.
  18.  *
  19.  * *************************************************************************************************************************************************************
  20.  *
  21.  * git clone https://bitbucket.org/tidalwave/steelblue-src
  22.  * git clone https://github.com/tidalwave-it/steelblue-src
  23.  *
  24.  * *************************************************************************************************************************************************************
  25.  */
  26. package it.tidalwave.ui.javafx.impl.tableview;

  27. import jakarta.annotation.Nonnull;
  28. import java.util.Optional;
  29. import java.util.concurrent.Executor;
  30. import javafx.beans.property.ReadOnlyObjectProperty;
  31. import javafx.beans.value.ChangeListener;
  32. import javafx.collections.ObservableList;
  33. import javafx.scene.control.TableCell;
  34. import javafx.scene.control.TableColumn;
  35. import javafx.scene.control.TableView;
  36. import javafx.util.Callback;
  37. import it.tidalwave.ui.core.role.PresentationModel;
  38. import it.tidalwave.ui.javafx.impl.common.CellBinder;
  39. import it.tidalwave.ui.javafx.impl.common.ChangeListenerSelectableAdapter;
  40. import it.tidalwave.ui.javafx.impl.common.DelegateSupport;
  41. import it.tidalwave.ui.javafx.impl.common.JavaFXWorker;
  42. import it.tidalwave.ui.javafx.impl.common.PresentationModelObservable;
  43. import lombok.extern.slf4j.Slf4j;
  44. import static it.tidalwave.ui.javafx.impl.DefaultJavaFXBinder.enforceFxApplicationThread;
  45. import static it.tidalwave.ui.javafx.impl.common.JavaFXWorker.childrenPm;

  46. /***************************************************************************************************************************************************************
  47.  *
  48.  * This class takes care of bindings related to {@link TableView}.
  49.  *
  50.  * @author  Fabrizio Giudici
  51.  *
  52.  **************************************************************************************************************************************************************/
  53. @Slf4j
  54. public class TableViewBindings extends DelegateSupport
  55.   {
  56.     private final Callback<TableColumn<PresentationModel, PresentationModel>, TableCell<PresentationModel, PresentationModel>> cellFactory;

  57.     private final ChangeListener<PresentationModel> changeListener = new ChangeListenerSelectableAdapter(executor);

  58.     /***********************************************************************************************************************************************************
  59.      *
  60.      **********************************************************************************************************************************************************/
  61.     public TableViewBindings (@Nonnull final Executor executor, @Nonnull final CellBinder cellBinder)
  62.       {
  63.         super(executor);
  64.         cellFactory = ignored -> new AsObjectTableCell<>(cellBinder);
  65.       }

  66.     /***********************************************************************************************************************************************************
  67.      * Binds a {@link TableView}.
  68.      * @param   tableView           the {@code TableView}
  69.      * @param   pm                  the {@link PresentationModel}
  70.      * @param   callback            an optional callback to invoke at the end of the binding
  71.      **********************************************************************************************************************************************************/
  72.     public void bind (@Nonnull final TableView<PresentationModel> tableView, @Nonnull final PresentationModel pm, @Nonnull final Optional<Runnable> callback)
  73.       {
  74.         enforceFxApplicationThread();
  75.         log.debug("bind({}, {}, {})", tableView, pm, callback);
  76.         final var selectedProperty = tableView.getSelectionModel().selectedItemProperty();
  77.         selectedProperty.removeListener(changeListener);
  78.         JavaFXWorker.run(executor,
  79.                          () -> childrenPm(pm),
  80.                          items -> finalizeBinding(tableView, items, selectedProperty, callback));
  81.       }

  82.     /***********************************************************************************************************************************************************
  83.      * Finalizes binding in the JavaFX thread and eventually invokes a callback.
  84.      * @param   tableView           the {@link TableView}
  85.      * @param   items               the items of the table
  86.      * @param   selectedProperty    the 'selected' property
  87.      * @param   callback            an optional callback to invoke at the end
  88.      **********************************************************************************************************************************************************/
  89.     @SuppressWarnings("unchecked")
  90.     private void finalizeBinding (@Nonnull final TableView<PresentationModel> tableView,
  91.                                   @Nonnull final ObservableList<PresentationModel> items,
  92.                                   @Nonnull final ReadOnlyObjectProperty<PresentationModel> selectedProperty,
  93.                                   @Nonnull final Optional<Runnable> callback)
  94.       {
  95.         tableView.setItems(items);
  96.         selectedProperty.addListener(changeListener);
  97.         tableView.getColumns()
  98.                  .stream()
  99.                  .map(c -> (TableColumn<PresentationModel, PresentationModel>)c)
  100.                  .forEach(column ->
  101.           {
  102.             column.setCellValueFactory(PresentationModelObservable::of);
  103.             column.setCellFactory(cellFactory);
  104.           });

  105.         callback.ifPresent(Runnable::run);
  106.       }
  107.   }