net.sourceforge.squirrel_sql.plugins.laf
Class LAFPlugin

java.lang.Object
  net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin
      net.sourceforge.squirrel_sql.plugins.laf.LAFPlugin

All Implemented Interfaces:

IPlugin

public class LAFPlugin
extends DefaultPlugin

The Look and Feel plugin class.

Author:

Colin Bell

Field Summary

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

_app, applicationFiles, fileWrapperFactory

Constructor Summary

LAFPlugin()

Method Summary

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.
IGlobalPreferencesPanel[]	getGlobalPreferencePanels() Create Look and Feel preferences panels for the Global Preferences dialog.
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.
XMLObjectCache<LAFPreferences>	getSettingsCache()
String	getVersion() Returns the current version of this plugin.
void	load(IApplication app) Load this plugin.
void	unload() Application is shutting down so save preferences.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LAFPlugin

public LAFPlugin()

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.

load

public void load(IApplication app)
          throws PluginException

Load this plugin.

Specified by:

load in interface IPlugin

Overrides:

load in class DefaultPlugin

Parameters:

app - Application API.

Throws:

PluginException

unload

public void unload()

Application is shutting down so save preferences.

Specified by:

unload in interface IPlugin

Overrides:

unload in class DefaultPlugin

getGlobalPreferencePanels

public IGlobalPreferencesPanel[] getGlobalPreferencePanels()

Create Look and Feel preferences panels for the Global Preferences dialog.

Specified by:

getGlobalPreferencePanels in interface IPlugin

Overrides:

getGlobalPreferencePanels in class DefaultPlugin

Returns:

Look and Feel preferences panels.

getSettingsCache

public XMLObjectCache<LAFPreferences> getSettingsCache()