Workspace Plugin Interface Methods


boolean openWorkspace(SElement workspaceElement)

This method is invoked when the FlowJo workspace is first opened. The input XML element describes the entire FlowJo workspace, including all samples, groups, gating hierarchy, and statistics. This method returns a boolean value indicating whether the plugin should be added to the workspace for subsequent operations. The invocation of openWorkspace occurs before FlowJo opens the workspace window, enabling your plugin to access and possibly modify the workspace XML before the analysis is visible.


void saveWorkspace(SElement workspaceElement)

This method is invoked every time that the FlowJo workspace is saved. The input XML element describes the entire FlowJo workspace, including all samples, groups, gating hierarchy, and statistics.


void endSession()

This method is called when the user quits the FlowJo application. It provides an opportunity for the plugin to close a database connection, send a notification, or submit logging information.


String getServerUrl()

This method returns a string that uniquely identifies your workspace plugin. It is used by the plugin framework to manage the plugin object for the workspace. The returned string should be a valid URL reference, that can be used to construct a Java URL instance without throwing a MalformedURLException.


SElement getElement()

This method returns an XML element that represents the state of the plugin that should be saved with a FlowJo workspace. If your plugin defines a constructor with a single SElement argument, this same XML is passed into the constructor.


String getVersion()

This method returns a version string for your plugin, that can be used by your plugin code to enforce compatibility or automatically upgrade different versions of your plugin. FlowJo’s plugin framework does not use the returned version string, but will ensure the version string is retained when the plugin node is saved in a FlowJo workspace.

results matching ""

    No results matching ""