public interface DashboardTile
Describes a list of methods needed for dashboard to get tile content DashboardTile.getComponent, and other info like DashboardTile.getId, DashboardTile.getName, DashboardTile.getDescription.
Type Params | Return Type | Name and description |
---|---|---|
|
public void |
addDashboardTileListener(DashboardTileListener listener) |
|
public boolean |
canHandleHistoricData() |
|
public javafx.scene.Node |
getComponent() Returns a JavaFX node containing the GUI of the Dashboard tile. |
|
public DashboardTileConfig |
getConfig() |
|
public DashboardTileListener |
getDashboardTileListener() |
|
public java.lang.String |
getDescription() A concise description of this Dashboard tile. |
|
public java.util.Optional<javafx.scene.image.Image> |
getIcon() Returns a icon of this Dashboard tile, which will be displayed in the tile header. |
|
public java.lang.String |
getId() Gets a unique ID for this Dashboard tile. |
|
public javax.swing.ImageIcon |
getImage() Returns a image of this Dashboard tile, which will be displayed in the Add Tile dialog. |
|
public java.lang.String |
getName() A descriptive name for this Dashboard tile, which will be displayed in the Dashboard page. |
|
public java.util.Optional<javafx.scene.Node> |
getPeriodChooser() |
|
public XmlObject |
getSettingsConfig() |
|
public java.util.Optional<javafx.scene.Node> |
getSettingsContent() Returns a JavaFX node containing the GUI for settings popup window. |
|
public java.util.Optional<javafx.scene.Node> |
getSettingsContent(java.lang.Object source)
|
|
public java.util.Optional<javafx.scene.layout.HBox> |
getTileLeftToolBar() |
|
public DynamicTileType |
getTileType() A type of this Dashboard tile |
|
public void |
initialize() Initialize this tile. |
|
public void |
onLoad(DashboardGui dashboard) Callback invoked just before this tile is added to the Dashboard. |
|
public void |
onUnload() Callback invoked just after this tile is removed from the Dashboard. |
|
public void |
setConfig(DashboardTileConfig config) |
|
public void |
updateDataFromConfig() |
Returns a JavaFX node containing the GUI of the Dashboard tile.
html
, body
tags or an HTML head
.A concise description of this Dashboard tile. If present it may be displayed in the Dashboard page, possibly as a tooltip.
Returns a icon of this Dashboard tile, which will be displayed in the tile header.
Gets a unique ID for this Dashboard tile. It won't be displayed anywhere but used to identify the tile internally.
Returns a image of this Dashboard tile, which will be displayed in the Add Tile dialog.
A descriptive name for this Dashboard tile, which will be displayed in the Dashboard page.
Returns a JavaFX node containing the GUI for settings popup window.
source
- node which has FilterObject in UserData property
Returns a JavaFX node containing the GUI for settings popup window.A type of this Dashboard tile
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.
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.
dashboard
- the Dashboard GUI that the tile is being added toCallback invoked just after this tile is removed from the Dashboard.