|
Sweet Home 3D 3.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.eteks.sweethome3d.plugin.Plugin
public abstract class Plugin
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 subdirectories.
This file describes a plug-in with the following keys (all of them are mandatory):
name
key specifies the name of the plug-in.class
key specifies the fully qualified class name
of the plug-in.description
key specifies the description of
the plug-in.version
key specifies the version of the plug-in.
license
key specifies the license under which
the plug-in is distributed.provider
key specifies the provider, the developer
and/or the editor of the plug-in.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.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.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
Constructor Summary | |
---|---|
Plugin()
|
Method Summary | |
---|---|
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. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Plugin()
Method Detail |
---|
public final java.lang.ClassLoader getPluginClassLoader()
public final java.lang.String getName()
public final java.lang.String getDescription()
public final java.lang.String getVersion()
public final java.lang.String getLicense()
public java.lang.String getProvider()
public final UserPreferences getUserPreferences()
public final Home getHome()
public final javax.swing.undo.UndoableEditSupport getUndoableEditSupport()
public void destroy()
public abstract PluginAction[] getActions()
PluginAction.Property
enumeration.
|
Sweet Home 3D 3.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
![]() |
? Copyrights 2006-2011 eTeks - All rights reserved
Distributed under GNU General Public License |