Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: HsMedusaObj

[296:7] extends: FxObj

Shared base helper for Medusa value objects.

Methods

  • unwrap (Val)

    Unwraps a wrapper object or AJI object.

    • @p Val is either a wrapper with .obj or an AussomJavaObject.
    • @r An AussomJavaObject.

class: HsClock

[470:7] extends: Node, Control, Region

HsClock wraps the Medusa Clock control.

CSS Classes

Scope CSS Classes
Medusa clock Library skin classes vary by the selected clock skin type.
Inherited parent groups Control, Region, and Node styling still applies.

CSS Properties

Group Common Properties
Control -fx-skin, -fx-focus-traversable.
Region -fx-background-color, -fx-border-color, -fx-padding, size properties.
Node -fx-opacity, -fx-rotate, -fx-translate-x, -fx-translate-y, -fx-managed, visibility.

Methods

  • HsClock (Val = null)

    Creates a clock wrapper or a default Medusa clock.

    • @p Val is an optional existing Java Clock object.
  • setTimeIso (string IsoText)

    Sets the clock time from an ISO-8601 string.

    • @p IsoText is a string such as 2026-04-19T12:00:00Z.
    • @r this object for chaining
  • setTitle (string Title)

    Sets the clock title.

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

    Sets the clock body text.

    • @p Text is the body text value.
    • @r this object for chaining
  • setSkinType (string Name)

    Sets the clock skin type by enum name.

    • @p Name is a Clock.ClockSkinType enum name.
    • @r this object for chaining
  • setRunning (bool Running)

    Sets whether the clock runs automatically.

    • @p Running is true to enable ticking.
    • @r this object for chaining
  • addAlarm (object AlarmObj)

    Adds a clock alarm.

    • @p AlarmObj is an HsAlarm object.
    • @r this object for chaining
  • removeAlarm (object AlarmObj)

    Removes a clock alarm.

    • @p AlarmObj is an HsAlarm object.
    • @r this object for chaining

class: medusa

[12:14] static extends: object

HanSolo Medusa helper functions and enum discovery for the fx.hansolo.medusa module path.

Members

  • gaugeClass
  • clockClass
  • fGaugeClass
  • gaugeBuilderClass
  • clockBuilderClass
  • fGaugeBuilderClass

