org.youscope.addon

Interface AddonUI<T extends AddonMetadata>

Type Parameters:

T - Type of addon metadata.

All Known Subinterfaces:

ComponentAddonUI<C>, DropletControllerConfigurationAddon<C>, ToolAddonUI

All Known Implementing Classes:

AddonUIAdapter, CellDetectionJobAddonUI, ComponentAddonUIAdapter, ControllerJobConfigurationAddon, FluigentJobConfigurationAddon, GenericComponentAddonUI, MeasurementAddonUIAdapter, MicroplateJobConfigurationAddon, TemplateTool, ToolAddonUIAdapter

public interface AddonUI<T extends AddonMetadata>

Provides the user interface of an addon.

Author:

Moritz Lang.

Method Summary

Modifier and Type	Method and Description
T	getAddonMetadata() Returns the metadata (like human readable name) for the addon.
YouScopeFrame	toFrame() Creates a frame containing the UI elements of this addon.
java.awt.Component	toPanel(YouScopeFrame containingFrame) Creates a UI component (usually a panel) containing the UI elements of this addon.

Method Detail

toFrame

YouScopeFrame toFrame()
               throws AddonException

Creates a frame containing the UI elements of this addon. The returned frame should, yet, not be visible (YouScopeFrame.setVisible(true) should be called by the invoker of this function). A new frame can be created by calling YouScopeClient.createFrame(). The caller can decide to add this frame as a child or modal child frame to the frame the caller elements are displayed in by calling on its frame addChildFrame() or addModalChildFrame(). Only one of the functions toFrame() or toPanel() must be called for a given addon. Furthermore, this function must not be called more than once. To create more than one UI representation of a given addon, create a second addon UI using the corresponding factory.

Returns:

The frame containing the UI elements of the addon.

Throws:

AddonException - thrown if an error occurs during construction of the UI.

toPanel

java.awt.Component toPanel(YouScopeFrame containingFrame)
                    throws AddonException

Creates a UI component (usually a panel) containing the UI elements of this addon. The tool should not close the containing frame, nor provide UI elements (e.g. buttons) closing the frame when invoked. Only one of the functions toFrame() or toPanel() must be called for a given tool. Furthermore, this function must not be called more than once. To create more than one UI representation of a given addon, create a second addon UI using the corresponding factory.

Parameters:

containingFrame - The frame containing the UI elements. Note that this frame is not necessarily visible when this function is invoked. The reference to the containing frame can e.g. be used to register frame listeners to get notified when the containing frame opens or closes.

Returns:

The AWT component containing the UI elements of the addon.

Throws:

AddonException - thrown if an error occurs during creation of the addon UI.

getAddonMetadata

T getAddonMetadata()

Returns the metadata (like human readable name) for the addon.

Returns:

Metadata of the addon.