net.sourceforge.squirrel_sql.plugins.smarttools
Class SmarttoolsPlugin

java.lang.Object
  net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin
      net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin
          net.sourceforge.squirrel_sql.plugins.smarttools.SmarttoolsPlugin

All Implemented Interfaces:

IPlugin, ISessionPlugin

public class SmarttoolsPlugin
extends DefaultSessionPlugin

Plugin start class for smarttools

Author:

Michael Romankiewicz

Field Summary

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

_app, applicationFiles, fileWrapperFactory

Constructor Summary

SmarttoolsPlugin()

Method Summary

String	getAuthor()
String	getChangeLogFileName() Returns the name of the change log for the plugin.
String	getDescriptiveName()
String	getHelpFileName() Returns the name of the Help file for the plugin.
String	getInternalName()
String	getLicenceFileName()
String	getVersion()
void	initialize() Initialize this plugin.
void	sessionEnding(ISession session)
PluginSessionCallback	sessionStarted(ISession session) Called when a session started.
void	unload()

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

allowsSessionStartedInBackground, getDefaultNodeExpander, getObjectTypes, getSessionPropertiesPanels, isPluginSession, registerSessionMenu, sessionCreated

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

SmarttoolsPlugin

public SmarttoolsPlugin()

Method Detail

getAuthor

public String getAuthor()

getDescriptiveName

public String getDescriptiveName()

getInternalName

public String getInternalName()

getVersion

public String getVersion()

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.

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.

getLicenceFileName

public String getLicenceFileName()

Specified by:

getLicenceFileName in interface IPlugin

Overrides:

getLicenceFileName in class DefaultPlugin

See Also:

IPlugin.getLicenceFileName()

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

Specified by:

unload in interface IPlugin

Overrides:

unload in class DefaultPlugin

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:

An implementation of PluginSessionCallback or null to indicate the plugin does not work with this session

sessionEnding

public void sessionEnding(ISession session)

Specified by:

sessionEnding in interface ISessionPlugin

Overrides:

sessionEnding in class DefaultSessionPlugin