Methods

  • enumNames (string EnumClass)

    Returns enum names for the provided Java enum class.

    • @p EnumClass is the fully qualified Java enum class name.
    • @r A list of strings with the enum member names.
  • enumValue (string EnumClass, string Name)

    Resolves the provided Java enum by string name.

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

    Converts a wrapper object or AJI object into its Java object.

    • @p Val is either a wrapper with .obj or an AussomJavaObject.
    • @r An AussomJavaObject.
  • unwrapList (list Items)

    Converts a list of wrappers or AJI objects into a Java ArrayList.

    • @p Items is a list of objects to convert.
    • @r An AussomJavaObject wrapping java.util.ArrayList.
  • gaugeSkinTypes ()

    Returns the available gauge skin types.

    • @r A list of strings with Gauge.SkinType names.
  • clockSkinTypes ()

    Returns the available clock skin types.

    • @r A list of strings with Clock.ClockSkinType names.
  • tickMarkTypes ()

    Returns the available tick mark types.

    • @r A list of strings with TickMarkType names.
  • tickLabelLocations ()

    Returns the available tick label locations.

    • @r A list of strings with TickLabelLocation names.
  • tickLabelOrientations ()

    Returns the available tick label orientations.

    • @r A list of strings with TickLabelOrientation names.
  • lcdDesigns ()

    Returns the available LCD designs.

    • @r A list of strings with LcdDesign names.
  • lcdFonts ()

    Returns the available LCD fonts.

    • @r A list of strings with LcdFont names.
  • gaugeDesigns ()

    Returns the available framed gauge designs.

    • @r A list of strings with GaugeDesign names.
  • markerTypes ()

    Returns the available marker types.

    • @r A list of strings with Marker.MarkerType names.
  • alarmRepetitions ()

    Returns the available alarm repetition values.

    • @r A list of strings with Alarm.Repetition names.
  • newGaugeBuilder ()

    Creates a new Medusa gauge builder.

    • @r An HsGaugeBuilder object.
  • newClockBuilder ()

    Creates a new Medusa clock builder.

    • @r An HsClockBuilder object.
  • newFGaugeBuilder ()

    Creates a new framed gauge builder.

    • @r An HsFGaugeBuilder object.
  • zonedDateTime (string IsoText)

    Parses a ZonedDateTime from an ISO-8601 string.

    • @p IsoText is a string such as 2026-04-19T12:00:00Z.
    • @r An AussomJavaObject wrapping ZonedDateTime.
  • localTime (int Hour, int Minute, int Second = 0)

    Creates a LocalTime instance.

    • @p Hour is the hour value.
    • @p Minute is the minute value.
    • @p Second is the optional second value.
    • @r An AussomJavaObject wrapping LocalTime.
  • gaugeSkinType (string Name)

    Resolves a gauge skin type by name.

    • @p Name is the enum member name.
    • @r An AussomJavaObject wrapping Gauge.SkinType.
  • clockSkinType (string Name)

    Resolves a clock skin type by name.

    • @p Name is the enum member name.
    • @r An AussomJavaObject wrapping Clock.ClockSkinType.
  • gaugeDesign (string Name)

    Resolves a gauge design by name.

    • @p Name is the enum member name.
    • @r An AussomJavaObject wrapping GaugeDesign.
  • gaugeBackground (string Name)

    Resolves a gauge background by name.

    • @p Name is the enum member name.
    • @r An AussomJavaObject wrapping GaugeBackground.
  • tickMarkType (string Name)

    Resolves a tick mark type by name.

    • @p Name is the enum member name.
    • @r An AussomJavaObject wrapping TickMarkType.
  • tickLabelLocation (string Name)

    Resolves a tick label location by name.

    • @p Name is the enum member name.
    • @r An AussomJavaObject wrapping TickLabelLocation.
  • tickLabelOrientation (string Name)

    Resolves a tick label orientation by name.

    • @p Name is the enum member name.
    • @r An AussomJavaObject wrapping TickLabelOrientation.
  • lcdDesign (string Name)

    Resolves a LCD design by name.

    • @p Name is the enum member name.
    • @r An AussomJavaObject wrapping LcdDesign.
  • lcdFont (string Name)

    Resolves a LCD font by name.

    • @p Name is the enum member name.
    • @r An AussomJavaObject wrapping LcdFont.
  • markerType (string Name)

    Resolves a marker type by name.

    • @p Name is the enum member name.
    • @r An AussomJavaObject wrapping Marker.MarkerType.
  • alarmRepetition (string Name)

    Resolves an alarm repetition enum by name.

    • @p Name is the enum member name.
    • @r An AussomJavaObject wrapping Alarm.Repetition.

class: HsGauge

[329:7] extends: Node, Control, Region

HsGauge wraps the Medusa Gauge control.

CSS Classes

Scope CSS Classes
Medusa gauge Library skin classes vary by the selected gauge skin type.
Inherited parent groups Control, Region, and Node styling still applies.

CSS Properties

Group Common Properties
Control -fx-skin, -fx-focus-traversable.
Region -fx-background-color, -fx-border-color, -fx-padding, size properties.
Node -fx-opacity, -fx-rotate, -fx-translate-x, -fx-translate-y, -fx-managed, visibility.

Methods

  • HsGauge (Val = null)

    Creates a gauge wrapper or a default Medusa gauge.

    • @p Val is an optional existing Java Gauge object.
  • setValue (double Value)

    Sets the current gauge value.

    • @p Value is the numeric value to display.
    • @r this object for chaining
  • setTitle (string Title)

    Sets the gauge title.

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

    Sets the gauge subtitle.

    • @p Title is the subtitle text.
    • @r this object for chaining
  • setUnit (string Unit)

    Sets the gauge unit label.

    • @p Unit is the unit text.
    • @r this object for chaining
  • setSkinType (string Name)

    Sets the gauge skin type by enum name.

    • @p Name is a Gauge.SkinType enum name.
    • @r this object for chaining
  • setValueVisible (bool Visible)

    Controls whether the current value text is visible.

    • @p Visible is true to show the value text.
    • @r this object for chaining
  • setAnimated (bool Animated)

    Controls whether Medusa animates value changes.

    • @p Animated is true to animate.
    • @r this object for chaining
  • addSection (object SectionObj)

    Adds a section marker band to the gauge.

    • @p SectionObj is an HsSection object.
    • @r this object for chaining
  • removeSection (object SectionObj)

    Removes a section marker band from the gauge.

    • @p SectionObj is an HsSection object.
    • @r this object for chaining
  • addMarker (object MarkerObj)

    Adds a gauge marker.

    • @p MarkerObj is an HsMarker object.
    • @r this object for chaining
  • removeMarker (object MarkerObj)

    Removes a gauge marker.

    • @p MarkerObj is an HsMarker object.
    • @r this object for chaining

