Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: fontawesome

[12:14] static extends: object

FontAwesomeFX helper functions for working with the Font Awesome icon enum and icon view node under the fx.fontawesome module path.

Members

  • iconClass
  • iconViewClass

Methods

  • names ()

    Returns the available Font Awesome icon enum names.

    • @r A list of strings with icon names such as CAMERA.
  • icon (string Name)

    Resolves an icon enum value from its string name.

    • @p Name is a string with the Font Awesome enum name.
    • @r An AussomJavaObject wrapping the icon enum value.
  • iconView (string Name, string Size = null)

    Creates a new icon view node for the provided icon name.

    • @p Name is a string with the Font Awesome enum name.
    • @p Size is an optional CSS font size string such as 24px.
    • @r A FaIconView object.

class: FaIconView

[75:7] extends: Node

FaIconView wraps the FontAwesomeFX icon view node used to render a single Font Awesome glyph in a JavaFX scene graph.

CSS Classes

Scope CSS Classes
FontAwesomeFX node Library skin classes applied by GlyphIcon and Text.
Inherited parent groups Node, Shape, and Text styling still applies through the JavaFX hierarchy.

CSS Properties

Group Common Properties
Text -fx-font, -fx-fill, -fx-stroke, -fx-underline, -fx-strikethrough.
Node -fx-opacity, -fx-rotate, -fx-translate-x, -fx-translate-y, -fx-managed, visibility.

Methods

  • FaIconView (Val = null, string Size = null)

    Creates a new icon view either by wrapping an existing Java object or by resolving the provided icon name through FontAwesomeFX.

    • @p Val is either an AussomJavaObject or a string icon name.
    • @p Size is an optional CSS font size string such as 18px.
  • setIcon (string Name)

    Sets the icon enum value shown by this node.

    • @p Name is a string with the Font Awesome enum name.
    • @r this object for chaining
  • setSize (string Size)

    Sets the icon size using the FontAwesomeFX size string format.

    • @p Size is a string such as 24px or 1.5em.
    • @r this object for chaining
  • setFill (object ColorObj)

    Sets the glyph color with a JavaFX Color object.

    • @p ColorObj is a fx.Color object.
    • @r this object for chaining