Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: TileChartData

[1225:7] extends: TileFxObj

TileChartData wraps the chart data object used by chart-oriented tiles.

Methods

  • TileChartData (Val = null, double Value = 0.0, object FillColorObj = null, object TextColorObj = null)

    Creates chart data from a name and value or wraps an existing Java object.

    • @p Val is either an existing Java ChartData object or the item name.
    • @p Value is the numeric value when Val is a name string.
    • @p FillColorObj is an optional fill color.
    • @p TextColorObj is an optional text color.
  • setName (string Name)

    Sets the data item name.

    • @p Name is the item name.
    • @r this object for chaining
  • setValue (double Value)

    Sets the data item value.

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

    Sets the fill color.

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

    Sets the stroke color.

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

    Sets the text color.

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

class: TileFxObj

[285:7] extends: FxObj

Shared base helper for TilesFX wrapper objects.

Methods

  • unwrap (Val)

    Unwraps a wrapper object, fxApp, or AJI object.

    • @p Val is an optional wrapped object.
    • @r The corresponding Java object or null.

class: Tile

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

Tile wraps the main TilesFX dashboard control.

CSS Classes

Scope CSS Classes
TilesFX tile tile, plus skin-specific classes and internal substructure classes that vary by SkinType.
Inherited parent groups Control, Region, and Node.

CSS Guide

Group What To Style
Tile Style the root tile, skin-specific content nodes, title/value text, bar or gauge colors, and tile overlays. Exact substructure classes depend on SkinType.
Control Use -fx-skin and -fx-focus-traversable when overriding the rendered control behavior.
Region Apply -fx-background-color, -fx-border-color, -fx-border-width, -fx-padding, and preferred size properties.
Node Apply -fx-opacity, -fx-effect, -fx-rotate, translations, cursor, and visibility.

Methods

  • Tile (Val = null)

    Creates a new TilesFX tile, wraps an existing Java tile, or creates a tile with the provided skin type.

    • @p Val is an optional existing Java Tile object or a SkinType name.
  • setSkinType (string Name)

    Sets the tile skin type by enum name.

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

    Sets the current tile value.

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

    Returns the current tile value.

    • @r A double with the current value.
  • setMinValue (double Value)

    Sets the minimum tile value.

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

    Sets the maximum tile value.

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

    Sets the threshold value.

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

    Sets the tile title.

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

    Sets the main tile text.

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

    Sets the tile description.

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

    Sets the unit label.

    • @p Unit is the unit text.
    • @r this object for chaining
  • setAnimated (bool Animated)

    Controls whether tile animations are enabled.

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

    Controls whether the value label is shown.

    • @p Visible is true to show the value label.
    • @r this object for chaining
  • setTextVisible (bool Visible)

    Controls whether the text label is shown.

    • @p Visible is true to show the text label.
    • @r this object for chaining
  • setDateVisible (bool Visible)

    Controls whether the date label is shown.

    • @p Visible is true to show the date label.
    • @r this object for chaining
  • setTextSize (string Name)

    Sets the tile text size enum by name.

    • @p Name is a Tile.TextSize enum name.
    • @r this object for chaining
  • setSections (list Sections)

    Replaces the section list.

    • @p Sections is a list of TileSection objects.
    • @r this object for chaining
  • addSection (object SectionObj)

    Adds one section.

    • @p SectionObj is a TileSection object.
    • @r this object for chaining
  • setTimeSections (list Sections)

    Replaces the time section list.

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

    Replaces the alarm list.

    • @p Alarms is a list of TileAlarm objects.
    • @r this object for chaining
  • setChartData (list Items)

    Replaces the chart data list.

    • @p Items is a list of TileChartData objects.
    • @r this object for chaining
  • addChartData (object ItemObj)

    Adds one chart data item.

    • @p ItemObj is a TileChartData object.
    • @r this object for chaining
  • setGraphic (object NodeObj)

    Sets an optional graphic node.

    • @p NodeObj is a wrapped JavaFX node.
    • @r this object for chaining

class: TileSection

[938:7] extends: TileFxObj

TileSection wraps the numeric range section object used by gauge-like tiles.

Methods

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

    Creates a section from numeric bounds or wraps an existing Java object.

    • @p Val is either an existing Java Section object or the start value.
    • @p Stop is the stop value when Val is a start value.
    • @p Text is optional section text.
    • @p ColorObj is an optional fill color.
    • @p TextColorObj is an optional text color.
  • setStart (double Value)

    Sets the section start value.

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

    Sets the section stop value.

    • @p Value is the stop value.
    • @r this object for chaining
  • setText (string Text)

    Sets the section text.

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

    Sets the section color.

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

    Sets the section highlight color.

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

    Sets the section text color.

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

