net.sourceforge.squirrel_sql.plugins.editextras
Class EditExtrasPlugin

java.lang.Object
  net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin
      net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin
          net.sourceforge.squirrel_sql.plugins.editextras.EditExtrasPlugin

All Implemented Interfaces:

IPlugin, ISessionPlugin

public class EditExtrasPlugin
extends DefaultSessionPlugin

The plugin class.

Author:

Gerd Wagner

Field Summary

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

_app, applicationFiles, fileWrapperFactory

Constructor Summary

EditExtrasPlugin()

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.
Object	getExternalService()
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.
PluginResources	getResources() Retrieve plugins resources.
String	getVersion() Returns the current version of this plugin.
void	initialize() Called on application startup after application started.
void	sessionEnding(ISession session) Called when a session shutdown.
PluginSessionCallback	sessionStarted(ISession session) Session has been started.

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

getDefaultNodeExpander, getObjectTypes, getSessionPropertiesPanels, isPluginSession, registerSessionMenu, sessionCreated

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

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

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, getGlobalPreferencePanels, getNewSessionPropertiesPanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, load, setApplicationFiles, setFileWrapperFactory, unload

Constructor Detail

EditExtrasPlugin

public EditExtrasPlugin()

Method Detail

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

Called on application startup after application started.

Specified by:

initialize in interface IPlugin

Overrides:

initialize in class DefaultPlugin

Throws:

PluginException

allowsSessionStartedInBackground

public boolean allowsSessionStartedInBackground()

Specified by:

allowsSessionStartedInBackground in interface ISessionPlugin

Overrides:

allowsSessionStartedInBackground in class DefaultSessionPlugin

sessionStarted

public PluginSessionCallback sessionStarted(ISession session)

Session has been started.

Parameters:

session - Session that has started.

sessionEnding

public void sessionEnding(ISession session)

Called when a session shutdown.

Specified by:

sessionEnding in interface ISessionPlugin

Overrides:

sessionEnding in class DefaultSessionPlugin

Parameters:

session - The session that is ending.

getResources

public PluginResources getResources()

Retrieve plugins resources.

Returns:

Plugins resources.

getExternalService

public Object getExternalService()

Specified by:

getExternalService in interface IPlugin

Overrides:

getExternalService in class DefaultPlugin