griffon.javafx.scene.control.DefaultTableViewModel Maven / Gradle / Ivy

Go to download
/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright 2008-2018 the original author or authors.
 *
 * 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 griffon.javafx.scene.control;

import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import javafx.scene.control.TableColumn;
import javafx.scene.control.TableView;

import javax.annotation.Nonnull;
import java.util.ArrayList;
import java.util.List;

import static griffon.util.GriffonClassUtils.requireState;
import static java.util.Objects.requireNonNull;

/**
 * @author Andres Almiray
 * @since 2.11.0
 */
public class DefaultTableViewModel implements TableViewModel {
    private static final String ERROR_TABLE_VIEW_NULL = "Argument 'tableView' must not be null";

    protected final ObservableList source;
    protected final TableViewFormat format;
    protected final List> columns = new ArrayList<>();

    public DefaultTableViewModel(@Nonnull ObservableList source, @Nonnull TableViewFormat format) {
        this.source = requireNonNull(source, "Argument 'source' must not be null");
        this.format = requireNonNull(format, "Argument 'format' must not be null");
        computeColumns();
    }

    @SuppressWarnings("unchecked")
    protected void computeColumns() {
        for (int i = 0; i < format.getColumnCount(); i++) {
            final String columnName = format.getColumnName(i);
            TableColumn column = new TableColumn(columnName);

            final int columnIndex = i;
            final TableCellFactory tableCellFactory = format.getTableCellFactory(i);
            if (tableCellFactory != null) {
                column.setCellFactory(cell -> tableCellFactory.createTableCell((TableColumn) cell));
            }
            column.setCellValueFactory(cell -> format.getObservableValue((E) ((TableColumn.CellDataFeatures) cell).getValue(), columnIndex));

            columns.add(column);
        }
    }

    @Nonnull
    public ObservableList getSource() {
        return source;
    }

    @Nonnull
    public TableViewFormat getFormat() {
        return format;
    }

    @Nonnull
    @Override
    public TableColumn getColumnAt(int index) {
        requireState(index >= 0, "Argument 'index' must be greater or equal to zero");
        requireState(index < columns.size(), "Argument 'index' must be less than " + columns.size());
        return columns.get(index);
    }

    @Override
    public void attachTo(@Nonnull TableView tableView) {
        requireNonNull(tableView, ERROR_TABLE_VIEW_NULL);
        tableView.setColumnResizePolicy(TableView.CONSTRAINED_RESIZE_POLICY);
        tableView.setItems(source);
        tableView.getColumns().addAll(columns);
        resizeColumns();
    }

    protected void resizeColumns() {
        int proportionalSize = 100 / columns.size();
        for (int i = 0; i < columns.size(); i++) {
            Double size = format.getColumnSize(i);
            int columnSize = size != null ? (int) (100 * size) : proportionalSize;
            TableColumn column = columns.get(i);
            column.setMaxWidth(1f * Integer.MAX_VALUE * columnSize);
        }
    }

    @Override
    public void detachFrom(@Nonnull TableView tableView) {
        requireNonNull(tableView, ERROR_TABLE_VIEW_NULL);
        tableView.setItems(FXCollections.emptyObservableList());
        tableView.getColumns().removeAll(columns);
    }
}