org.youscope.addon

Class AddonUIAdapter<T extends AddonMetadata>

java.lang.Object

org.youscope.addon.AddonUIAdapter<T>

Type Parameters:

T - Type of metadata returned by addon.

All Implemented Interfaces:

AddonUI<T>

Direct Known Subclasses:

ComponentAddonUIAdapter, ToolAddonUIAdapter

public abstract class AddonUIAdapter<T extends AddonMetadata>
extends java.lang.Object
implements AddonUI<T>

An adapter class to simplify UI addon development.

Author:

Moritz Lang

Constructor Summary

Constructors

Constructor and Description
AddonUIAdapter(T metadata, YouScopeClient client, YouScopeServer server) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addFrameListener(YouScopeFrameListener listener) Adds a listener to the frame in which the UI element is initialized (or, to which the panel belongs) which is informed e.g.
protected void	closeAddon() Call this function to signal that the addon user interface has finished doing what it is supposed to do, and might be closed now.
protected abstract java.awt.Component	createUI() Return a Component (typically a JPanel) containing the UI elements of the addon.
T	getAddonMetadata() Returns the metadata (like human readable name) for the addon.
protected YouScopeClient	getClient() Returns the YouScope client.
protected java.lang.String	getCloseButtonLabel() Returns the label of the commit button which is displayed at the bottom of a frame, when initialized as a frame.
protected YouScopeFrame	getContainingFrame() Returns the frame containing this addon.
protected Microscope	getMicroscope() Returns the microscope.
protected java.awt.Dimension	getPreferredSize() Returns the preferred size of this UI element, or null if size should be calculated automatically.
protected YouScopeServer	getServer() Returns the YouScope server.
protected java.lang.String	getTitle() Returns the title of this UI element.
protected boolean	isInitialized() Returns true if the functions toXXXFrame() or toPanel() was called, that is, if createUI() was called or not.
protected boolean	isMaximizable() Returns if this UI element will be maximizable if initialized as a frame.
protected boolean	isMaximize() Indicates if this UI element should be maximized if it is a frame.
protected boolean	isResizable() Returns if this element should be resizable.
protected boolean	isSeparateFrame()
protected boolean	isShowCloseButton() Returns true if a commit button is automatically added when addon is initialized as a frame.
protected void	notifyLayoutChanged() Call this function if the layout of the addon changed in a way such that the components need resizing.
protected void	removeFrameListener(YouScopeFrameListener listener) Removes a previously added listener.
protected void	sendErrorMessage(java.lang.String message, java.lang.Throwable error) Call this function to notify that an error occurred.
protected void	sendMessage(java.lang.String message) Send a general message meant for information.
protected void	setCloseButtonLabel(java.lang.String commitButtonLabel) Sets the label of the commit button which is displayed at the bottom of a frame, when initialized as a frame.
protected void	setDescription(java.lang.String description) Sets a description for this addon.
protected void	setMaximizable(boolean maximizable) Sets if this UI element will be maximizable if initialized as a frame.
protected void	setMaximize(boolean maximize) Sets if this UI element should be maximized if it is a frame.
protected void	setPreferredSize(java.awt.Dimension preferredSize) Set the preferred size of this UI element.
protected void	setResizable(boolean resizable) Sets if this element should be resizable.
protected void	setShowCloseButton(boolean commitButton) Set to true if a commit button should be automatically added when addon is initialized as a frame.
protected void	setTitle(java.lang.String title) Sets the title of this UI element.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AddonUIAdapter