class: HsTimeSection

[1103:7] extends: HsMedusaObj

HsTimeSection wraps Medusa's TimeSection value object.

Methods

  • HsTimeSection (Val = null, StopObj = null, string Text = null, object ColorObj = null)

    Creates a time section wrapper or a new section from LocalTime values.

    • @p Val is either an existing Java TimeSection object or the start LocalTime object.
    • @p StopObj is the end LocalTime object when creating a new section.
    • @p Text is the optional label.
    • @p ColorObj is an optional fx.Color object.
  • setText (string Text)

    Sets the time section text label.

    • @p Text is the label text.
    • @r this object for chaining
  • setColor (object ColorObj)

    Sets the time section color.

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

class: HsAlarm

[1057:7] extends: HsMedusaObj

HsAlarm wraps Medusa's Alarm value object.

Methods

  • HsAlarm (Val = null, string Repetition = null, string Text = null)

    Creates an alarm wrapper or a new alarm from ISO time text.

    • @p Val is either an existing Java Alarm object or an ISO time string.
    • @p Repetition is an optional Alarm.Repetition enum name.
    • @p Text is the optional alarm label.
  • setArmed (bool Armed)

    Sets whether the alarm is armed.

    • @p Armed is true to enable the alarm.
    • @r this object for chaining
  • setText (string Text)

    Sets the alarm text label.

    • @p Text is the alarm label.
    • @r this object for chaining

class: HsClockBuilder

[779:7] extends: HsMedusaObj

HsClockBuilder wraps Medusa's ClockBuilder fluent API.

Members

  • obj

Methods

  • HsClockBuilder ()

    Creates a new Medusa clock builder.

  • skinType (string Name)

    Sets the clock skin type by enum name.

    • @p Name is a Clock.ClockSkinType enum name.
    • @r this object for chaining
  • timeIso (string IsoText)

    Sets the initial clock time from ISO text.

    • @p IsoText is a string such as 2026-04-19T12:00:00Z.
    • @r this object for chaining
  • title (string Title)

    Sets the clock title.

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

    Sets the clock text.

    • @p Text is the text value.
    • @r this object for chaining
  • running (bool Running)

    Sets whether the clock runs automatically.

    • @p Running is true to enable ticking.
    • @r this object for chaining
  • prefSize (double Width, double Height)

    Sets the preferred size for the built clock.

    • @p Width is the preferred width.
    • @p Height is the preferred height.
    • @r this object for chaining
  • alarms (list Alarms)

    Sets the builder's alarm list.

    • @p Alarms is a list of HsAlarm objects.
    • @r this object for chaining
  • sections (list Sections)

    Sets the builder's section list.

    • @p Sections is a list of HsTimeSection objects.
    • @r this object for chaining
  • areas (list Areas)

    Sets the builder's area list.

    • @p Areas is a list of HsTimeSection objects.
    • @r this object for chaining
  • build ()

    Builds the configured Medusa clock.

    • @r An HsClock object.

class: HsFGauge

[570:7] extends: Node, Region

HsFGauge wraps Medusa's framed gauge region.

CSS Classes

Scope CSS Classes
Medusa framed gauge Library-defined frame and foreground classes.
Inherited parent groups Region and Node styling still applies.

CSS Properties

Group Common Properties
Region -fx-background-color, -fx-border-color, -fx-padding, size properties.
Node -fx-opacity, -fx-rotate, -fx-translate-x, -fx-translate-y, -fx-managed, visibility.

Methods

  • HsFGauge (Val = null)

    Creates a framed gauge wrapper or a default Medusa FGauge.

    • @p Val is an optional existing Java FGauge object.
  • setGaugeDesign (string Name)

    Sets the framed gauge design by enum name.

    • @p Name is a GaugeDesign enum name.
    • @r this object for chaining
  • setGaugeBackground (string Name)

    Sets the gauge background design by enum name.

    • @p Name is a GaugeBackground enum name.
    • @r this object for chaining
  • setForegroundVisible (bool Visible)

    Controls whether the foreground overlay is shown.

    • @p Visible is true to show the foreground ring.
    • @r this object for chaining
  • setGauge (object GaugeObj)

    Replaces the contained gauge control.

    • @p GaugeObj is an HsGauge object.
    • @r this object for chaining

class: HsSection

