Package org.opennms.features.vaadin.dashboard.model

Interface DashletFactory

All Known Implementing Classes:

AbstractDashletFactory, AlarmDetailsDashletFactory, AlarmsDashletFactory, BSMDashletFactory, ChartsDashletFactory, GrafanaDashletFactory, ImageDashletFactory, KscDashletFactory, MapDashletFactory, RrdDashletFactory, RtcDashletFactory, SummaryDashletFactory, SurveillanceDashletFactory, TopologyDashletFactory, UndefinedDashletFactory, UrlDashletFactory

public interface DashletFactory

This interface defines the required methods for implementing a factory providing Dashlet instances.

Author:

Christian Pape

Method Summary

Modifier and Type	Method	Description
DashletConfigurationWindow	configurationWindow(DashletSpec dashletSpec)	Returns the window used for configuring a DashletSpec instance.
com.vaadin.ui.Component	getHelpComponent()	Returns the help component for the Dashlet.
String	getName()	Returns the name of the Dashlet instances this factory provides.
Map<String,String>	getRequiredParameters()	Returns the Map with the required parameters and default values.
boolean	isBoostable()	This method returns whether this dashlet is boostable.
boolean	isSuitableForDashboard()	Returns whether this dashlet is suitable for displaying in the dashboard view.
Dashlet	newDashletInstance(DashletSpec dashletSpec)	Returns a new Dashlet instance for a given DashletSpec.
boolean	providesHelpComponent()	Returns true, if the factory provides a help component for the Dashlet.

Method Detail

isSuitableForDashboard

boolean isSuitableForDashboard()

Returns whether this dashlet is suitable for displaying in the dashboard view.

Returns:

true if suitable, false otherwise

newDashletInstance

Dashlet newDashletInstance(DashletSpec dashletSpec)

Returns a new Dashlet instance for a given DashletSpec.

Parameters:

dashletSpec - the DashletSpec to use

Returns:

the new Dashlet instance

getName

String getName()

Returns the name of the Dashlet instances this factory provides.

Returns:

the name

getRequiredParameters

Map<String,String> getRequiredParameters()

Returns the Map with the required parameters and default values.

Returns:

the Map holding the requires parameters

providesHelpComponent

boolean providesHelpComponent()

Returns true, if the factory provides a help component for the Dashlet.

Returns:

true, if help component is provided, false otherwise

getHelpComponent

com.vaadin.ui.Component getHelpComponent()

Returns the help component for the Dashlet.

Returns:

the help component

configurationWindow

DashletConfigurationWindow configurationWindow(DashletSpec dashletSpec)

Returns the window used for configuring a DashletSpec instance.

Parameters:

dashletSpec - the DashletSpec instance

Returns:

the DashletConfigurationWindow

isBoostable

boolean isBoostable()

This method returns whether this dashlet is boostable.