Package com.amalgamasimulation.desktop.html

Interface HTML

public interface HTML
The HTML interface provides utility methods for creating HTML components such as tables, charts, text blocks, headers, links, and images.
Author:
Alexey Glazyrin

  • Method Details

    • page

      static HTMLPage page()
      Creates a new HTML page.
      Returns:
      a new HTMLPage instance

    • tooltipPage

      static HTMLPage tooltipPage()
      Creates a new HTML page for tooltips.
      Returns:
      a new HTMLPage instance

    • table

      static <T> HTMLTable<T> table(List<T> dataValues)
      Creates an HTML table from a list of data values.
      Type Parameters:
      T - the type of data elements in the list
      Parameters:
      dataValues - the list of data values to convert to HTML
      Returns:
      a new HTMLTable instance

    • lineChart

      static HTMLLineChart lineChart(ILineChartVisualSet... visualSets)
      Creates an HTML line chart from the specified visual sets. Supports LineVisualSet, PointsVisualSet, PolylineVisualSet visual sets for line visualization.

      Parameters:
      visualSets - the visual sets defining line chart data and appearance
      Returns:
      a new HTMLLineChart instance

    • timeLineChart

      static HTMLTimeLineChart timeLineChart(Timeable timeable, ILineChartVisualSet... visualSets)
      Creates an HTML timeline chart with temporal X-axis. Supports LineVisualSet, PointsVisualSet, PolylineVisualSet visual sets for time-based visualization.

      Parameters:
      timeable - the time reference for the chart
      visualSets - the visual sets defining timeline data
      Returns:
      a new HTMLTimeLineChart instance

    • heatmapChart

      static HTMLHeatmapChart heatmapChart(HeatmapVisualSet visualSet)
      Creates an HTML heatmap chart.
      Parameters:
      visualSet - the visual set defining heatmap data
      Returns:
      a new HTMLHeatmapChart instance

    • barChart

      static HTMLBarChart barChart(IBarChartVisualSet... visualSets)
      Creates an HTML bar chart from the specified visual sets. Supports BarVisualSet and HistogramVisualSet visual sets for bar visualization.

      Parameters:
      visualSets - the visual sets defining bar chart data and appearance
      Returns:
      a new HTMLBarChart instance

    • waterfallChart

      static <T> HTMLBarChart waterfallChart(WaterfallVisualSet<T> visualSet)
      Creates an HTML waterfall chart showing cumulative value progression.

      Type Parameters:
      T - the type of data elements in the visual set
      Parameters:
      visualSet - the waterfall visual set containing data segments
      Returns:
      a new HTMLBarChart configured for waterfall visualization

    • boxAndWhiskerChart

      static <T> HTMLChart boxAndWhiskerChart(BoxAndWhiskerVisualSet<T> visualSet)
      Creates an HTML box-and-whisker chart showing statistical distributions.

      Type Parameters:
      T - the type of data elements in the visual set
      Parameters:
      visualSet - the box-and-whisker visual set containing data points
      Returns:
      a new HTMLChart instance configured for box plots

    • histogramChart

      static <T extends HistogramDataAggregator<C, ?>.HistogramDataGroup, C> HTMLHistogramChart histogramChart(HistogramVisualSet<T,C> visualSet)
      Creates an HTML histogram chart with optional CDF visualization.

      Type Parameters:
      T - the type of data elements
      C - the type of category
      Parameters:
      visualSet - the histogram visual set containing distribution data
      Returns:
      a new HTMLHistogramChart instance

    • textBlock

      static HTMLTextBlock textBlock(Object... objects)
      Creates an HTML text block from the given objects.
      Parameters:
      objects - the objects to include in the text block
      Returns:
      a new HTMLTextBlock instance

    • header

      static HTMLHeader header(String text, int level)
      Creates an HTML header with the specified text and level.
      Parameters:
      text - the text of the header
      level - the level of the header (1 to 7 inclusive, 1 being the highest header and 7 being the lowest header level). Correspond to H1,...,H7 HTML tags.
      Returns:
      a new HTMLHeader instance

    • link

      static HTMLLink link(String text, String url)
      Creates an HTML link with the specified text and URL.
      Parameters:
      text - the text of the link
      url - the URL to link to
      Returns:
      a new HTMLLink instance

    • linkAction

      static HTMLLinkAction linkAction(String text, Runnable action)
      Creates an HTML link that triggers an action when clicked. The action will only be handled correctly when shown in the Browser desktop UI component of the same application.
      Parameters:
      text - the text of the link
      action - the action to perform when the link is clicked
      Returns:
      a new HTMLLinkAction instance

    • linkOpenInBrowser

      static HTMLLinkAction linkOpenInBrowser(String text, String link)
      Creates an HTML link that opens the specified URL in the browser when clicked. This is a convenience method for creating links that navigate to external URLs.
      Parameters:
      text - the display text of the link
      link - the URL to open in the browser when the link is clicked
      Returns:
      a new HTMLLinkAction instance configured to open the URL

    • fragment

      static HTMLFragment fragment(List<HTMLConvertable> children)
      Creates an HTML fragment containing multiple HTML components.
      Parameters:
      children - list of HTML components to include in the fragment
      Returns:
      a new HTMLFragment containing the specified children