jsynoptic.plugins.async
Class AsyncPlugin

java.lang.Object
  jsynoptic.base.Plugin
      jsynoptic.plugins.async.AsyncPlugin

public class AsyncPlugin
extends Plugin

A plugin to enable TimePlot shape dedidated to asynchonous data sources

Author:

Claude Cazenave

Field Summary

static MenuResourceBundle	resources
static java.lang.String	TIME_PLOT

Fields inherited from class jsynoptic.base.Plugin

EXPORT, IMPORT, OPEN, SAVE

Constructor Summary

AsyncPlugin()

Method Summary

java.lang.String	about() Enter your plugin information here.
AbstractShape	createShape(java.lang.String name, DiagramComponent diagram) The plugin is asked to create a new shape for one of the name it provided with getShapes().
static AbstractShape	createTimePlot(DiagramComponent diagram)
java.lang.Object[][]	getDataSourceIcons() Source factory: this plugin may bring its own data sources with its own icons to display them in the source panel
java.lang.String[]	getShapes() Shape factory: this plugin may bring its own shapes to put in the shape list.
java.util.HashMap	getShapesMap() Get a map that links the plugin shapes classes with the corresponding shapes names.
Template[]	getTemplates() Template factory: this plugin may bring templates to put in the template list.

Methods inherited from class jsynoptic.base.Plugin

addPluginHashMap, createSource, exit, getFileFilters, getHelp, getOptionPanelForFilter, getShapeName, getSources, load, newComponent, newDesktopComponent, newSourceComponent, newSourceComponent, processDataSourceCollection, processFile, processSynoptic, setMenu, setMenu, setToolBarItem

Methods inherited from class java.lang.Object

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

Field Detail

resources

public static MenuResourceBundle resources

TIME_PLOT

public static final java.lang.String TIME_PLOT

Constructor Detail

AsyncPlugin

public AsyncPlugin()

Method Detail

about

public java.lang.String about()

Enter your plugin information here. This will appear in the about box. Warning : uses HTML... @see jsynoptic.base.Plugin#about()

Overrides:

about in class Plugin

Returns:

the information about this plugin, including authors, license, etc..

createTimePlot

public static AbstractShape createTimePlot(DiagramComponent diagram)

getDataSourceIcons

public java.lang.Object[][] getDataSourceIcons()

Description copied from class: Plugin

Source factory: this plugin may bring its own data sources with its own icons to display them in the source panel

Overrides:

getDataSourceIcons in class Plugin

Returns:

An array or null if no specific icons. Each row contains in the first column the data source class and the second column contains the icon to display it.

getTemplates

public Template[] getTemplates()

Description copied from class: Plugin

Template factory: this plugin may bring templates to put in the template list.

Overrides:

getTemplates in class Plugin

Returns:

An array of templates, or null if this plugin does not provide any template.

getShapes

public java.lang.String[] getShapes()

Description copied from class: Plugin

Shape factory: this plugin may bring its own shapes to put in the shape list. It will then be asked to create a new shape when requested. As an example, the plot is a basic shape provided with JSynoptic.

Overrides:

getShapes in class Plugin

Returns:

An array of shape names, or null if this plugin does not provide any shape.

getShapesMap

public java.util.HashMap getShapesMap()

Description copied from class: Plugin

Get a map that links the plugin shapes classes with the corresponding shapes names.

Overrides:

getShapesMap in class Plugin

Returns:

the hash map if the plugin is able to create shapes, or null if this plugin does not provide any shape.

createShape

public AbstractShape createShape(java.lang.String name,
                                 DiagramComponent diagram)

Description copied from class: Plugin

The plugin is asked to create a new shape for one of the name it provided with getShapes(). Note that the newly created shape will be inserted in a diagram set up with an ActionPopup popup menu. Thus, it may implement JSynoptic ContextualActionProvider interface to interact with the user.

Overrides:

createShape in class Plugin

Parameters:

name - The name of the shape to create.

diagram - The diagram this shape will be inserted into.