cz.masci.commons.springfx.utility.StyleChangingRowFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-springfx-mve Show documentation
Commons Spring for JavaFX - Master-View-Editor
There is a newer version: 0.0.30
package cz.masci.commons.springfx.utility;

import cz.masci.commons.springfx.data.Modifiable;
import java.util.Collections;
import javafx.collections.ListChangeListener;
import javafx.collections.ObservableList;
import javafx.scene.control.TableRow;
import javafx.scene.control.TableView;
import javafx.util.Callback;

/**
 * Row factory for items in observable list. Add style class to the row if
 * the item is found in the list.
 *
 * @author Daniel Masek
 * @param  Type of table item
 */
public class StyleChangingRowFactory implements Callback, TableRow> {

  private final ObservableList selectionList;
  private final String styleClass;
  private final Callback, TableRow> baseFactory;

  /**
   * Constructor with all parameters
   *
   * @param styleClass Name of the style class
   * @param selectionList Observable list of selected items
   * @param baseFactory Row base factory
   */
  public StyleChangingRowFactory(String styleClass, ObservableList selectionList, Callback, TableRow> baseFactory) {
    this.styleClass = styleClass;
    this.selectionList = selectionList;
    this.baseFactory = baseFactory;
  }

  /**
   * Constructor with all parameters
   *
   * @param styleClass Name of the style class
   * @param selectionList Observable list of selected items
   */
  public StyleChangingRowFactory(String styleClass, ObservableList selectionList) {
    this(styleClass, selectionList, null);
  }

  /**
   * Add listener on table item to an observable list to check the item existence
   * and therefor style changing.
   *
   * @param tableView Table view to check
   * @return Table row
   */
  @Override
  public TableRow call(TableView tableView) {

    final TableRow row;
    if (baseFactory == null) {
      row = new TableRow<>();
    } else {
      row = baseFactory.call(tableView);
    }

    // listen to row selection in the table view
    row.itemProperty().addListener((obs, oldValue, newValue) -> updateStyleClass(row));

    // listen to adding item to the selection list
    selectionList.addListener(createListChangeListener(row));

    return row;
  }

  /**
   * Listen to change in selection list.
   *
   * @param row Selected row
   * @return list change listener
   */
  private ListChangeListener createListChangeListener(TableRow row) {
    return (change -> updateStyleClass(row));
  }

  /**
   * Add or remove style class from row style classes based on existence of
   * selected item in the selection list.
   *
   * @param row Selected table row
   */
  private void updateStyleClass(TableRow row) {
    final ObservableList rowStyleClasses = row.getStyleClass();
    if (selectionList.contains(row.getItem())) {
      if (!rowStyleClasses.contains(styleClass)) {
        rowStyleClasses.add(styleClass);
      }
    } else {
      // remove all occurrences of styleClass:
      rowStyleClasses.removeAll(Collections.singleton(styleClass));
    }
  }

}