impl.org.controlsfx.skin.ListActionViewSkin Maven / Gradle / Ivy

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) 2018, 2019, 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.skin;

import javafx.beans.InvalidationListener;
import javafx.beans.binding.Bindings;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import javafx.geometry.Orientation;
import javafx.geometry.Side;
import javafx.scene.Node;
import javafx.scene.control.Button;
import javafx.scene.control.ListView;
import javafx.scene.control.Separator;
import javafx.scene.control.SkinBase;
import javafx.scene.control.ToolBar;
import javafx.scene.layout.BorderPane;
import javafx.scene.layout.HBox;
import javafx.scene.layout.Pane;
import javafx.scene.layout.Priority;
import javafx.scene.layout.VBox;
import org.controlsfx.control.ListActionView;
import org.controlsfx.control.ListActionView.ListAction;
import org.controlsfx.control.action.Action;
import org.controlsfx.control.action.ActionUtils;

import static java.util.stream.Collectors.toCollection;
import static javafx.geometry.Orientation.HORIZONTAL;
import static javafx.geometry.Orientation.VERTICAL;
import static javafx.scene.control.SelectionMode.MULTIPLE;

public class ListActionViewSkin extends SkinBase> {

    private BorderPane borderPane;
    private ListView listView;

    public ListActionViewSkin(ListActionView control) {
        super(control);

        borderPane = new BorderPane();
        borderPane.getStyleClass().add("container");

        this.listView = createListView();
        this.listView.cellFactoryProperty().bind(getSkinnable().cellFactoryProperty());
        Bindings.bindContentBidirectional(listView.getItems(), getSkinnable().getItems());

        control.getActions().addListener((InvalidationListener)  o -> update());
        control.sideProperty().addListener(o -> update());

        update();
        getChildren().add(borderPane);
    }

    private void update() {
        borderPane.getChildren().clear();
        borderPane.setCenter(listView);

        if (!getSkinnable().getActions().isEmpty()) {
            Side side = getSkinnable().getSide();
            switch (side) {
                case TOP:
                    borderPane.setTop(createButtonBar(HORIZONTAL));
                    break;
                case RIGHT:
                    borderPane.setRight(createButtonBar(VERTICAL, "right"));
                    break;
                case BOTTOM:
                    borderPane.setBottom(createButtonBar(HORIZONTAL, "bottom"));
                    break;
                case LEFT:
                    borderPane.setLeft(createButtonBar(VERTICAL));
                    break;
            }
        }
    }

    private ToolBar createButtonBar(Orientation orientation, String...styleClass) {
        ToolBar box = new ToolBar();
        box.setOrientation(orientation);
        box.getStyleClass().addAll(styleClass);
        box.getItems().addAll(createButtonsFromActions());
        return box;
    }

    private ObservableList createButtonsFromActions() {
        return getSkinnable().getActions().stream()
                .peek(this::initializeListAction)
                .map(this::createActionNode)
                .collect(toCollection(FXCollections::observableArrayList));
    }

    private void initializeListAction(Action action) {
        if (action instanceof ListAction) {
            ((ListAction) action).initialize(listView);
        }
    }

    private Node createActionNode(Action action) {
        if (action == ActionUtils.ACTION_SEPARATOR) {
           return new Separator();
        } else if (action == ActionUtils.ACTION_SPAN) {
            Pane span = new Pane();
            HBox.setHgrow(span, Priority.ALWAYS);
            VBox.setVgrow(span, Priority.ALWAYS);
            return span;
        }
        return createActionButton(action);
    }

    private Button createActionButton(Action action) {
        Button button = ActionUtils.createButton(action);
        button.setMaxWidth(Double.MAX_VALUE);
        if (action.getAccelerator() != null) {
            getSkinnable().getScene().getAccelerators().put(action.getAccelerator(), button::fire);
        }
        return button;
    }

    /**
     * Creates the {@link ListView} instance to be used in the control.
     * This method can be overridden to provide a customized list
     * view control.
     *
     * @return the list view
     */
    protected ListView createListView() {
        ListView view = new ListView<>();
        view.getSelectionModel().setSelectionMode(MULTIPLE);
        return view;
    }
}