[954:7] extends: HsMedusaObj

HsSection wraps Medusa's numeric Section value object.

Methods

  • HsSection (Val = null, double Stop = 0.0, string Text = null, object ColorObj = null)

    Creates a section wrapper or a new section with start and stop values.

    • @p Val is either an existing Java Section object or the section start.
    • @p Stop is the section stop value when creating a new section.
    • @p Text is the optional section label.
    • @p ColorObj is an optional fx.Color object.
  • setText (string Text)

    Sets the section text.

    • @p Text is the section label.
    • @r this object for chaining
  • setColor (object ColorObj)

    Sets the section color.

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

class: HsMarker

[1001:7] extends: HsMedusaObj

HsMarker wraps Medusa's numeric Marker value object.

Methods

  • HsMarker (Val = null, string Text = null, object ColorObj = null)

    Creates a marker wrapper or a new marker with value and text.

    • @p Val is either an existing Java Marker object or the marker value.
    • @p Text is the optional marker label.
    • @p ColorObj is an optional fx.Color object.
  • setText (string Text)

    Sets the marker text.

    • @p Text is the marker label.
    • @r this object for chaining
  • setColor (object ColorObj)

    Sets the marker color.

    • @p ColorObj is a fx.Color object.
    • @r this object for chaining
  • setMarkerType (string Name)

    Sets the marker type by enum name.

    • @p Name is a Marker.MarkerType enum name.
    • @r this object for chaining

class: HsGaugeBuilder

[626:7] extends: HsMedusaObj

HsGaugeBuilder wraps Medusa's GaugeBuilder fluent API.

Members

  • obj

Methods

  • HsGaugeBuilder ()

    Creates a new Medusa gauge builder.

  • skinType (string Name)

    Sets the gauge skin type by enum name.

    • @p Name is a Gauge.SkinType enum name.
    • @r this object for chaining
  • value (double Value)

    Sets the initial gauge value.

    • @p Value is the numeric value.
    • @r this object for chaining
  • minValue (double Value)

    Sets the minimum gauge value.

    • @p Value is the minimum numeric value.
    • @r this object for chaining
  • maxValue (double Value)

    Sets the maximum gauge value.

    • @p Value is the maximum numeric value.
    • @r this object for chaining
  • threshold (double Value)

    Sets the threshold value.

    • @p Value is the threshold numeric value.
    • @r this object for chaining
  • title (string Title)

    Sets the gauge title.

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

    Sets the gauge subtitle.

    • @p Title is the subtitle text.
    • @r this object for chaining
  • unit (string Unit)

    Sets the gauge unit label.

    • @p Unit is the unit text.
    • @r this object for chaining
  • prefSize (double Width, double Height)

    Sets the preferred size for the built gauge.

    • @p Width is the preferred width.
    • @p Height is the preferred height.
    • @r this object for chaining
  • animated (bool Animated)

    Controls whether the gauge animates value changes.

    • @p Animated is true to animate.
    • @r this object for chaining
  • valueVisible (bool Visible)

    Controls whether the current value label is shown.

    • @p Visible is true to show the value label.
    • @r this object for chaining
  • sections (list Sections)

    Sets the builder's section list.

    • @p Sections is a list of HsSection objects.
    • @r this object for chaining
  • markers (list Markers)

    Sets the builder's marker list.

    • @p Markers is a list of HsMarker objects.
    • @r this object for chaining
  • build ()

    Builds the configured Medusa gauge.

    • @r An HsGauge object.

class: HsFGaugeBuilder

[892:7] extends: HsMedusaObj

HsFGaugeBuilder wraps Medusa's FGaugeBuilder fluent API.

Members

  • obj

Methods

  • HsFGaugeBuilder ()

    Creates a new framed gauge builder.

  • gauge (object GaugeObj)

    Sets the wrapped gauge control.

    • @p GaugeObj is an HsGauge object.
    • @r this object for chaining
  • gaugeDesign (string Name)

    Sets the framed gauge design by enum name.

    • @p Name is a GaugeDesign enum name.
    • @r this object for chaining
  • gaugeBackground (string Name)

    Sets the framed gauge background design by enum name.

    • @p Name is a GaugeBackground enum name.
    • @r this object for chaining
  • foregroundVisible (bool Visible)

    Controls whether the foreground overlay is visible.

    • @p Visible is true to show the foreground overlay.
    • @r this object for chaining
  • build ()

    Builds the configured framed gauge.

    • @r An HsFGauge object.