net.sourceforge.squirrel_sql.plugins.syntax
Class SyntaxPlugin

java.lang.Object
  net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin
      net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin
          net.sourceforge.squirrel_sql.plugins.syntax.SyntaxPlugin

All Implemented Interfaces:

IPlugin, ISessionPlugin

public class SyntaxPlugin
extends DefaultSessionPlugin

The Ostermiller plugin class. This plugin adds syntax highlighting to the SQL entry area.

Author:

Colin Bell

Field Summary

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

_app

Constructor Summary

SyntaxPlugin()

Method Summary

String	getAuthor() Returns the authors name.
AutoCorrectProviderImpl	getAutoCorrectProviderImpl()
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.
INewSessionPropertiesPanel[]	getNewSessionPropertiesPanels() Create preferences panel for the New Session Properties dialog.
ISessionPropertiesPanel[]	getSessionPropertiesPanels(ISession session) Create panels for the Session Properties dialog.
String	getVersion() Returns the current version of this plugin.
void	initialize() Initialize this plugin.
void	sessionCreated(ISession session) Called when a session created but the UI hasn't been built for the session.
void	sessionEnding(ISession session) Called when a session shutdown.
PluginSessionCallback	sessionStarted(ISession session)
void	unload() Application is shutting down so save preferences.

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

allowsSessionStartedInBackground, getDefaultNodeExpander, getObjectTypes, isPluginSession, registerSessionMenu

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

aliasCopied, aliasRemoved, getAliasPropertiesPanelControllers, getApplication, getContributors, getGlobalPreferencePanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, load

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, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, load

Constructor Detail

SyntaxPlugin

public SyntaxPlugin()

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

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

Specified by:

unload in interface IPlugin

Overrides:

unload in class DefaultPlugin

sessionCreated

public void sessionCreated(ISession session)

Called when a session created but the UI hasn't been built for the session.

Specified by:

sessionCreated in interface ISessionPlugin

Overrides:

sessionCreated in class DefaultSessionPlugin

Parameters:

session - The session that is starting.

sessionStarted

public PluginSessionCallback sessionStarted(ISession session)

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.

getNewSessionPropertiesPanels

public INewSessionPropertiesPanel[] getNewSessionPropertiesPanels()

Create preferences panel for the New Session Properties dialog.

Specified by:

getNewSessionPropertiesPanels in interface IPlugin

Overrides:

getNewSessionPropertiesPanels in class DefaultPlugin

Returns:

preferences panel.

getSessionPropertiesPanels

public ISessionPropertiesPanel[] getSessionPropertiesPanels(ISession session)

Create panels for the Session Properties dialog.

Specified by:

getSessionPropertiesPanels in interface ISessionPlugin

Overrides:

getSessionPropertiesPanels in class DefaultSessionPlugin

Returns:

Array of panels for the properties dialog.

getExternalService

public Object getExternalService()

Specified by:

getExternalService in interface IPlugin

Overrides:

getExternalService in class DefaultPlugin

getAutoCorrectProviderImpl

public AutoCorrectProviderImpl getAutoCorrectProviderImpl()