org.youscope.template.tool

Class TemplateTool

java.lang.Object

org.youscope.addon.AddonUIAdapter<ToolMetadata>

org.youscope.addon.tool.ToolAddonUIAdapter

org.youscope.template.tool.TemplateTool

All Implemented Interfaces:

java.util.EventListener, AddonUI<ToolMetadata>, ToolAddonUI, YouScopeFrameListener

public class TemplateTool
extends ToolAddonUIAdapter
implements YouScopeFrameListener

A template which can be used as a starting point for tool development. A tool defines the user interface which is exposed to the user, as well as anything which should happen when pressing anything in the UI, e.g. to manipulate the state of the microscope, to display an image, and similar. Every tool has to implement ToolAddonUI specifying e.g. different layouts of the UI depending on if the UI is shown in an own frame, or as a sub-element of another user interface. However, implementing this interface directly is typically rather complicated. For most tools it is therefore sufficient to extend the adapter class ToolAddonUIAdapter instead of implementing ToolAddonUI directly. The adapter class takes over most of the boilerplate code being the same for nearly all tools, such that one can concentrate on the "real functionality" of the tool. However, it is still possible to implement ToolAddonUI directly if the tool has to do something different then most other tools...

Author:

Moritz Lang

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_IDENTIFIER The type identifier is a unique ID of your tool.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.awt.Component	createUI() Return a Component (typically a JPanel) containing the UI elements of the addon.
void	frameClosed() Activated when the frame is closing.
void	frameOpened() Activated when frame is opened/displayed.
static ToolMetadata	getMetadata() Returns the metadata of this tool.

Methods inherited from class org.youscope.addon.AddonUIAdapter

addFrameListener, closeAddon, 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.AddonUI

getAddonMetadata, toFrame, toPanel

Field Detail

TYPE_IDENTIFIER

public static final java.lang.String TYPE_IDENTIFIER

The type identifier is a unique ID of your tool. No other tool or other element of YouScope should have the same type identifier as your tool, thus, change this identifier to something unique. The general notation is your_identifier DOT tool_identifier, in which your_identifier is e.g. SmithAnton, MyCompanyName, or LonleyProgrammer1972. tool_identifer is the name of your tool, e.g. FancyFocus, MySpecialDeviceController, or HelloWorldTool.

See Also:

Constant Field Values

Constructor Detail

TemplateTool

public TemplateTool(YouScopeClient client,
                    YouScopeServer server)
             throws AddonException

Constructor. Provides the adapter class ToolAddonUIAdapter with all necessary information to provide the standard functionality which has to be exposed by every tool, such that we can concentrate on the fundamentals. Do not initialize the UI elements here (do this in createUI()).

Parameters:

client - Interface to the YouScope client, e.g. allowing to open or close new windows, or permanently save settings.

server - Interface to the YouScope server, e.g. allowing access to the microscope.

Throws:

AddonException

Method Detail

getMetadata

public static ToolMetadata getMetadata()

Returns the metadata of this tool. The metadata consists of a unique identifier for the tool, a human readable name of the tool, an array of names of folders under which the tool should be displayed in YouScope (could be empty to display it as a default tool), and similar. To not have to implement all functions of the interface ToolMetadata ourselves, we return an instance of the adapter class ToolMetadataAdapter, which does most of the boilerplate code for us.

Returns:

Metadata of tool.

createUI

public java.awt.Component createUI()

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<ToolMetadata>

Returns:

Component containing the UI elements of this addon.

frameClosed

public void frameClosed()

Description copied from interface: YouScopeFrameListener

Activated when the frame is closing.

Specified by:

frameClosed in interface YouScopeFrameListener

frameOpened

public void frameOpened()

Description copied from interface: YouScopeFrameListener

Activated when frame is opened/displayed.

Specified by:

frameOpened in interface YouScopeFrameListener