com.eteks.sweethome3d.plugin

Class Plugin

java.lang.Object

com.eteks.sweethome3d.plugin.Plugin

public abstract class Plugin
extends java.lang.Object

The super class of a plug-in. Subclasses should implement getActions method to return the actions that will be available to user. This class should be packed in a JAR file with a family of properties file named ApplicationPlugin.properties at its root or in one of its subfolders. This file describes a plug-in with the following keys (all of them are mandatory except id):

• The id key gives an optional id to the plug-in, which can be useful to determine if an update for this plug-in is available during libraries updates checking.
• The name key specifies the name of the plug-in.
• The class key specifies the fully qualified class name of the plug-in.
• The description key specifies the description of the plug-in.
• The version key specifies the version of the plug-in.
• The license key specifies the license under which the plug-in is distributed.
• The provider key specifies the provider, the developer and/or the editor of the plug-in.
• The applicationMinimumVersion key specifies the minimum application version under which this plug-in may work. Note that only the first two groups of digits will be used for the comparison with current JVM version, and that plug-ins were available from version 1.5.
• The javaMinimumVersion key specifies the minimum Java version under which this plug-in may work. Note that only the first two groups of digits will be used for the comparison with current JVM version.

For example, a plug-in class named com.mycompany.mypackage.MyPlugin will become a plug-in if it's packed in a JAR file with the following ApplicationPlugin.properties file:

 name=My plug-in
 class=com.mycompany.mypackage.MyPlugin
 description=This plug-in rocks!
 version=1.0
 license=GNU GPL
 provider=MyCompany
 applicationMinimumVersion=1.5
 javaMinimumVersion=1.5

Author:

Emmanuel Puybaret

Constructor Summary

Constructors

Constructor and Description
Plugin()

Method Summary

Modifier and Type	Method and Description
void	destroy() This method will be called when the home referenced by this plug-in will be deleted.
abstract PluginAction[]	getActions() Returns the actions available on this plug-in.
java.lang.String	getDescription() Returns the description of this plug-in.
Home	getHome() Returns the home associated to this plug-in instance.
HomeController	getHomeController() Returns the controller of the home of this plug-in.
java.lang.String	getLicense() Returns the license of this plug-in.
java.lang.String	getName() Returns the name of this plug-in.
java.lang.ClassLoader	getPluginClassLoader() Returns the class loader used to load this plug-in.
java.lang.String	getProvider() Returns the provider of this plug-in.
javax.swing.undo.UndoableEditSupport	getUndoableEditSupport() Returns the undoable edit support that records undoable modifications made on a home.
UserPreferences	getUserPreferences() Returns the user preferences of the current application.
java.lang.String	getVersion() Returns the version of this plug-in.
void	init() This method will be called once the properties of this plug-in are initialized.

Methods inherited from class java.lang.Object

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

Constructor Detail

Plugin

public Plugin()

Method Detail

getPluginClassLoader

public final java.lang.ClassLoader getPluginClassLoader()

Returns the class loader used to load this plug-in.

getName

public final java.lang.String getName()

Returns the name of this plug-in.

getDescription

public final java.lang.String getDescription()

Returns the description of this plug-in.

getVersion

public final java.lang.String getVersion()

Returns the version of this plug-in.

getLicense

public final java.lang.String getLicense()

Returns the license of this plug-in.

getProvider

public java.lang.String getProvider()

Returns the provider of this plug-in.

getUserPreferences

public final UserPreferences getUserPreferences()

Returns the user preferences of the current application.

getHome

public final Home getHome()

Returns the home associated to this plug-in instance.

getHomeController

public HomeController getHomeController()

Returns the controller of the home of this plug-in.

Since:

3.5

getUndoableEditSupport

public final javax.swing.undo.UndoableEditSupport getUndoableEditSupport()

Returns the undoable edit support that records undoable modifications made on a home.

init

public void init()

This method will be called once the properties of this plug-in are initialized. Subclasses may override it to initialize data associated to this plug-in.

Since:

6.0

destroy

public void destroy()

This method will be called when the home referenced by this plug-in will be deleted. Subclasses may override it to free resources associated to this plug-in.

getActions

public abstract PluginAction[] getActions()

Returns the actions available on this plug-in. These actions may define the properties defined by PluginAction.Property enumeration.