class: TileBuilder

[555:7] extends: TileFxObj

TileBuilder wraps TilesFX's TileBuilder fluent API.

Members

  • obj

Methods

  • TileBuilder ()

    Creates a new TilesFX tile builder.

  • skinType (string Name)

    Sets the tile skin type by enum name.

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

    Sets the initial tile value.

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

    Sets the minimum tile value.

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

    Sets the maximum tile 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
  • lowerThreshold (double Value)

    Sets the lower threshold value.

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

    Sets the reference value.

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

    Sets the tile title.

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

    Sets the tile description.

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

    Sets the main tile text.

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

    Sets the unit label.

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

    Sets the tile time from ISO-8601 text.

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

    Controls whether tile animations are enabled.

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

    Controls whether the value label is shown.

    • @p Visible is true to show the value label.
    • @r this object for chaining
  • textVisible (bool Visible)

    Controls whether the text label is shown.

    • @p Visible is true to show the text label.
    • @r this object for chaining
  • dateVisible (bool Visible)

    Controls whether the date label is shown.

    • @p Visible is true to show the date label.
    • @r this object for chaining
  • running (bool Running)

    Controls whether the clock-like tile runs automatically.

    • @p Running is true to enable ticking.
    • @r this object for chaining
  • descriptionAlignment (string Name)

    Sets the description alignment by enum name.

    • @p Name is a javafx.geometry.Pos enum name.
    • @r this object for chaining
  • titleAlignment (string Name)

    Sets the title alignment by enum name.

    • @p Name is a javafx.scene.text.TextAlignment enum name.
    • @r this object for chaining
  • textAlignment (string Name)

    Sets the main text alignment by enum name.

    • @p Name is a javafx.scene.text.TextAlignment enum name.
    • @r this object for chaining
  • orientation (string Name)

    Sets the tile orientation by enum name.

    • @p Name is an Orientation enum name.
    • @r this object for chaining
  • textSize (string Name)

    Sets the text size by enum name.

    • @p Name is a Tile.TextSize enum name.
    • @r this object for chaining
  • chartType (string Name)

    Sets the chart type by enum name.

    • @p Name is a Tile.ChartType enum name.
    • @r this object for chaining
  • itemSorting (string Name)

    Sets the item sorting mode by enum name.

    • @p Name is a Tile.ItemSorting enum name.
    • @r this object for chaining
  • itemSortingTopic (string Name)

    Sets the item sorting topic by enum name.

    • @p Name is a Tile.ItemSortingTopic enum name.
    • @r this object for chaining
  • prefSize (double Width, double Height)

    Sets the preferred size for the built tile.

    • @p Width is the preferred width.
    • @p Height is the preferred height.
    • @r this object for chaining
  • foregroundColor (object ColorObj)

    Sets the foreground color.

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

    Sets the background color.

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

    Sets the bar color.

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

    Sets the title color.

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

    Sets the main text color.

    • @p ColorObj is a fx.Color object.
    • @r this object for chaining
  • graphic (object NodeObj)

    Sets an optional graphic node.

    • @p NodeObj is a wrapped JavaFX node.
    • @r this object for chaining
  • sections (list Sections)

    Sets the builder's section list.

    • @p Sections is a list of TileSection objects.
    • @r this object for chaining
  • timeSections (list Sections)

    Sets the builder's time section list.

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

    Sets the builder's alarm list.

    • @p Alarms is a list of TileAlarm objects.
    • @r this object for chaining
  • chartData (list Items)

    Sets the builder's chart data list.

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

    Builds the configured tile.

    • @r A Tile object.

class: TileAlarm

[1130:7] extends: TileFxObj

TileAlarm wraps the alarm object used by clock-like tiles.

Methods

  • TileAlarm (Val = null, string Repetition = "ONCE", bool Armed = true, string Text = null, object ColorObj = null)

    Creates an alarm from ISO time text or wraps an existing Java object.

    • @p Val is either an existing Java Alarm object or ISO date-time text.
    • @p Repetition is an optional repetition enum name.
    • @p Armed is true to arm the alarm.
    • @p Text is optional alarm text.
    • @p ColorObj is an optional alarm color.
  • setTimeIso (string IsoText)

    Sets the alarm time from ISO text.

    • @p IsoText is an ISO-8601 date-time string.
    • @r this object for chaining
  • setRepetition (string Name)

    Sets the repetition mode by enum name.

    • @p Name is an Alarm.Repetition enum name.
    • @r this object for chaining
  • setArmed (bool Armed)

    Sets whether the alarm is armed.

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

    Sets the alarm text.

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

    Sets the alarm color.

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

class: TileTimeSection

