org.youscope.addon.component

Class GenericComponentAddonUI<C extends Configuration>

java.lang.Object

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

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

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

Type Parameters:

C -

All Implemented Interfaces:

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

public class GenericComponentAddonUI<C extends Configuration>
extends ComponentAddonUIAdapter<C>

User interface to configure a measurement component which is automatically created from the component's configuration class.

Author:

Moritz Lang

Constructor Summary

Constructors

Constructor and Description
GenericComponentAddonUI(java.lang.String typeIdentifier, java.lang.Class<C> configurationClass, java.lang.Class<? extends Component> componentInterface, YouScopeClient client, YouScopeServer server) Constructor.

Method Summary

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

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

addUIListener, closeAddon, createUI, getConfiguration, getConfigurationClass, removeUIListener, setConfiguration

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

GenericComponentAddonUI

public GenericComponentAddonUI(java.lang.String typeIdentifier,
                               java.lang.Class<C> configurationClass,
                               java.lang.Class<? extends Component> componentInterface,
                               YouScopeClient client,
                               YouScopeServer server)
                        throws AddonException

Constructor.

Parameters:

client - Interface to the client.

server - Interface to the server.

configurationClass - the class of the configurations which should be configured.

typeIdentifier - The identifier of the configurations which should be configured. Must be the same as returned by configurationClass.getTypeIdentifier().

componentInterface - Interface of the component. Interface should be public.

Throws:

AddonException

Method Detail

createUI

protected java.awt.Component createUI(C 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<C extends Configuration>

Parameters:

configuration - The current configuration which should be loaded.

Returns:

Component containing the UI elements of this addon.

Throws:

AddonException

commitChanges

protected void commitChanges(C 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<C extends Configuration>

Parameters:

configuration - The configuration in which changes should be saved.

initializeDefaultConfiguration

protected void initializeDefaultConfiguration(C 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<C extends Configuration>

Parameters:

configuration - Configuration to set to initial values.

Throws:

AddonException