class: FXGLTextFlow

[18:7] extends: TextFlow

Wraps FXGL's FXGLTextFlow, a JavaFX TextFlow subclass that adds an append helper for chained text composition. Use append(text) to grow the flow inline, optionally with a Color or Font. The underlying class requires a UIFactoryService in its constructor, so Aussom users obtain a FXGLTextFlow via fxgl.getUIFactoryService().newTextFlow (chunk 6) and adopt the result here. Direct construction from Aussom is not supported.

Methods

FXGLTextFlow ()

Empty default constructor; populated by adopt after obtaining an FXGLTextFlow from UIFactoryService.newTextFlow.
adopt (object Ajo)

Wraps an existing FXGLTextFlow AussomJavaObject.
- @p Ajo is an AussomJavaObject around an FXGLTextFlow.
- @r A new wrapper.
append (string Text)

Appends text to the flow.
- @p Text is the string to append.
- @r this object
appendNewLine ()

Appends a newline character to the flow. FXGLTextFlow has no dedicated newline method, so this wraps a plain append("\n") call. The flow uses TextFlow's normal line-breaking on newline characters in the appended text.
- @r this object
appendSized (string Text, double FontSize)

Appends text at the given font size.
- @p Text is the string to append.
- @p FontSize is the font size.
- @r this object
appendColored (string Text, object ColorObj)

Appends text in the given color (default font size).
- @p Text is the string to append.
- @p ColorObj is a Color wrapper.
- @r this object
appendStyled (string Text, object ColorObj, double FontSize)

Appends text in the given color and font size.
- @p Text is the string to append.
- @p ColorObj is a Color wrapper.
- @p FontSize is the font size.
- @r this object
appendKey (string KeyName, object ColorObj)

Appends a key icon (e.g. "press [E]") for the given KeyCode and color.
- @p KeyName is the KeyCode enum name.
- @p ColorObj is a Color wrapper.
- @r this object
appendKeySized (string KeyName, object ColorObj, double Size)

Appends a sized key icon.
- @p KeyName is the KeyCode enum name.
- @p ColorObj is a Color wrapper.
- @p Size is the icon size.
- @r this object
appendMouse (string ButtonName, object ColorObj)

Appends a mouse-button icon.
- @p ButtonName is the MouseButton enum name.
- @p ColorObj is a Color wrapper.
- @r this object
appendMouseSized (string ButtonName, object ColorObj, double Size)

Appends a sized mouse-button icon.
- @p ButtonName is the MouseButton enum name.
- @p ColorObj is a Color wrapper.
- @p Size is the icon size.
- @r this object
appendTrigger (object TriggerObj, object ColorObj)

Appends a fixed Trigger icon (KeyTrigger or MouseTrigger).
- @p TriggerObj is an AussomJavaObject around a Trigger.
- @p ColorObj is a Color wrapper.
- @r this object
appendTriggerSized (object TriggerObj, object ColorObj, double Size)

Appends a sized fixed Trigger icon.
- @p TriggerObj is an AussomJavaObject around a Trigger.
- @p ColorObj is a Color wrapper.
- @p Size is the icon size.
- @r this object
appendTriggerBound (object PropertyObj, object ColorObj)

Appends a Trigger icon bound to a property so the displayed icon updates when the user rebinds the trigger.
- @p PropertyObj is an AussomJavaObject around a ReadOnlyObjectProperty.
- @p ColorObj is a Color wrapper.
- @r this object
appendTriggerBoundSized (object PropertyObj, object ColorObj, double Size)

Appends a sized Trigger icon bound to a property.
- @p PropertyObj is an AussomJavaObject around a ReadOnlyObjectProperty.
- @p ColorObj is a Color wrapper.
- @p Size is the icon size.
- @r this object
appendNode (object NodeObj)

Appends an arbitrary inline Node.
- @p NodeObj is an AussomJavaObject around a JavaFX Node.
- @r this object