io.github.palexdev.materialfx.controls.MFXCheckTreeView Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2022 Parisi Alessandro
 * This file is part of MaterialFX (https://github.com/palexdev/MaterialFX).
 *
 * MaterialFX is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MaterialFX 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with MaterialFX.  If not, see .
 */

package io.github.palexdev.materialfx.controls;

import io.github.palexdev.materialfx.selection.TreeCheckModel;

/**
 * This is the container for a tree made of MFXCheckTreeItems.
 * 
 * Note: this could also work with other item classes since the TreeCheckModel extends TreeSelectionModel,
 * but of course it is not recommended to do so.
 *
 * @param  The type of the data within the items.
 */
public class MFXCheckTreeView extends MFXTreeView {
	//================================================================================
	// Constructors
	//================================================================================
	public MFXCheckTreeView() {
		super();
	}

	public MFXCheckTreeView(MFXCheckTreeItem root) {
		super(root);
	}

	//================================================================================
	// Methods
	//================================================================================
	public TreeCheckModel getCheckModel() {
		return (TreeCheckModel) super.getSelectionModel();
	}

	//================================================================================
	// Override Methods
	//================================================================================

	/**
	 * Overridden method to install a TreeCheckModel.
	 * 
	 * By default it is set to allow multiple selection.
	 */
	@Override
	protected void installSelectionModel() {
		TreeCheckModel treeCheckModel = new TreeCheckModel<>();
		treeCheckModel.setAllowsMultipleSelection(true);
		setSelectionModel(treeCheckModel);
	}
}