org.knopflerfish.service.desktop

Interface SwingBundleDisplayer

public interface SwingBundleDisplayer

Interface for services wishing to become visible as components in the desktop Swing window.

The desktop window can be extended by new components, displaying bundle details. To extend the desktop, create and register an instance of SwingBundleDisplayer.

In fact, all internal views in the desktop bundle are created by such services.

Service properties

All SwingBundleDisplayer should be registered with a set of properties:

• SwingBundleDisplayer.PROP_NAME (String)
  Short name of the displayer. Will typically be used in tab names or menu selections.
• SwingBundleDisplayer.PROP_DESCRIPTION (String)
  Longer description of the displayer. Will typically be used as tooltip text.
• SwingBundleDisplayer.PROP_ISDETAIL (Boolean)
  If Boolean.TRUE, the displayer provides components with high detail level for a single, selected bundles. Detail displayers are typically shown in the right-hand "info" part of the desktop window.
  If this property is not set, or equals Boolean.FALSE, the displayer can handle a view of all installed bundes. These displayers are typically shown in the left-hand "bundle" part of the desktop window.

Additionally, displayers may provide an icon which will be displayed next to the name/description.

The bundle selection is described by an BundleSelectionModel, and displayer should be prepared to display different content depending on which bundles are selected. To modify the selection (and thus update all other registered displayers), use the setSelection and clearSelection methods in the BundleSelectionModel

Desktop usage of Bundle attributes

When the desktop displays bundle information, some bundle attributes are used. The same method should be used by bundle displayers.

Bundle-Activator

The Bundle-Activator is used to select from the built in "application" or "library" icons. If the bundle has a bundle activator set, the application icon is selected, otherwise the library icon.

Application-Icon

If Application-Icon is set to a resource name of an icon, this icon is used insead of the built in application of library icons. The icon is accessed using the bundle://[bundle id] URL scheme.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_DESCRIPTION Service property key.
static java.lang.String	PROP_ISDETAIL Service property key.
static java.lang.String	PROP_NAME Service property key.

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JComponent	createJComponent() Create the actual component that should be displayed.
void	disposeJComponent(javax.swing.JComponent comp) Perform any necessary cleanup operations.
javax.swing.Icon	getLargeIcon() Get a large icon (48x48) for the displayer.
javax.swing.Icon	getSmallIcon() Get a smaller icon (22x22) for the displayer.
void	setBundleSelectionModel(BundleSelectionModel model)
void	setTargetBundleContext(BundleContext bc) Allow access to another bundle context than the displayer's own.
void	showBundle(Bundle b) Attempt to show the specified bundle.

Field Detail

PROP_NAME

static final java.lang.String PROP_NAME

Service property key.

Value is org.knopflerfish.service.desktop.displayer.name

See Also:

Constant Field Values

PROP_DESCRIPTION

static final java.lang.String PROP_DESCRIPTION

Service property key.

Value is org.knopflerfish.service.desktop.displayer.description

See Also:

Constant Field Values

PROP_ISDETAIL

static final java.lang.String PROP_ISDETAIL

Service property key.

Value is org.knopflerfish.service.desktop.displayer.isdetail

See Also:

Constant Field Values

Method Detail

createJComponent

javax.swing.JComponent createJComponent()

Create the actual component that should be displayed.

New components must be created for each createJComponent call.

disposeJComponent

void disposeJComponent(javax.swing.JComponent comp)

Perform any necessary cleanup operations.

Parameters:

comp - Component previously created by createJComponent

setBundleSelectionModel

void setBundleSelectionModel(BundleSelectionModel model)

Parameters:

model - Selection model describing which bundles are selected. The actual bundle list must be managed by the displayer itself.

getLargeIcon

javax.swing.Icon getLargeIcon()

Get a large icon (48x48) for the displayer.

null can be returned if no icon is provided.

getSmallIcon

javax.swing.Icon getSmallIcon()

Get a smaller icon (22x22) for the displayer.

null can be returned if no icon is provided.

setTargetBundleContext

void setTargetBundleContext(BundleContext bc)

Allow access to another bundle context than the displayer's own. This might be used to set a remote bundle context.

This method might never be called - the displayer should in that case use its own context. The normal case is to start with the displayer's own context and later switch to another context.

If setTargetBundleContext is called, the displayer must update all components with this context.

showBundle

void showBundle(Bundle b)

Attempt to show the specified bundle.