Module org.controlsfx.controls
Package org.controlsfx.glyphfont

Class Glyph

  • All Implemented Interfaces:
    Styleable, EventTarget, Skinnable, Duplicatable<Glyph>
    public class Glyph
extends Label
implements Duplicatable<Glyph>
    Represents one glyph from the font. The glyph is actually a label showing one character from the specified font. It can be used as 'graphic' on any UI control or Action. It can also directly be used in FXML. Examples: 
    
 new Button("", new Glyph("FontAwesome", "BEER"))
 
    
 new Button("", new Glyph("FontAwesome", FontAwesome.Glyph.BEER))
    Thy Glyph-Class also offers a fluent API to customize the look of the Glyph. For example, you can set the color color(javafx.scene.paint.Color) or also add effects such as useHoverEffect()

    An ability to retrieve glyph node by combination of font name and glyph name extends to the ActionProxy graphic attribute, where the "font>" prefix should be used. For more information see ActionProxy.

    • Property Detail

      • icon

        public ObjectProperty<Object> iconProperty
        The icon name property. This must either be a Glyph-Name (either string or enum value) known by the GlyphFontRegistry. Alternatively, you can directly submit a unicode character here.
        See Also:
        getIcon(), setIcon(Object)

    • Constructor Detail

      • Glyph

        public Glyph()
        Empty Constructor (used by FXML)

      • Glyph

        public Glyph​(String fontFamily,
             char unicode)
        Creates a new Glyph
        Parameters:
        fontFamily - The family name of the font. Example: "FontAwesome"
        unicode - The Unicode character of the glyph

      • Glyph

        public Glyph​(String fontFamily,
             Object icon)
        Creates a new Glyph
        Parameters:
        fontFamily - The family name of the font. Example: "FontAwesome"
        icon - The icon - which can be the name (String) or Enum value. Example: FontAwesome.Glyph.BEER

    • Method Detail

      • create

        public static Glyph create​(String fontAndGlyph)
        Retrieve glyph by font name and glyph name using one string where font name an glyph name are separated by pipe.
        Parameters:
        fontAndGlyph - The font and glyph separated by a pipe. Example: "FontAwesome|STAR"
        Returns:
        A instance of a Glyph node

      • fontFamily

        public Glyph fontFamily​(String fontFamily)
        Sets the glyph icon font family
        Parameters:
        fontFamily - A font family name
        Returns:
        Returns this instance for fluent API

      • color

        public Glyph color​(Color color)
        Sets the glyph color
        Parameters:
        color -
        Returns:
        Returns this instance for fluent API

      • size

        public Glyph size​(double size)
        Sets glyph size
        Parameters:
        size -
        Returns:
        Returns this instance for fluent API

      • sizeFactor

        public Glyph sizeFactor​(int factor)
        Sets glyph size using size factor based on default font size
        Parameters:
        factor -
        Returns:
        Returns this instance for fluent API

      • useHoverEffect

        public Glyph useHoverEffect()
        Adds the hover effect style
        Returns:
        Returns this instance for fluent API

      • useGradientEffect

        public Glyph useGradientEffect()
        Adds the gradient effect style
        Returns:
        Returns this instance for fluent API

      • duplicate

        public Glyph duplicate()
        Allows glyph duplication. Since in the JavaFX scenegraph it is not possible to insert the same Node in multiple locations at the same time, this method allows for glyph reuse in several places
        Specified by:
        duplicate in interface Duplicatable<Glyph>

      • setFontFamily

        public void setFontFamily​(String family)
        Sets the font family of this glyph Font size is reset to default glyph font size

      • getFontFamily

        public String getFontFamily()
        Gets the font family of this glyph

      • setFontSize

        public void setFontSize​(double size)
        Sets the font size of this glyph

      • getFontSize

        public double getFontSize()
        Gets the font size of this glyph

      • setColor

        public void setColor​(Color color)
        Set the Color of this Glyph

      • iconProperty

        public ObjectProperty<Object> iconProperty()
        The icon name property. This must either be a Glyph-Name (either string or enum value) known by the GlyphFontRegistry. Alternatively, you can directly submit a unicode character here.
        See Also:
        getIcon(), setIcon(Object)

      • setIcon

        public void setIcon​(Object iconValue)
        Set the icon to display.
        Parameters:
        iconValue - This can either be the Glyph-Name, Glyph-Enum Value or a unicode character representing the sign.

      • getIcon

        public Object getIcon()
        Gets the value of the property icon.
        Property description:
        The icon name property. This must either be a Glyph-Name (either string or enum value) known by the GlyphFontRegistry. Alternatively, you can directly submit a unicode character here.