io.github.palexdev.mfxresources.fonts.IconProvider Maven / Gradle / Ivy

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

There is a newer version: 11.26.0

/*
 * 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.mfxresources.fonts;

import javafx.scene.text.Font;

import java.io.InputStream;
import java.util.function.Function;

/**
 * Public API to implement an {@code IconProvider}. These contain important information about an icon font.
 * In particular, they should expose:
 *  - The path to the font
 * 
 - A converter function, that maps an icon description/name to its unicode character, see {@link IconDescriptor}
 *  - A way to load the icon font as an {@link InputStream}
 */
public interface IconProvider {
	/**
	 * @return the path to the icon font resource
	 */
	String getFontPath();

	/**
	 * @return the function that will be used to convert the icon description/name to its corresponding unicode character
	 */
	Function getConverter();

	/**
	 * This should load the font resource as an {@link InputStream}.
	 */
	InputStream load();

	/**
	 * @return the result of {@link #load()} as a {@link Font} using {@link Font#loadFont(String, double)},
	 * the default used size is 16.0
	 */
	default Font loadFont() {
		return loadFont(16.0);
	}

	/**
	 * @return the result of {@link #load()} as a {@link Font} using {@link Font#loadFont(String, double)}
	 * with the given size
	 */
	default Font loadFont(double size) {
		return Font.loadFont(load(), size);
	}
}