net.sf.jaxodraw.plugin

Interface JaxoPlugin

All Superinterfaces:

JaxoLocalized

All Known Implementing Classes:

AbstractJaxoPlugin, JaxoExport, JaxoExportImg, JaxoExportLatex, JaxoExportLatexPS, JaxoExportPlugin, JaxoExportPS, JaxoImport, JaxoImportAxodraw, JaxoImportPlugin

public interface JaxoPlugin
extends JaxoLocalized

A plugin for JaxoDraw.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
java.lang.String	description() Return a short description (preferably internationalized) of what this plugin does.
java.lang.String	getShortName() Return a short name for this plugin.
void	loadProperties() Each plugin should be able to load a set of properties from some default location.
boolean	makeAvailableAtRuntime() Checks some eventual runtime requirements for the plugin.
java.lang.String	pluginId() This must return the class name of the plugin (MyPlugin.class.getName()).
java.lang.String	pluginName() Return the name of this plugin.
java.lang.String	version() Return the version number of this plugin.

Methods inherited from interface net.sf.jaxodraw.util.JaxoLocalized

updateLanguage

Method Detail

pluginId

java.lang.String pluginId()

This must return the class name of the plugin (MyPlugin.class.getName()). It is used to uniquely identify the plugin.

Returns:

the class name of the plugins' main class.

getShortName

java.lang.String getShortName()

Return a short name for this plugin. This is used to construct names of output files, eg to get a "jaxodraw-pdf-plugin.properties" file, the short name should just be "pdf".

Returns:

The short name of this plugin.

pluginName

java.lang.String pluginName()

Return the name of this plugin. This is the name that will be presented in the JaxoDraw user interface. For standard plugins the name should be of the form "jaxodraw-" + getShortName() + "-plugin", but it can be anything else.

Returns:

the name of this plugin.

description

java.lang.String description()

Return a short description (preferably internationalized) of what this plugin does.

Returns:

a description.

version

java.lang.String version()

Return the version number of this plugin. This should be a String in the format used by JaxoDraw as specified in JaxoInfo.compareVersions.

Returns:

the version.

makeAvailableAtRuntime

boolean makeAvailableAtRuntime()

Checks some eventual runtime requirements for the plugin.

Returns:

True if this plugin can be used at runtime.

loadProperties

void loadProperties()

Each plugin should be able to load a set of properties from some default location. The default JaxoDraw property files are stored in the plugins cache directory and named like "jaxodraw-getShortName()-plugin.properties".