org.youscope.plugin.microplatejob

Class MicroplateJobConfigurationAddon

java.lang.Object

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

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

org.youscope.plugin.microplatejob.MicroplateJobConfigurationAddon

All Implemented Interfaces:

AddonUI<ComponentMetadata<MicroplateJobConfiguration>>, ComponentAddonUI<MicroplateJobConfiguration>

public class MicroplateJobConfigurationAddon
extends ComponentAddonUIAdapter<MicroplateJobConfiguration>

Author:

Moritz Lang

Constructor Summary

Constructors

Constructor and Description
MicroplateJobConfigurationAddon(YouScopeClient client, YouScopeServer server) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	commitChanges(MicroplateJobConfiguration configuration) Is called when the current state of all forms etc.
protected java.awt.Component	createUI(MicroplateJobConfiguration configuration) Return a Component (typically a JPanel) containing the UI elements of the addon.
MicroplateJobConfiguration	getConfiguration() Returns the configuration data.
protected void	initializeDefaultConfiguration(MicroplateJobConfiguration configuration) This function is called, and only called, if AddonUIAdapter.toFrame() or AddonUIAdapter.toPanel(YouScopeFrame) is called without calling before ComponentAddonUIAdapter.setConfiguration(Configuration).
void	setConfiguration(Configuration jobConfiguration) Initializes the addon to the configuration data.

Methods inherited from class org.youscope.addon.component.ComponentAddonUIAdapter

addUIListener, closeAddon, createUI, getConfigurationClass, removeUIListener

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

MicroplateJobConfigurationAddon

public MicroplateJobConfigurationAddon(YouScopeClient client,
                                       YouScopeServer server)
                                throws AddonException

Constructor.

Parameters:

client - Interface to the client.

server - Interface to the server.

Throws:

AddonException

Method Detail

createUI

protected java.awt.Component createUI(MicroplateJobConfiguration configuration)
                               throws AddonException

Description copied from class: ComponentAddonUIAdapter

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)).

Specified by:

createUI in class ComponentAddonUIAdapter<MicroplateJobConfiguration>

Parameters:

configuration - The current configuration which should be loaded.

Returns:

Component containing the UI elements of this addon.

Throws:

AddonException

setConfiguration

public void setConfiguration(Configuration jobConfiguration)
                      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<MicroplateJobConfiguration>

Overrides:

setConfiguration in class ComponentAddonUIAdapter<MicroplateJobConfiguration>

Parameters:

jobConfiguration - The configuration data.

Throws:

AddonException - Thrown if error occurred while processing configuration data.

ConfigurationException - Thrown if configuration is invalid.

getConfiguration

public MicroplateJobConfiguration 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<MicroplateJobConfiguration>

Overrides:

getConfiguration in class ComponentAddonUIAdapter<MicroplateJobConfiguration>

Returns:

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

commitChanges

protected void commitChanges(MicroplateJobConfiguration configuration)

Description copied from class: ComponentAddonUIAdapter

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.

Specified by:

commitChanges in class ComponentAddonUIAdapter<MicroplateJobConfiguration>

Parameters:

configuration - The configuration in which changes should be saved.

initializeDefaultConfiguration

protected void initializeDefaultConfiguration(MicroplateJobConfiguration configuration)
                                       throws AddonException

Description copied from class: ComponentAddonUIAdapter

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

Specified by:

initializeDefaultConfiguration in class ComponentAddonUIAdapter<MicroplateJobConfiguration>

Parameters:

configuration - Configuration to set to initial values.

Throws:

AddonException