org.netbeans.spi.dashboard

Interface DashboardDisplayer.Panel

All Superinterfaces:

Lookup.Provider

Enclosing interface:

DashboardDisplayer

public static interface DashboardDisplayer.Panel
extends Lookup.Provider

A panel implementation provides the link between a dashboard displayer and each display of a widget. Any widget may be shown multiple times on a dashboard, and potentially on multiple dashboards at the same time. The ID here is unique to each display instance and might be used to store configuration data across executions. A widget may use the panel to trigger a refresh if the rendered elements have changed.

The lookup provided by the panel will usually be the same as, or an extension of, the dashboard displayer lookup. It might be used to provide contextual dashboards for a particular context. If the widget needs access to the context in which the widget was registered (eg. the shadow file in Dashboard/Main) then it should use the lookup from the DashboardDisplayer.Panel.widgetReference().

Method Summary

Modifier and Type	Method and Description
String	id() The unique id reference for this display of this widget.
void	refresh() Mark this widget rendering as invalid.
DashboardDisplayer.WidgetReference	widgetReference() Access the widget reference for this panel.

Methods inherited from interface org.openide.util.Lookup.Provider

getLookup

Method Detail

widgetReference

DashboardDisplayer.WidgetReference widgetReference()

Access the widget reference for this panel. The lookup of the widget reference may contain the context of how this display of the widget is registered (eg. the FileObject).

Returns:

widget reference

id

String id()

The unique id reference for this display of this widget. Will usually reference the dashboard category and reference file name (eg. Main/Widget1.

Returns:

refresh

void refresh()

Mark this widget rendering as invalid. The displayer will re-request the title and element list from the widget. This method returns immediately - the displayer will re-request and re-render the widget asynchronously.