public AddonUIAdapter(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

setDescription

protected void setDescription(java.lang.String description)

Sets a description for this addon. This description is displayed to the user in form of a tooltip at the top right. Must be called before toFrame() or toPanel(YouScopeFrame).

Parameters:

description - Description of the addon.

notifyLayoutChanged

protected void notifyLayoutChanged()

Call this function if the layout of the addon changed in a way such that the components need resizing.

toFrame

public YouScopeFrame toFrame()
                      throws AddonException

Description copied from interface: AddonUI

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.

Specified by:

toFrame in interface AddonUI<T extends AddonMetadata>

Returns:

The frame containing the UI elements of the addon.

Throws:

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

toPanel

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

Description copied from interface: AddonUI

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.

Specified by:

toPanel in interface AddonUI<T extends AddonMetadata>

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.

createUI

protected abstract java.awt.Component createUI()
                                        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 or close button, but rather change the label of the button which is automatically added (see setShowCloseButton(boolean) and setCloseButtonLabel(String)).

Returns:

Component containing the UI elements of this addon.

Throws:

AddonException

isMaximize

protected boolean isMaximize()

Indicates if this UI element should be maximized if it is a frame.

Returns:

true if should be maximized when frame.

setMaximize

protected void setMaximize(boolean maximize)

Sets if this UI element should be maximized if it is a frame.

Parameters:

maximize - true if should be maximized when frame.

getPreferredSize

protected java.awt.Dimension getPreferredSize()

Returns the preferred size of this UI element, or null if size should be calculated automatically.

Returns:

preferred size, or null.

setPreferredSize

protected void setPreferredSize(java.awt.Dimension preferredSize)

Set the preferred size of this UI element. Set to null, if size should be calculated automatically.

Parameters:

preferredSize - preferred size, or null.

isResizable

protected boolean isResizable()

Returns if this element should be resizable. If initialized as a panel, this implies that the maximal size will be identical to the preferred size. If initialized as a frame, this implies forbidding resizing by the user.

Returns:

true if resizable.

setResizable

protected void setResizable(boolean resizable)

Sets if this element should be resizable. If initialized as a panel, this implies that the maximal size will be identical to the preferred size. If initialized as a frame, this implies forbidding resizing by the user.

Parameters:

resizable - true if resizable.

isMaximizable

protected boolean isMaximizable()

Returns if this UI element will be maximizable if initialized as a frame. Has no effect if initialized as a panel.

Returns:

true if maximizable.

setMaximizable

protected void setMaximizable(boolean maximizable)

Sets if this UI element will be maximizable if initialized as a frame. Has no effect if initialized as a panel.

Parameters:

maximizable - true if maximizable.

getTitle

protected java.lang.String getTitle()

Returns the title of this UI element. If initialized as a frame, then the frame title will be set to the title. If initialized as a panel, a titled border will be drawn around the UI element. If null or empty string, neither will be done.

Returns:

Title, or null if no title is set.

setTitle

protected void setTitle(java.lang.String title)

Sets the title of this UI element. If initialized as a frame, then the frame title will be set to the title. If initialized as a panel, a titled border will be drawn around the UI element. Set to null or empty string to do neither.

addFrameListener

protected void addFrameListener(YouScopeFrameListener listener)

Adds a listener to the frame in which the UI element is initialized (or, to which the panel belongs) which is informed e.g. if the frame is closed.

Parameters:

listener - The listener to add.

removeFrameListener

protected void removeFrameListener(YouScopeFrameListener listener)

Removes a previously added listener.

Parameters:

listener - The listener to remove.

getCloseButtonLabel

protected java.lang.String getCloseButtonLabel()

Returns the label of the commit button which is displayed at the bottom of a frame, when initialized as a frame.

Returns:

Commit button label.

setCloseButtonLabel

protected void setCloseButtonLabel(java.lang.String commitButtonLabel)

Sets the label of the commit button which is displayed at the bottom of a frame, when initialized as a frame. Set to null or empty string to restore default commit button label.

Parameters:

commitButtonLabel - Label of the commit button, or null.

closeAddon

protected void closeAddon()

Call this function to signal that the addon user interface has finished doing what it is supposed to do, and might be closed now. Function is automatically called when pressing the close button. If initialized in a frame, this will close the frame. Only call after UI became visible.

sendErrorMessage

protected void sendErrorMessage(java.lang.String message,
                                java.lang.Throwable error)

Call this function to notify that an error occurred. Only call this function if the error did not occur as a direct response to a function call (in this case, throw a corresponding error to the function caller).

Parameters:

message - A description in which step the error happened.

error - The error which happened.

sendMessage

protected void sendMessage(java.lang.String message)

Send a general message meant for information. Typically, this message is simply logged.

Parameters:

message - The message to send

isInitialized

protected boolean isInitialized()

Returns true if the functions toXXXFrame() or toPanel() was called, that is, if createUI() was called or not.

Returns:

True if addon is initialized.

isSeparateFrame

protected boolean isSeparateFrame()

getContainingFrame

protected YouScopeFrame getContainingFrame()

Returns the frame containing this addon. Either, if toXXXFrame() was called, the newly created frame for this addon, or, if toPanel() was called, the parent frame, i.e. the frame in which this addon (is supposed to) have been visible. Returns null if neither function was called.

Returns:

The frame containing this addon.

isShowCloseButton

protected boolean isShowCloseButton()

Returns true if a commit button is automatically added when addon is initialized as a frame.

Returns:

true if commit button is created.

setShowCloseButton

protected void setShowCloseButton(boolean commitButton)

Set to true if a commit button should be automatically added when addon is initialized as a frame.

Parameters:

commitButton - True if commit button should be created.

getClient

protected YouScopeClient getClient()

Returns the YouScope client.

Returns:

The YouScope client.

getServer

protected YouScopeServer getServer()

Returns the YouScope server.

Returns:

the YouScope server.

getMicroscope

protected Microscope getMicroscope()
                            throws java.rmi.RemoteException

Returns the microscope. Same as getServer().getMicroscope().

Returns:

The microscope.

Throws:

java.rmi.RemoteException

getAddonMetadata

public T getAddonMetadata()

Description copied from interface: AddonUI

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

Specified by:

getAddonMetadata in interface AddonUI<T extends AddonMetadata>

Returns:

Metadata of the addon.