javafx.scene.control.cell.ProgressBarTreeTableCell Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of openjfx-78-backport Show documentation
This is a backport of OpenJFX 8 to run on Java 7.
The newest version!
/*
 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javafx.scene.control.cell;

import javafx.beans.value.ObservableValue;
import javafx.scene.control.ProgressBar;
import javafx.scene.control.TreeTableCell;
import javafx.scene.control.TreeTableColumn;
import javafx.util.Callback;

/**
 * A class containing a {@link TreeTableCell} implementation that draws a 
 * {@link ProgressBar} node inside the cell.
 * 
 * @param  The type of the elements contained within the TableView.
 * @since JavaFX 8.0
 */
public class ProgressBarTreeTableCell extends TreeTableCell {
    
    /***************************************************************************
     *                                                                         *
     * Static cell factories                                                   *
     *                                                                         *
     **************************************************************************/
    
    /**
     * Provides a {@link ProgressBar} that allows easy visualisation of a Number 
     * value as it proceeds from 0.0 to 1.0. If the value is -1, the progress 
     * bar will appear indeterminate.
     * 
     * @return A {@link Callback} that can be inserted into the 
     *      {@link TreeTableColumn#cellFactoryProperty() cell factory property} of a
     *      TreeTableColumn, that enables visualisation of a Number as it progresses 
     *      from 0.0 to 1.0.
     */
    public static  Callback, TreeTableCell> forTreeTableColumn() {
        return new Callback, TreeTableCell>() {
            @Override public TreeTableCell call(TreeTableColumn param) {
                return new ProgressBarTreeTableCell();
            }
        };
    }
    
    
    
    /***************************************************************************
     *                                                                         *
     * Fields                                                                  *
     *                                                                         *
     **************************************************************************/
    
    private final ProgressBar progressBar;
    
    private ObservableValue observable;
    
    
    
    /***************************************************************************
     *                                                                         *
     * Constructors                                                            *
     *                                                                         *
     **************************************************************************/    
    
    /**
     * Creates a default {@link ProgressBarTreeTableCell} instance
     */
    public ProgressBarTreeTableCell() {
        this.getStyleClass().add("progress-bar-tree-table-cell");
        
        this.progressBar = new ProgressBar();
        setGraphic(progressBar);
    }
    
    
    
    /***************************************************************************
     *                                                                         *
     * Public API                                                              *
     *                                                                         *
     **************************************************************************/    
    
    /** {@inheritDoc} */
    @Override public void updateItem(Double item, boolean empty) {
        super.updateItem(item, empty);
        
        if (empty) {
            setGraphic(null);
        } else {
            progressBar.progressProperty().unbind();
            
            observable = getTableColumn().getCellObservableValue(getIndex());
            if (observable != null) {
                progressBar.progressProperty().bind(observable);
            } else {
                progressBar.setProgress(item);
            }
            
            setGraphic(progressBar);
        }
    }
}