com.servoy.j2db.plugins
Interface IClientPlugin

All Superinterfaces:

EventListener, IPlugin, com.servoy.j2db.persistence.ISupportName, PropertyChangeListener

public interface IClientPlugin
extends IPlugin, PropertyChangeListener, com.servoy.j2db.persistence.ISupportName

Base interface for all client plugins.

Field Summary

Fields inherited from interface com.servoy.j2db.plugins.IPlugin

DISPLAY_NAME

Method Summary

Icon	getImage() Get the plugin image (16x16 px), used in the developer debugger treeview and preference tabpanel.
String	getName() returns the (JavaScript)name for the plugin,name SHOULD apply to the JAVA identifier rules.
PreferencePanel[]	getPreferencePanels() Create panels for the Preferences dialog, lazy called when shown.
IScriptObject	getScriptObject() returns the object which has 'js_xxxx' methods for script calling, or null if not scriptable
void	initialize(IClientPluginAccess app) Called on startup after client application started.

Methods inherited from interface com.servoy.j2db.plugins.IPlugin

getProperties, load, unload

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Method Detail

initialize

void initialize(IClientPluginAccess app)
                throws PluginException

Called on startup after client application started.

Throws:

PluginException

getPreferencePanels

PreferencePanel[] getPreferencePanels()

Create panels for the Preferences dialog, lazy called when shown.

Returns:

Array of PreferencePanel panels. Return empty array or null if this plugin doesn't require any panels in the Preferences Dialog.

getName

String getName()

returns the (JavaScript)name for the plugin,name SHOULD apply to the JAVA identifier rules.

Specified by:

getName in interface com.servoy.j2db.persistence.ISupportName

getImage

Icon getImage()

Get the plugin image (16x16 px), used in the developer debugger treeview and preference tabpanel.

Returns:

ImageIcon (null means not availeble)

getScriptObject

IScriptObject getScriptObject()

returns the object which has 'js_xxxx' methods for script calling, or null if not scriptable