org.dominokit.domino.ui.datatable.CellRenderer Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2019 Dominokit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.dominokit.domino.ui.datatable;

import static java.util.Objects.nonNull;

import elemental2.dom.HTMLTableCellElement;
import elemental2.dom.Node;
import org.dominokit.domino.ui.forms.validations.ValidationResult;

/**
 * An implementation of this interface will determine in how a table cell content will be displayed
 * and rendered in the table
 *
 * @param  the type of the data table records
 */
@FunctionalInterface
public interface CellRenderer {
  /**
   * Takes a cell info to determine what content to append to the cell element
   *
   * @param cellInfo {@link CellInfo}
   * @return the {@link Node} to be appended to the table cell element
   */
  Node asElement(CellInfo cellInfo);

  /**
   * A class containing all information required about a cell in a data table
   *
   * @param  the type of the data table records
   */
  class CellInfo {
    private final TableRow tableRow;
    private final HTMLTableCellElement element;
    private DirtyRecordHandler dirtyRecordHandler = dirty -> {};
    private CellValidator cellValidator = ValidationResult::valid;

    /**
     * Creates an instance with the row that the belongs to and the cell html element
     *
     * @param tableRow {@link TableRow}
     * @param element {@link HTMLTableCellElement} the td element
     */
    public CellInfo(TableRow tableRow, HTMLTableCellElement element) {
      this.tableRow = tableRow;
      this.element = element;
    }

    /** @return the {@link TableRow} the cell belongs to */
    public TableRow getTableRow() {
      return tableRow;
    }

    /** @return the {@link HTMLTableCellElement}, the td element */
    public HTMLTableCellElement getElement() {
      return element;
    }

    /** @return T the record instance being rendered on the row this belong to. */
    public T getRecord() {
      return tableRow.getRecord();
    }

    /**
     * For editable data table this will update the dirty record instance with the new fields values
     * in the row being edited
     *
     * @param dirtyRecord T, the current dirty record instance in the table row
     */
    public void updateDirtyRecord(T dirtyRecord) {
      if (nonNull(dirtyRecordHandler)) {
        this.dirtyRecordHandler.onUpdateDirtyRecord(dirtyRecord);
      }
    }

    /**
     * for editable cell this will validate the cell field
     *
     * @return the {@link ValidationResult}
     */
    public ValidationResult validate() {
      if (nonNull(cellValidator)) {
        return cellValidator.onValidate();
      }
      return ValidationResult.valid();
    }

    /**
     * set the handler to update the dirty record
     *
     * @param dirtyRecordHandler {@link DirtyRecordHandler}
     */
    public void setDirtyRecordHandler(DirtyRecordHandler dirtyRecordHandler) {
      this.dirtyRecordHandler = dirtyRecordHandler;
    }

    /**
     * for editable cells set the validator to validate the cell value when edited
     *
     * @param cellValidator {@link CellValidator}
     */
    public void setCellValidator(CellValidator cellValidator) {
      this.cellValidator = cellValidator;
    }
  }
}