org.youscope.addon.measurement

Class MeasurementAddonUIAdapter<T extends MeasurementConfiguration>

java.lang.Object

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

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

org.youscope.addon.measurement.MeasurementAddonUIAdapter<T>

Type Parameters:

T - The type of measurement configuration which should be displayed by this panel.

All Implemented Interfaces:

AddonUI<ComponentMetadata<T>>, ComponentAddonUI<T>

public class MeasurementAddonUIAdapter<T extends MeasurementConfiguration>
extends ComponentAddonUIAdapter<T>

A panel to display and edit several pages of a measurement configuration.

Author:

Moritz Lang

Constructor Summary

Constructors

Constructor and Description
MeasurementAddonUIAdapter(ComponentMetadata<T> metadata, YouScopeClient client, YouScopeServer server) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addPage(MeasurementAddonUIPage<? super T> page) Adds a page to the layout.
void	clearPages() Removes all pages from the current layout.
protected void	commitChanges(T configuration) Is called when the current state of all forms etc.
protected java.awt.Component	createUI(T configuration) Return a Component (typically a JPanel) containing the UI elements of the addon.
int	getNumPages() Returns the number of pages.
protected void	initializeDefaultConfiguration(T configuration) This function is called, and only called, if AddonUIAdapter.toFrame() or AddonUIAdapter.toPanel(YouScopeFrame) is called without calling before ComponentAddonUIAdapter.setConfiguration(Configuration).
void	insertPage(MeasurementAddonUIPage<? super T> page, int index) Inserts a page into the layout at the given index.

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

MeasurementAddonUIAdapter

public MeasurementAddonUIAdapter(ComponentMetadata<T> 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

addPage

public void addPage(MeasurementAddonUIPage<? super T> page)

Adds a page to the layout. Must be called before AddonUIAdapter.toFrame() or AddonUIAdapter.toPanel(org.youscope.clientinterfaces.YouScopeFrame) is called.

Parameters:

page - Page to be added.

insertPage

public void insertPage(MeasurementAddonUIPage<? super T> page,
                       int index)
                throws java.lang.IndexOutOfBoundsException

Inserts a page into the layout at the given index. Must be called before AddonUIAdapter.toFrame() or AddonUIAdapter.toPanel(org.youscope.clientinterfaces.YouScopeFrame) is called.

Parameters:

page - Page to be added.

index - Index where to add page. Must be bigger or equal to 0, and smaller or equal to getNumPages().

Throws:

java.lang.IndexOutOfBoundsException - thrown if index is invalid.

clearPages

public void clearPages()

Removes all pages from the current layout.

getNumPages

public int getNumPages()

Returns the number of pages.

Returns:

Number of pages.

createUI

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

Parameters:

configuration - The current configuration which should be loaded.

Returns:

Component containing the UI elements of this addon.

Throws:

AddonException

commitChanges

protected void commitChanges(T 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<T extends MeasurementConfiguration>

Parameters:

configuration - The configuration in which changes should be saved.

initializeDefaultConfiguration

protected void initializeDefaultConfiguration(T 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<T extends MeasurementConfiguration>

Parameters:

configuration - Configuration to set to initial values.

Throws:

AddonException