org.netbeans.spi.dashboard

Class DashboardDisplayer.WidgetReference

java.lang.Object

org.netbeans.spi.dashboard.DashboardDisplayer.WidgetReference

All Implemented Interfaces:

Lookup.Provider

Enclosing interface:

DashboardDisplayer

public static final class DashboardDisplayer.WidgetReference
extends Object
implements Lookup.Provider

A reference linking a widget to a particular display registration. The lookup from this reference may contain the FileObject from which the reference was created. The ID should be unique per display registration and suitable for directly returning from DashboardDisplayer.Panel.id().

Constructor Summary

Constructors

Constructor and Description
WidgetReference(String id, DashboardWidget widget) Construct a WidgetReference.
WidgetReference(String id, DashboardWidget widget, FileObject registration) Construct a WidgetReference with the provided registration file.

Method Summary

Modifier and Type	Method and Description
Lookup	getLookup()
String	id() Reference ID, usually derived from widget category and filename (eg.
DashboardWidget	widget() The widget instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WidgetReference

public WidgetReference(String id,
                       DashboardWidget widget)

Construct a WidgetReference.

Parameters:

id - widget registration ID

widget - widget instance

WidgetReference

public WidgetReference(String id,
                       DashboardWidget widget,
                       FileObject registration)

Construct a WidgetReference with the provided registration file. The FileObject will be available from the lookup.

Parameters:

id -

widget -

registration -

Method Detail

id

public String id()

Reference ID, usually derived from widget category and filename (eg. Main/Widget1) and suitable for use with DashboardDisplayer.Panel.id().

Returns:

reference ID

widget

public DashboardWidget widget()

The widget instance.

Returns:

widget

getLookup

public Lookup getLookup()

Specified by:

getLookup in interface Lookup.Provider