javafx.scene.text.FontWeight Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javafx-graphics Show documentation
There is a newer version: 24-ea+15
/*
 * Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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 General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javafx.scene.text;

/**
 * Specifies different font weights which can be used when searching for a
 * font on the system.
 * The names correspond to pre-defined weights in the OS/2 table of the
 * 
 * OpenType font specification.
 * The CSS 3 specification references the same as a sequence of values.
 * @since JavaFX 2.0
 */
public enum FontWeight {

    /**
     * represents Thin font weight (100).
     */
    THIN(100, "Thin"),

    /**
     * represents 'Extra Light' font weight (200).
     */
    EXTRA_LIGHT(200, "Extra Light", "Ultra Light"),

    /**
     * represents Light font weight (300).
     */
    LIGHT(300, "Light"),

    /**
     * represents Normal font weight (400).
     */
    NORMAL(400, "Normal", "Regular"),

    /**
     * represents Medium font weight (500).
     */
    MEDIUM(500, "Medium"),

    /**
     * represents 'Demi Bold' font weight (600).
     */
    SEMI_BOLD(600, "Semi Bold", "Demi Bold"),

    /**
     * represents Bold font weight (700).
     */
    BOLD(700, "Bold"),

    /**
     * represents 'Extra Bold' font weight (800).
     */
    EXTRA_BOLD(800, "Extra Bold", "Ultra Bold"),

    /**
     * represents Black font weight (900).
     */
    BLACK(900, "Black", "Heavy");

    private final int weight;
    private final String[] names;

    private FontWeight(int weight, String... names) {
        this.weight = weight;
        this.names = names;
    }

    /**
     * Return the visual weight (degree of blackness or thickness)
     * specified by this {@code FontWeight}.
     * @return weight
     */
    public int getWeight() {
        return weight;
    }

    /**
     * Returns {@code FontWeight} by its name.
     *
     * @param name name of the {@code FontWeight}
     * @return the FontWeight by its name
     */
    public static FontWeight findByName(String name) {
        if (name == null) return null;

        for (FontWeight w : FontWeight.values()) {
            for (String n : w.names) {
                if (n.equalsIgnoreCase(name)) return w;
            }
        }

        return null;
    }

    /**
     * Returns the closest {@code FontWeight} for a weight
     * value as defined by the CSS and OpenType specifications.
     * Where the specified value  is equidistant between two
     * {@code FontWeight} values, then the implementation may
     * select either at its discretion.
     * This lookup is without reference to a font, so this is
     * purely a mapping to the set of {@code FontWeight} instances
     * and does not mean that a font of that weight will be available.
     * @param weight the weight value
     * @return closest {@code FontWeight}
     */
    public static FontWeight findByWeight(int weight) {
        if (weight <= 150) {
            return THIN;
        } else if (weight <= 250) {
            return EXTRA_LIGHT;
        } else if (weight < 350) {
            return LIGHT;
        } else if (weight <= 450) {
            return NORMAL;
        } else if (weight <= 550) {
            return MEDIUM;
        } else if (weight < 650) {
            return SEMI_BOLD;
        } else if (weight <= 750) {
            return BOLD;
        } else if (weight <= 850) {
            return EXTRA_BOLD;
        } else {
            return BLACK;
        }
    }
}