Sweet Home 3D 3.4

com.eteks.sweethome3d.plugin
Class Plugin

java.lang.Object
  extended by 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 subdirectories. This file describes a plug-in with the following keys (all of them are mandatory):


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
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

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.


getUndoableEditSupport

public final javax.swing.undo.UndoableEditSupport getUndoableEditSupport()
Returns the undoable edit support that records undoable modifications made on a home.


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.


Sweet Home 3D 3.4

? Copyrights 2006-2011 eTeks - All rights reserved
Distributed under GNU General Public License