Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: CfxObj

[151:7] extends: FxObj

Shared ControlsFX wrapper base with unwrapping helpers for nested controls.

Methods

  • unwrap (Val)

    Unwraps a wrapper, fxApp, or raw value for AJI calls.

    • @p Val is an object or raw value.
    • @r The unwrapped AJI value.

class: CfxNotifications

[167:7] extends: CfxObj

CfxNotifications wraps the ControlsFX Notifications fluent builder API used for toast-style alerts that appear outside the normal scene graph.

Members

  • obj

Methods

  • CfxNotifications ()

    Creates a new ControlsFX notifications builder.

  • title (string Text)

    Sets the notification title text.

    • @p Text is the title string.
    • @r this object for chaining
  • text (string Text)

    Sets the notification body text.

    • @p Text is the notification body string.
    • @r this object for chaining
  • graphic (object NodeObj)

    Sets a graphic node for the notification.

    • @p NodeObj is a wrapped JavaFX node.
    • @r this object for chaining
  • position (string PosName)

    Sets the screen position used for the notification popup.

    • @p PosName is a javafx.geometry.Pos enum name such as TOP_RIGHT.
    • @r this object for chaining
  • owner (OwnerObj)

    Sets the notification owner window or stage.

    • @p OwnerObj is a wrapper, fxApp, or AJI object representing the owner.
    • @r this object for chaining
  • hideAfterMillis (int Millis)

    Sets how long the notification should remain visible.

    • @p Millis is the hide delay in milliseconds.
    • @r this object for chaining
  • onAction (callback OnAction)

    Sets the action callback for the notification.

    • @p OnAction is a callback invoked for the JavaFX action event.
    • @r this object for chaining
  • darkStyle ()

    Enables the dark ControlsFX notification skin.

    • @r this object for chaining
  • hideCloseButton ()

    Hides the close button in the notification popup.

    • @r this object for chaining
  • styleClass (string ClassName)

    Adds one CSS style class to the notification.

    • @p ClassName is the CSS class string to add.
    • @r this object for chaining
  • show ()

    Shows the notification with the generic ControlsFX icon.

  • showInformation ()

    Shows the notification with the information icon.

  • showWarning ()

    Shows the notification with the warning icon.

  • showError ()

    Shows the notification with the error icon.

  • showConfirm ()

    Shows the notification with the confirmation icon.

class: controlsfx

[12:14] static extends: object

ControlsFX helper functions and enum utilities under the fx.controlsfx module path.

Members

  • notificationsClass
  • posClass
  • sideClass
  • orientationClass
  • popOverArrowLocationClass
  • propertySheetModeClass

Methods

  • enumValue (string EnumClass, string Name)

    Resolves a Java enum value from its string name.

    • @p EnumClass is the fully qualified Java enum class name.
    • @p Name is the enum member name to resolve.
    • @r An AussomJavaObject wrapping the resolved enum value.
  • unwrap (Val)

    Converts a wrapped object, fxApp, or raw value into the Java-side value expected by AJI.

    • @p Val is an Aussom wrapper, fxApp, AussomJavaObject, or raw value.
    • @r The unwrapped Java-side value or the original raw value.
  • observableList (list Items = null)

    Builds a JavaFX ObservableList from a list of wrappers or raw values.

    • @p Items is an optional list of values to copy into the ObservableList.
    • @r An AussomJavaObject wrapping ObservableList.
  • toList (JavaList)

    Converts a Java List or ObservableList into an Aussom list.

    • @p JavaList is a Java list object returned through AJI.
    • @r A list with the copied values.
  • pos (string Name)

    Resolves a JavaFX Pos enum name.

    • @p Name is the Pos enum member name.
    • @r An AussomJavaObject wrapping javafx.geometry.Pos.
  • side (string Name)

    Resolves a JavaFX Side enum name.

    • @p Name is the Side enum member name.
    • @r An AussomJavaObject wrapping javafx.geometry.Side.
  • orientation (string Name)

    Resolves a JavaFX Orientation enum name.

    • @p Name is the Orientation enum member name.
    • @r An AussomJavaObject wrapping javafx.geometry.Orientation.
  • popOverArrowLocation (string Name)

    Resolves a ControlsFX PopOver.ArrowLocation enum name.

    • @p Name is the arrow location enum member name.
    • @r An AussomJavaObject wrapping PopOver.ArrowLocation.
  • propertySheetMode (string Name)

    Resolves a ControlsFX PropertySheet.Mode enum name.

    • @p Name is the property sheet mode enum member name.
    • @r An AussomJavaObject wrapping PropertySheet.Mode.
  • durationMillis (int Millis)

    Creates a JavaFX Duration in milliseconds.

    • @p Millis is the number of milliseconds.
    • @r An AussomJavaObject wrapping javafx.util.Duration.
  • newNotifications ()

    Creates a new ControlsFX notifications builder.

    • @r A CfxNotifications builder object.