[1038:7] extends: TileFxObj

TileTimeSection wraps the time-based section object used by clock and timer tiles.

Methods

  • TileTimeSection (Val = null, Stop = null, string Text = null, object ColorObj = null, object TextColorObj = null)

    Creates a time section from LocalTime values or wraps an existing Java object.

    • @p Val is either an existing Java TimeSection object or the start time.
    • @p Stop is the stop time.
    • @p Text is optional section text.
    • @p ColorObj is an optional fill color.
    • @p TextColorObj is an optional text color.
  • setStart (TimeObj)

    Sets the start time.

    • @p TimeObj is a LocalTime AJI object.
    • @r this object for chaining
  • setStop (TimeObj)

    Sets the stop time.

    • @p TimeObj is a LocalTime AJI object.
    • @r this object for chaining
  • setText (string Text)

    Sets the section text.

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

    Sets the section color.

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

    Sets the section text color.

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

class: tilesfx

[12:14] static extends: object

HanSolo TilesFX helper functions and enum discovery for the fx.hansolo.tilesfx module path.

Members

  • tileClass
  • tileBuilderClass

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, fxApp, or AJI object into its Java object.

    • @p Val is a wrapper object, fxApp, AussomJavaObject, or null.
    • @r The corresponding Java object or null.
  • 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.
  • newTileBuilder ()

    Creates a new TilesFX tile builder.

    • @r A TileBuilder object.
  • zonedDateTime (string IsoText)

    Parses a ZonedDateTime from ISO-8601 text.

    • @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.
  • skinTypes ()

    Returns the available tile skin types.

    • @r A list of Tile.SkinType enum names.
  • chartTypes ()

    Returns the available tile chart types.

    • @r A list of Tile.ChartType enum names.
  • textSizes ()

    Returns the available tile text sizes.

    • @r A list of Tile.TextSize enum names.
  • itemSortings ()

    Returns the available item sorting modes.

    • @r A list of Tile.ItemSorting enum names.
  • itemSortingTopics ()

    Returns the available item sorting topics.

    • @r A list of Tile.ItemSortingTopic enum names.
  • mapProviders ()

    Returns the available tile map providers.

    • @r A list of Tile.MapProvider enum names.
  • imageMasks ()

    Returns the available tile image masks.

    • @r A list of Tile.ImageMask enum names.
  • tileColors ()

    Returns the available tile colors.

    • @r A list of Tile.TileColor enum names.
  • alarmRepetitions ()

    Returns the available alarm repetition modes.

    • @r A list of Alarm.Repetition enum names.
  • skinType (string Name)

    Resolves a tile skin type by name.

    • @p Name is a Tile.SkinType enum name.
    • @r An AussomJavaObject wrapping the enum value.
  • chartType (string Name)

    Resolves a tile chart type by name.

    • @p Name is a Tile.ChartType enum name.
    • @r An AussomJavaObject wrapping the enum value.
  • textSize (string Name)

    Resolves a tile text size by name.

    • @p Name is a Tile.TextSize enum name.
    • @r An AussomJavaObject wrapping the enum value.
  • itemSorting (string Name)

    Resolves an item sorting mode by name.

    • @p Name is a Tile.ItemSorting enum name.
    • @r An AussomJavaObject wrapping the enum value.
  • itemSortingTopic (string Name)

    Resolves an item sorting topic by name.

    • @p Name is a Tile.ItemSortingTopic enum name.
    • @r An AussomJavaObject wrapping the enum value.
  • mapProvider (string Name)

    Resolves a map provider by name.

    • @p Name is a Tile.MapProvider enum name.
    • @r An AussomJavaObject wrapping the enum value.
  • imageMask (string Name)

    Resolves an image mask by name.

    • @p Name is a Tile.ImageMask enum name.
    • @r An AussomJavaObject wrapping the enum value.
  • tileColor (string Name)

    Resolves a tile color by name.

    • @p Name is a Tile.TileColor enum name.
    • @r An AussomJavaObject wrapping the enum value.
  • alarmRepetition (string Name)

    Resolves an alarm repetition by name.

    • @p Name is an Alarm.Repetition enum name.
    • @r An AussomJavaObject wrapping the enum value.
  • orientation (string Name)

    Resolves a JavaFX orientation by name.

    • @p Name is an Orientation enum name.
    • @r An AussomJavaObject wrapping the enum value.
  • textAlignment (string Name)

    Resolves a JavaFX text alignment by name.

    • @p Name is a TextAlignment enum name.
    • @r An AussomJavaObject wrapping the enum value.
  • pos (string Name)

    Resolves a JavaFX position by name.

    • @p Name is a Pos enum name.
    • @r An AussomJavaObject wrapping the enum value.