org.controlsfx.control.CheckTreeView Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of controlsfx Show documentation
Show all versions of controlsfx Show documentation
High quality UI controls and other tools to complement the core JavaFX distribution
/**
* Copyright (c) 2013, 2015 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 org.controlsfx.control;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Consumer;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import javafx.scene.control.CheckBox;
import javafx.scene.control.CheckBoxTreeItem;
import javafx.scene.control.TreeItem;
import javafx.scene.control.TreeView;
import javafx.scene.control.cell.CheckBoxTreeCell;
/**
* A simple UI control that makes it possible to select zero or more items within
* a TreeView without the need to set a custom cell factory or manually create
* boolean properties for each row - simply use the
* {@link #checkModelProperty() check model} to request the current selection
* state.
*
* Screenshot
* The following screenshot shows the CheckTreeView with some sample data:
*
*
* 
*
*
Code Example:
* To create the CheckTreeView shown in the screenshot, simply do the
* following:
*
*
* {@code
* // create the data to show in the CheckTreeView
* CheckBoxTreeItem root = new CheckBoxTreeItem("Root");
* root.setExpanded(true);
* root.getChildren().addAll(
* new CheckBoxTreeItem("Jonathan"),
* new CheckBoxTreeItem("Eugene"),
* new CheckBoxTreeItem("Henri"),
* new CheckBoxTreeItem("Samir"));
*
* // Create the CheckTreeView with the data
* final CheckTreeView checkTreeView = new CheckTreeView<>(root);
*
* // and listen to the relevant events (e.g. when the checked items change).
* checkTreeView.getCheckModel().getCheckedItems().addListener(new ListChangeListener>() {
* public void onChanged(ListChangeListener.Change> c) {
* System.out.println(checkTreeView.getCheckModel().getCheckedItems());
* }
* });
* }
*
* @param The type of the data in the TreeView.
*/
public class CheckTreeView extends TreeView {
/**************************************************************************
*
* Private fields
*
**************************************************************************/
/**************************************************************************
*
* Constructors
*
**************************************************************************/
/**
* Creates a new CheckTreeView instance with an empty tree of choices.
*/
public CheckTreeView() {
this(null);
}
/**
* Creates a new CheckTreeView instance with the given CheckBoxTreeItem set
* as the tree root.
*
* @param root The root tree item to display in the CheckTreeView.
*/
public CheckTreeView(final CheckBoxTreeItem root) {
super(root);
rootProperty().addListener(o -> updateCheckModel());
updateCheckModel();
setCellFactory(CheckBoxTreeCell. forTreeView());
}
protected void updateCheckModel() {
if (getRoot() != null) {
setCheckModel(new CheckTreeViewCheckModel<>(this));
}
}
/**************************************************************************
*
* Public API
*
**************************************************************************/
/**
* Returns the {@link BooleanProperty} for a given item index in the
* CheckTreeView. This is useful if you want to bind to the property.
*/
public BooleanProperty getItemBooleanProperty(int index) {
CheckBoxTreeItem treeItem = (CheckBoxTreeItem) getTreeItem(index);
return treeItem.selectedProperty();
}
/**************************************************************************
*
* Properties
*
**************************************************************************/
// --- Check Model
private ObjectProperty>> checkModel =
new SimpleObjectProperty<>(this, "checkModel"); //$NON-NLS-1$
/**
* Sets the 'check model' to be used in the CheckTreeView - this is the
* code that is responsible for representing the selected state of each
* {@link CheckBox} - that is, whether each {@link CheckBox} is checked or
* not (and not to be confused with the
* selection model concept, which is used in the TreeView control to
* represent the selection state of each row)..
*/
public final void setCheckModel(CheckModel> value) {
checkModelProperty().set(value);
}
/**
* Returns the currently installed check model.
*/
public final CheckModel> getCheckModel() {
return checkModel == null ? null : checkModel.get();
}
/**
* The check model provides the API through which it is possible
* to check single or multiple items within a CheckTreeView, as well as inspect
* which items have been checked by the user. Note that it has a generic
* type that must match the type of the CheckTreeView itself.
*/
public final ObjectProperty>> checkModelProperty() {
return checkModel;
}
/**************************************************************************
*
* Implementation
*
**************************************************************************/
/**************************************************************************
*
* Support classes
*
**************************************************************************/
private static class CheckTreeViewCheckModel implements CheckModel> {// extends CheckBitSetModelBase> {
/***********************************************************************
* *
* Internal properties *
* *
**********************************************************************/
private final CheckTreeView treeView;
private final TreeItem root;
private ObservableList> checkedItems = FXCollections.observableArrayList();
/***********************************************************************
* *
* Constructors *
* *
**********************************************************************/
CheckTreeViewCheckModel(final CheckTreeView treeView) {
this.treeView = treeView;
this.root = treeView.getRoot();
this.root.addEventHandler(CheckBoxTreeItem.checkBoxSelectionChangedEvent(), e -> {
CheckBoxTreeItem treeItem = e.getTreeItem();
if (treeItem.isSelected()) { // && ! treeItem.isIndeterminate()) {
check(treeItem);
} else {
clearCheck(treeItem);
}
});
// we should reset the check model and then update the checked items
// based on the currently checked items in the tree view
clearChecks();
for (int i = 0; i < treeView.getExpandedItemCount(); i++) {
CheckBoxTreeItem treeItem = (CheckBoxTreeItem) treeView.getTreeItem(i);
if (treeItem.isSelected() && ! treeItem.isIndeterminate()) {
check(treeItem);
}
}
}
/***********************************************************************
* *
* Implementing abstract API *
* *
**********************************************************************/
@Override public int getItemCount() {
return treeView.getExpandedItemCount();
}
// TODO make read-only
@Override public ObservableList> getCheckedItems() {
return checkedItems;
}
@Override public void checkAll() {
iterateOverTree(this::check);
}
@Override public void clearCheck(TreeItem item) {
if (item instanceof CheckBoxTreeItem) {
((CheckBoxTreeItem)item).setSelected(false);
}
checkedItems.remove(item);
}
@Override public void clearChecks() {
List> items = new ArrayList<>(checkedItems);
for(TreeItem item : items){
clearCheck(item);
}
}
@Override public boolean isEmpty() {
return checkedItems.isEmpty();
}
@Override public boolean isChecked(TreeItem item) {
return checkedItems.contains(item);
}
@Override public void check(TreeItem item) {
if (item instanceof CheckBoxTreeItem) {
((CheckBoxTreeItem)item).setSelected(true);
}
if (!checkedItems.contains(item)) {
checkedItems.add(item);
}
}
@Override
public void toggleCheckState(TreeItem item) {
if (isChecked(item)) {
clearCheck(item);
} else {
check(item);
}
}
/***********************************************************************
* *
* Private Implementation *
* *
**********************************************************************/
private void iterateOverTree(Consumer> consumer) {
processNode(consumer, root);
}
private void processNode(Consumer> consumer, TreeItem node) {
if (node == null) return;
consumer.accept(node);
processChildren(consumer, node.getChildren());
}
private void processChildren(Consumer> consumer, List> children) {
if (children == null) return;
for (TreeItem child : children) {
processNode(consumer, child);
}
}
}
}