net.sourceforge.squirrel_sql.plugins.userscript
Class UserScriptPlugin

java.lang.Object
  net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin
      net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin
          net.sourceforge.squirrel_sql.plugins.userscript.UserScriptPlugin

All Implemented Interfaces:

IPlugin, ISessionPlugin

public class UserScriptPlugin
extends DefaultSessionPlugin

The SQL Script plugin class.

Field Summary

Fields inherited from class net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin

_app, applicationFiles, fileWrapperFactory

Constructor Summary

UserScriptPlugin()

Method Summary

boolean	allowsSessionStartedInBackground()
String	getAuthor() Returns the authors name.
String	getChangeLogFileName() Returns the name of the change log for the plugin.
String	getDescriptiveName() Return the descriptive name of this plugin.
String	getHelpFileName() Returns the name of the Help file for the plugin.
String	getInternalName() Return the internal name of this plugin.
String	getLicenceFileName() Returns the name of the Licence file for the plugin.
UserScriptAdmin	getUserScriptAdmin(ISession session)
URLClassLoader	getUserScriptClassLoader()
String	getVersion() Returns the current version of this plugin.
void	initialize() Initialize this plugin.
PluginSessionCallback	sessionStarted(ISession session) Called when a session started.
void	setResourcesFactory(IPluginResourcesFactory resourcesFactory)
void	setUserScriptClassLoader(URLClassLoader urlClassLoader)
void	unload() Application is shutting down so save data.

Methods inherited from class net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin

getDefaultNodeExpander, getObjectTypes, getSessionPropertiesPanels, isPluginSession, registerSessionMenu, sessionCreated, sessionEnding

Methods inherited from class net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin

aliasCopied, aliasRemoved, getAliasPropertiesPanelControllers, getApplication, getContributors, getExternalService, getGlobalPreferencePanels, getNewSessionPropertiesPanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, load, setApplicationFiles, setFileWrapperFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.squirrel_sql.client.plugin.IPlugin

aliasCopied, aliasRemoved, getAliasPropertiesPanelControllers, getContributors, getExternalService, getGlobalPreferencePanels, getNewSessionPropertiesPanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, load, setApplicationFiles, setFileWrapperFactory

Constructor Detail

UserScriptPlugin

public UserScriptPlugin()

Method Detail

setResourcesFactory

public void setResourcesFactory(IPluginResourcesFactory resourcesFactory)

Parameters:

resourcesFactory - the resourcesFactory to set

getInternalName

public String getInternalName()

Return the internal name of this plugin.

Returns:

the internal name of this plugin.

getDescriptiveName

public String getDescriptiveName()

Return the descriptive name of this plugin.

Returns:

the descriptive name of this plugin.

getVersion

public String getVersion()

Returns the current version of this plugin.

Returns:

the current version of this plugin.

getAuthor

public String getAuthor()

Returns the authors name.

Returns:

the authors name.

getChangeLogFileName

public String getChangeLogFileName()

Returns the name of the change log for the plugin. This should be a text or HTML file residing in the getPluginAppSettingsFolder directory.

Specified by:

getChangeLogFileName in interface IPlugin

Overrides:

getChangeLogFileName in class DefaultPlugin

Returns:

the changelog file name or null if plugin doesn't have a change log.

getHelpFileName

public String getHelpFileName()

Returns the name of the Help file for the plugin. This should be a text or HTML file residing in the getPluginAppSettingsFolder directory.

Specified by:

getHelpFileName in interface IPlugin

Overrides:

getHelpFileName in class DefaultPlugin

Returns:

the Help file name or null if plugin doesn't have a help file.

getLicenceFileName

public String getLicenceFileName()

Returns the name of the Licence file for the plugin. This should be a text or HTML file residing in the getPluginAppSettingsFolder directory.

Specified by:

getLicenceFileName in interface IPlugin

Overrides:

getLicenceFileName in class DefaultPlugin

Returns:

the Licence file name or null if plugin doesn't have a licence file.

initialize

public void initialize()
                throws PluginException

Initialize this plugin.

Specified by:

initialize in interface IPlugin

Overrides:

initialize in class DefaultPlugin

Throws:

PluginException

unload

public void unload()

Application is shutting down so save data.

Specified by:

unload in interface IPlugin

Overrides:

unload in class DefaultPlugin

allowsSessionStartedInBackground

public boolean allowsSessionStartedInBackground()

Specified by:

allowsSessionStartedInBackground in interface ISessionPlugin

Overrides:

allowsSessionStartedInBackground in class DefaultSessionPlugin

sessionStarted

public PluginSessionCallback sessionStarted(ISession session)

Called when a session started. Add commands to popup menu in object tree.

Parameters:

session - The session that is starting.

Returns:

true to indicate that this plugin is applicable to passed session.

getUserScriptAdmin

public UserScriptAdmin getUserScriptAdmin(ISession session)

getUserScriptClassLoader

public URLClassLoader getUserScriptClassLoader()

setUserScriptClassLoader

public void setUserScriptClassLoader(URLClassLoader urlClassLoader)