org.youscope.addon.component

Class ComponentAddonUIAdapter<C extends Configuration>

java.lang.Object

org.youscope.addon.AddonUIAdapter<ComponentMetadata<C>>

org.youscope.addon.component.ComponentAddonUIAdapter<C>

Type Parameters:

C -

All Implemented Interfaces:

AddonUI<ComponentMetadata<C>>, ComponentAddonUI<C>

Direct Known Subclasses:

CellDetectionJobAddonUI, ControllerJobConfigurationAddon, FluigentJobConfigurationAddon, GenericComponentAddonUI, MeasurementAddonUIAdapter, MicroplateJobConfigurationAddon

public abstract class ComponentAddonUIAdapter<C extends Configuration>
extends AddonUIAdapter<ComponentMetadata<C>>
implements ComponentAddonUI<C>

An adapter class to simplify UI addon development.

Author:

mlang

Constructor Summary

Constructors

Constructor and Description
ComponentAddonUIAdapter(ComponentMetadata<C> metadata, YouScopeClient client, YouScopeServer server) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addUIListener(ComponentAddonUIListener<? super C> listener) Adds a listener to this configuration, which should e.g.
protected void	closeAddon() Call this function to signal that configuration in the UI has finished.
protected abstract void	commitChanges(C configuration) Is called when the current state of all forms etc.
protected java.awt.Component	createUI() Return a Component (typically a JPanel) containing the UI elements of the addon.
protected abstract java.awt.Component	createUI(C configuration) Return a Component (typically a JPanel) containing the UI elements of the addon.
C	getConfiguration() Returns the configuration data.
protected java.lang.Class<C>	getConfigurationClass() Returns the configuration class.
protected abstract void	initializeDefaultConfiguration(C configuration) This function is called, and only called, if AddonUIAdapter.toFrame() or AddonUIAdapter.toPanel(YouScopeFrame) is called without calling before setConfiguration(Configuration).
void	removeUIListener(ComponentAddonUIListener<? super C> listener) Removes a previously added listener.
void	setConfiguration(Configuration configuration) Initializes the addon to the configuration data.

Methods inherited from class org.youscope.addon.AddonUIAdapter

addFrameListener, getAddonMetadata, getClient, getCloseButtonLabel, getContainingFrame, getMicroscope, getPreferredSize, getServer, getTitle, isInitialized, isMaximizable, isMaximize, isResizable, isSeparateFrame, isShowCloseButton, notifyLayoutChanged, removeFrameListener, sendErrorMessage, sendMessage, setCloseButtonLabel, setDescription, setMaximizable, setMaximize, setPreferredSize, setResizable, setShowCloseButton, setTitle, toFrame, toPanel

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.youscope.addon.component.ComponentAddonUI

getAddonMetadata

Methods inherited from interface org.youscope.addon.AddonUI

toFrame, toPanel

Constructor Detail

ComponentAddonUIAdapter

public ComponentAddonUIAdapter(ComponentMetadata<C> metadata,
                               YouScopeClient client,
                               YouScopeServer server)
                        throws AddonException

Constructor.

Parameters:

metadata - The metadata of the addon.

client - The YouScope client.

server - The YouScope server.

Throws:

AddonException

Method Detail

getConfigurationClass

protected java.lang.Class<C> getConfigurationClass()

Returns the configuration class.

Returns:

Configuration class.

addUIListener

public void addUIListener(ComponentAddonUIListener<? super C> listener)

Description copied from interface: ComponentAddonUI

Adds a listener to this configuration, which should e.g. be informed if the configuration finished.

Specified by:

addUIListener in interface ComponentAddonUI<C extends Configuration>

Parameters:

listener - The listener to add.

removeUIListener

public void removeUIListener(ComponentAddonUIListener<? super C> listener)

Description copied from interface: ComponentAddonUI

Removes a previously added listener.

Specified by:

removeUIListener in interface ComponentAddonUI<C extends Configuration>

Parameters:

listener - The listener to remove.

createUI

protected final java.awt.Component createUI()
                                     throws AddonException

Description copied from class: AddonUIAdapter

Return a Component (typically a JPanel) containing the UI elements of the addon. These elements will be automatically layouted to fit into a frame or a panel, depending on what is requested. Do not add any confirm or close button, but rather change the label of the button which is automatically added (see AddonUIAdapter.setShowCloseButton(boolean) and AddonUIAdapter.setCloseButtonLabel(String)).

Specified by:

createUI in class AddonUIAdapter<ComponentMetadata<C extends Configuration>>

Returns:

Component containing the UI elements of this addon.

Throws:

AddonException

initializeDefaultConfiguration

protected abstract void initializeDefaultConfiguration(C configuration)
                                                throws AddonException

This function is called, and only called, if AddonUIAdapter.toFrame() or AddonUIAdapter.toPanel(YouScopeFrame) is called without calling before setConfiguration(Configuration). The configuration should then be initialized to its default settings, which may depend on the state of the microscope, etc.

Parameters:

configuration - Configuration to set to initial values.

Throws:

AddonException

createUI

protected abstract java.awt.Component createUI(C configuration)
                                        throws AddonException

Return a Component (typically a JPanel) containing the UI elements of the addon. These elements will be automatically layouted to fit into a frame or a panel, depending on what is requested. Do not add any confirm button, but rather change the label of the button which is automatically added (AddonUIAdapter.setShowCloseButton(boolean)).

Parameters:

configuration - The current configuration which should be loaded.

Returns:

Component containing the UI elements of this addon.

Throws:

AddonException

closeAddon

protected void closeAddon()

Call this function to signal that configuration in the UI has finished. Function is automatically called when pressing commit button. If initialized in a frame, this will close the frame. Only call after UI became visible.

Overrides:

closeAddon in class AddonUIAdapter<ComponentMetadata<C extends Configuration>>

setConfiguration

public void setConfiguration(Configuration configuration)
                      throws AddonException,
                             ConfigurationException

Description copied from interface: ComponentAddonUI

Initializes the addon to the configuration data. Must not be called after toXXXFrame() or toPanel() was called.

Specified by:

setConfiguration in interface ComponentAddonUI<C extends Configuration>

Parameters:

configuration - The configuration data.

Throws:

AddonException - Thrown if error occurred while processing configuration data.

ConfigurationException - Thrown if configuration is invalid.

commitChanges

protected abstract void commitChanges(C configuration)

Is called when the current state of all forms etc. should be saved into the configuration. Guaranteed to be called only after createUI() has been called.

Parameters:

configuration - The configuration in which changes should be saved.

getConfiguration

public C getConfiguration()

Description copied from interface: ComponentAddonUI

Returns the configuration data. If toXXXFrame() or toPanel() was called already, it is expected that the addon commits all current edits to the configuration. Otherwise, a default configuration should be returned. If possible, the configuration should be at a valid state, which is however not necessary (see Configuration.checkConfiguration()).

Specified by:

getConfiguration in interface ComponentAddonUI<C extends Configuration>

Returns:

Configuration data or NULL, if addon was not yet configured.