Dashlet (OpenNMS 2022.1.1 API)

All Known Implementing Classes:

AbstractDashlet, AlarmDetailsDashlet, AlarmsDashlet, BSMDashlet, ChartsDashlet, GrafanaDashlet, ImageDashlet, KscDashlet, MapDashlet, RrdDashlet, RtcDashlet, SummaryDashlet, SurveillanceDashlet, TopologyDashlet, UndefinedDashlet, UrlDashlet
```
public interface Dashlet
```
This interface defines the required methods for implementing a dashlet.

Author:

Christian Pape

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`DashletComponent`	`getDashboardComponent(com.vaadin.ui.UI ui)`
`DashletSpec`	`getDashletSpec()`
`String`	`getName()`	This method returns the name of this dashlet.
`DashletComponent`	`getWallboardComponent(com.vaadin.ui.UI ui)`	Updates the dashlet contents and computes new boosted state
`boolean`	`isBoosted()`	Checks whether this dashlet is boosted.

- Method Detail
  - getName
```
String getName()
```
    This method returns the name of this dashlet.
    
    Returns:
    
    the dashlet's name
  - getDashletSpec
```
DashletSpec getDashletSpec()
```
  - isBoosted
```
boolean isBoosted()
```
    Checks whether this dashlet is boosted.
    
    Returns:
    
    true, if boosted, false otherwise
  - getWallboardComponent
```
DashletComponent getWallboardComponent(com.vaadin.ui.UI ui)
```
    Updates the dashlet contents and computes new boosted state
    
    Parameters:
    
    ui - The UI which holds the component.
  - getDashboardComponent
```
DashletComponent getDashboardComponent(com.vaadin.ui.UI ui)
```