impl.org.controlsfx.spreadsheet.HorizontalPicker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of controlsfx Show documentation
High quality UI controls and other tools to complement the core JavaFX distribution
There is a newer version: 11.2.1
/**
 * Copyright (c) 2014 ControlsFX
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *     * Neither the name of ControlsFX, any associated website, nor the
 * names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL CONTROLSFX BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package impl.org.controlsfx.spreadsheet;

import com.sun.javafx.scene.control.skin.TableColumnHeader;
import java.util.Stack;
import javafx.beans.InvalidationListener;
import javafx.beans.Observable;
import javafx.event.EventHandler;
import javafx.scene.control.Label;
import javafx.scene.input.MouseEvent;
import javafx.scene.layout.Region;
import javafx.scene.layout.StackPane;
import javafx.scene.shape.Rectangle;
import org.controlsfx.control.spreadsheet.Picker;
import org.controlsfx.control.spreadsheet.SpreadsheetView;

/**
 *
 * This class will display all the available pickers. It is a StackPane clipped
 * which contain a inner Region that display the picker. In that way, we don't
 * need to re-layout every time but just "slide" the inner Region inside this
 * class so that the pickers are sliding along with the TableColumnHeaders.
 */
public class HorizontalPicker extends StackPane {

    private static final String PICKER_INDEX = "PickerIndex"; //$NON-NLS-1$

    private final HorizontalHeader horizontalHeader;

    private final SpreadsheetView spv;
    private final Stack pickerPile;
    private final Stack pickerUsed;

    private final InnerHorizontalPicker innerPicker = new InnerHorizontalPicker();

    public HorizontalPicker(HorizontalHeader horizontalHeader, SpreadsheetView spv) {
        this.horizontalHeader = horizontalHeader;
        this.spv = spv;

        pickerPile = new Stack<>();
        pickerUsed = new Stack<>();

        //Clip this StackPane just like the TableHeaderRow.
        Rectangle clip = new Rectangle();
        clip.setSmooth(true);
        clip.setHeight(VerticalHeader.PICKER_SIZE);
        clip.widthProperty().bind(horizontalHeader.widthProperty());
        setClip(clip);

        getChildren().add(innerPicker);

        horizontalHeader.getRootHeader().getColumnHeaders().addListener(layoutListener);
        spv.getColumnPickers().addListener(layoutListener);
    }

    @Override
    protected void layoutChildren() {
        //Just relocate the inner for sliding.
        innerPicker.relocate(horizontalHeader.getRootHeader().getLayoutX(), snappedTopInset());
        //We must turn off pickers that are behind fixed columns
        for (Label label : pickerUsed) {
            label.setVisible(label.getLayoutX() + innerPicker.getLayoutX() + label.getWidth() > horizontalHeader.gridViewSkin.fixedColumnWidth);
        }
    }

    /**
     * Method called by the HorizontalHeader in order to slide the pickers.
     */
    public void updateScrollX() {
        requestLayout();
    }

    private Label getPicker(Picker picker) {
        Label pickerLabel;
        if (pickerPile.isEmpty()) {
            pickerLabel = new Label();
            pickerLabel.getStyleClass().addListener(layoutListener);
            pickerLabel.setOnMouseClicked(pickerMouseEvent);
        } else {
            pickerLabel = pickerPile.pop();
        }
        pickerUsed.push(pickerLabel);
        pickerLabel.getStyleClass().setAll(picker.getStyleClass());
        pickerLabel.getProperties().put(PICKER_INDEX, picker);
        return pickerLabel;
    }

    private final EventHandler pickerMouseEvent = (MouseEvent mouseEvent) -> {
        Label picker = (Label) mouseEvent.getSource();

        ((Picker) picker.getProperties().get(PICKER_INDEX)).onClick();
    };

    /**
     * Inner class that will lay out all the pickers.
     */
    private class InnerHorizontalPicker extends Region {

        @Override
        protected void layoutChildren() {
            pickerPile.addAll(pickerUsed.subList(0, pickerUsed.size()));
            //Unbind every picker used before setting new ones.
            for (Label label : pickerUsed) {
                label.layoutXProperty().unbind();
                label.setVisible(true);
            }
            pickerUsed.clear();

            getChildren().clear();
            int index = 0;
            for (TableColumnHeader column : horizontalHeader.getRootHeader().getColumnHeaders()) {
                if (spv.getColumnPickers().containsKey(index)) {
                    Label label = getPicker(spv.getColumnPickers().get(index));
                    label.resize(column.getWidth(), VerticalHeader.PICKER_SIZE);
                    label.layoutXProperty().bind(column.layoutXProperty());

                    getChildren().add(0, label);
                }
                index++;
            }
        }
    }

    private final InvalidationListener layoutListener = (Observable arg0) -> {
        innerPicker.requestLayout();
    };
}