cytoflowgui.view_plugins.i_view_plugin

class cytoflowgui.view_plugins.i_view_plugin.IViewPlugin(adaptee, default=<class 'traits.adaptation.adaptation_error.AdaptationError'>)[source]

Bases: traits.has_traits.Interface

id

The envisage ID used to refer to this plugin

Type

Str

view_id

Same as the “id” attribute of the IView this plugin wraps Prefix: edu.mit.synbio.cytoflowgui.view

Type

Str

short_name

The view’s “short” name - for menus, toolbar tips, etc.

Type

Str

get_view()[source]

Gets the IView instance that this plugin wraps.

Returns

An instance of the view that this plugin wraps

Return type

IView

get_handler(model)[source]

Gets an instance of the handler for this view or params model.

NOTE: You have to check to see what the class of model is, and return an appropriate handler!

Parameters
  • model (IWorkflowView) – The model to associate with this handler.

  • context (WorkflowItem) – The WorkflowItem that this model is a part of.

Return type

traitsui.handler.Controller

get_icon()[source]

Returns an icon for this plugin

Returns

The SVG icon

Return type

pyface.i_image_resource.IImageResource

get_help()[source]

Gets the HTML help text for this plugin, deriving the filename from the class name. Probably best to use the default implementation in cytoflowgui.view_plugins.view_plugin_base.PluginHelpMixin

Returns

The HTML help, in a single string.

Return type

string

get_plugin()[source]

Returns an instance of envisage.plugin.Plugin implementing IViewPlugin. Usually returns self.

Return type

envisage.plugin.Plugin

class cytoflowgui.view_plugins.i_view_plugin.ViewPluginManager[source]

Bases: envisage.plugin.Plugin