io.github.palexdev.mfxcomponents.controls.checkbox.TriState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mfxcomponents Show documentation

Material Design/Modern components for JavaFX

The newest version!

/*
 * Copyright (C) 2023 Parisi Alessandro - [email protected]
 * 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.mfxcomponents.controls.checkbox;

/**
 * Enumeration used to represent the three possible stat of a {@link MFXCheckbox}.
 */
public enum TriState {
	UNSELECTED,
	SELECTED,
	INDETERMINATE,
	;

	/**
	 * @return a {@code TriState} constant from the given {@link Boolean} object. When giving a {@code null} value,
	 * this will return the state {@link #INDETERMINATE}
	 */
	public static TriState from(Boolean b) {
		if (b == null) return INDETERMINATE;
		return b ? SELECTED : UNSELECTED;
	}
}