io.github.palexdev.mfxcomponents.theming.base.Variant Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of materialfx-all Show documentation

Material Design/Modern components for JavaFX, now packed as a single Jar

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.theming.base;

import io.github.palexdev.mfxcomponents.theming.enums.FABVariants;

/**
 * Depending on the components and the design guidelines, sometimes certain UI elements can have variants
 * that mainly change in style.
 * 
 * This API allows in such cases to define variants by specifying a style class that can be applied to a component.
 * 

 * This is typically implemented by Enumerators, see {@link FABVariants} as an example. The public API allows other APIs
 * (such as {@link WithVariants}) to apply the variant style class to the component.
 */
public interface Variant {

	/**
	 * @return the style class that identifies this variant
	 */
	String variantStyleClass();
}