Method Detail

• public void addDashboardTileListener(DashboardTileListener listener)

• public boolean canHandleHistoricData()

• public org.w3c.dom.Node getComponent()

  Returns a JavaFX node containing the GUI of the Dashboard tile.

  Returns:

  the HTML required to render the tile, without enclosing html, body tags or an HTML head.

• public DashboardTileConfig getConfig()

• public DashboardTileListener getDashboardTileListener()

• public java.lang.String getDescription()

  A concise description of this Dashboard tile. If present it may be displayed in the Dashboard page, possibly as a tooltip.

  Returns:

  a concise, plain text description of this Dashboard tile.

• public java.util.Optional<Image> getIcon()

  Returns a icon of this Dashboard tile, which will be displayed in the tile header.

  Returns:

  a icon of this Dashboard tile.

• public java.lang.String getId()

  Gets a unique ID for this Dashboard tile. It won't be displayed anywhere but used to identify the tile internally.

  Returns:

  a truly unique string, preferably a UUID.

• public java.awt.Image getImage()

  Returns a image of this Dashboard tile, which will be displayed in the Add Tile dialog.

  Returns:

  a image of this Dashboard tile.

• public java.lang.String getName()

  A descriptive name for this Dashboard tile, which will be displayed in the Dashboard page.

  Returns:

  a short and descriptive name for this Dashboard tile.

• public java.util.Optional<groovy.util.Node> getPeriodChooser()

• public XmlObject getSettingsConfig()

• public java.util.Optional<groovy.util.Node> getSettingsContent()

  Returns a JavaFX node containing the GUI for settings popup window.

• public java.util.Optional<groovy.util.Node> getSettingsContent(java.lang.Object source)

  Parameters:

  source - node which has FilterObject in UserData property Returns a JavaFX node containing the GUI for settings popup window.

• public java.util.Optional<HBox> getTileLeftToolBar()

• public DynamicTileType getTileType()

• public void initialize()

  Initialize this tile. The method will be called when ReadyAPI starts up. It should return as quickly as possible to avoid adding to the load time of the Dashboard; really time-consuming tasks should be run in the background and then let the GUI update itself after a refresh.

• public void onLoad(DashboardGui dashboard)

  Callback invoked just before this tile is added to the Dashboard. One reason to override it would be to save a reference to the GUI so that the tile can display content in the "Overlay" of the Dashboard.

  throws:

  Exception

  Parameters:

  dashboard - the Dashboard GUI that the tile is being added to

• public void onUnload()

  Callback invoked just after this tile is removed from the Dashboard.

  throws:

  Exception

• public void setConfig(DashboardTileConfig config)

• public void updateDataFromConfig()