Font

object Font
Companion
class
class Object
trait Matchable
class Any

Value members

Concrete methods

def apply(size: Double): Font
def apply(family: String): Font
def apply(family: String, size: Double): Font
def apply(family: String, posture: FontPosture, size: Double): Font
def apply(family: String, weight: FontWeight, size: Double): Font
def apply(family: String, weight: FontWeight, posture: FontPosture, size: Double): Font

Gets the default font which will be from the family "System", and typically the style "Regular", and be of a size consistent with the user's desktop environment, to the extent that can be determined.

Gets the default font which will be from the family "System", and typically the style "Regular", and be of a size consistent with the user's desktop environment, to the extent that can be determined.

def families: Buffer[String]

Gets all the font families installed on the user's system, including any application fonts or SDK fonts.

Gets all the font families installed on the user's system, including any application fonts or SDK fonts.

def font(size: Double): Font

Searches for an appropriate font based on the default font family name and given font size.

Searches for an appropriate font based on the default font family name and given font size.

def font(family: String): Font

Searches for an appropriate font based on the given font family name and default font size.

Searches for an appropriate font based on the given font family name and default font size.

def font(family: String, size: Double): Font

Searches for an appropriate font based on the font family name and size.

Searches for an appropriate font based on the font family name and size.

def font(family: String, posture: FontPosture, size: Double): Font

Searches for an appropriate font based on the font family name and posture style.

Searches for an appropriate font based on the font family name and posture style.

def font(family: String, weight: FontWeight, size: Double): Font

Searches for an appropriate font based on the font family name and weight style.

Searches for an appropriate font based on the font family name and weight style.

def font(family: String, weight: FontWeight, posture: FontPosture, size: Double): Font

Searches for an appropriate font based on the font family name and weight and posture style.

Searches for an appropriate font based on the font family name and weight and posture style.

def fontNames: Buffer[String]

Gets the names of all fonts that are installed on the users system, including any application fonts and SDK fonts.

Gets the names of all fonts that are installed on the users system, including any application fonts and SDK fonts.

def fontNames(family: String): Buffer[String]

Gets the names of all fonts in the specified font family that are installed on the users system, including any application fonts and SDK fonts.

Gets the names of all fonts in the specified font family that are installed on the users system, including any application fonts and SDK fonts.

def loadFont(in: InputStream, size: Double): Font

Loads a font resource from the specified input stream.

Loads a font resource from the specified input stream.

def loadFont(urlStr: String, size: Double): Font

Loads a font resource from the specified URL.

Loads a font resource from the specified URL.

def loadFonts(urlStr: String, size: Double): Seq[Font]

Loads font resources from the specified URL. If the load is successful such that the location is readable, and it represents a supported font format then an array of Font will be returned.

Loads font resources from the specified URL. If the load is successful such that the location is readable, and it represents a supported font format then an array of Font will be returned.

The use case for this method is for loading all fonts from a TrueType Collection (TTC).

If a security manager is present, the application must have both permission to read from the specified URL location and the javafx.util.FXPermission "loadFont". If the application does not have permission to read from the specified URL location, then null is returned. If the application does not have the "loadFont" permission then this method will return an array of one element which is the default system font with the specified font size.

Any failure such as a malformed URL being unable to locate or read from the resource, or if it doesn't represent a font, will result in a null return. It is the application's responsibility to check this before use.

On a successful (non-null) return the fonts will be registered with the FX graphics system for creation by available constructors and factory methods, and the application should use it in this manner rather than calling this method again, which would repeat the overhead of downloading and installing the fonts.

The font size parameter is a convenience so that in typical usage the application can directly use the returned (non-null) font rather than needing to create one via a constructor. Invalid sizes are those <=0 and will result in a default size.

If the URL represents a local disk file, then no copying is performed and the font file is required to persist for the lifetime of the application. Updating the file in any manner will result in unspecified and likely undesired behaviours.

Value Params
size

of the returned fonts.

urlStr

from which to load the fonts, specified as a String.

Returns

array of Font, or null if the fonts cannot be created.

Since

9

def loadFonts(in: InputStream, size: Double): Seq[Font]

Loads font resources from the specified input stream. If the load is successful such that the stream can be fully read, and it represents a supported font format then an array of Font will be returned.

Loads font resources from the specified input stream. If the load is successful such that the stream can be fully read, and it represents a supported font format then an array of Font will be returned.

The use case for this method is for loading all fonts from a TrueType Collection (TTC).

If a security manager is present, the application must have the javafx.util.FXPermission "loadFont". If the application does not have permission then this method will return the default system font with the specified font size.

Any failure such as abbreviated input, or an unsupported font format will result in a null return. It is the application's responsibility to check this before use.

On a successful (non-null) return the fonts will be registered with the FX graphics system for creation by available constructors and factory methods, and the application should use it in this manner rather than calling this method again, which would repeat the overhead of re-reading and installing the fonts.

The font size parameter is a convenience so that in typical usage the application can directly use the returned (non-null) fonts rather than needing to re-create via a constructor. Invalid sizes are those <=0 and will result in a default size.

This method does not close the input stream.

Value Params
in

stream from which to load the fonts.

size

of the returned fonts.

Returns

array of Font, or null if the fonts cannot be created.

Since

9

Implicits

Implicits

implicit def sfxFont2jfx(v: Font): Font