Java Doc for IPlugin.java in » Database-Client » squirrel-sql-2.6.5a » net » sourceforge » squirrel_sql » client » plugin » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Database Client » squirrel sql 2.6.5a » net.sourceforge.squirrel_sql.client.plugin

Source Cross Reference Class Diagram Java Document (Java Doc)

net.sourceforge.squirrel_sql.client.plugin .IPlugin

All known Subclasses:   net.sourceforge.squirrel_sql.plugins.sqlscript.prefs .DummyPlugin,  net.sourceforge.squirrel_sql.client.plugin .DefaultPlugin,  net.sourceforge.squirrel_sql.plugins.dbcopy.gui .DummyPlugin,  net.sourceforge.squirrel_sql.client.plugin .MockPlugin,  net.sourceforge.squirrel_sql.plugins.mssql.gui .DummyPlugin,  net.sourceforge.squirrel_sql.plugins.oracle.gui .DummyPlugin,
IPlugin
public interface IPlugin (Code)
Base interface for all plugins.
Plugins for specific DBMSs may need to create and register DataType handlers for non-standard data types defined by that DBMS. Instructions on this can be found in fw/src/net/sourceforge/squirrel_sql/fw/datasetviewer/cellcomponent/CellComponentFactory.java.

Method Summary
void aliasCopied(SQLAlias source, SQLAlias target)
     Called when an Alias is copied.
void aliasRemoved(SQLAlias alias)
     Called when an Alias is removed.
IAliasPropertiesPanelController[] getAliasPropertiesPanelControllers(SQLAlias alias)
     Creates Alias Prefs Controllers for this Plugin.
String getAuthor()
     Returns the authors name.
String getChangeLogFileName()
     Returns the name of the change log for the plugin.
String getContributors()
     Returns a comma separated list of other contributors.
String getDescriptiveName()
     Returns the descriptive name for this plugin.
Object getExternalService()
     Allows a plugin to provide services to other plugins.
IGlobalPreferencesPanel[] getGlobalPreferencePanels()
     Create panels for the Global Preferences dialog. Array of IGlobalPreferencesPanel objects.
String getHelpFileName()
     Returns the name of the Help file for the plugin.
String getInternalName()
     Returns the name by which this plugin is uniquely identified.
String getLicenceFileName()
     Returns the name of the licence file for the plugin.
INewSessionPropertiesPanel[] getNewSessionPropertiesPanels()
     Create panels for the New Session Properties dialog. Array of INewSessionPropertiesPanel objects.
File getPluginAppSettingsFolder()
     Return the folder with the Squirrel application folder that belongs to this plugin.
File getPluginUserSettingsFolder()
     Return the folder with the users home directory that belongs to this plugin.
String getVersion()
     Returns the current version of this plugin.
String getWebSite()
     Returns the home page for this plugin.
void initialize()
     Called on application startup after application started.
void load(IApplication app)
     Called on application startup before application started up.
void unload()
     Called when app shutdown.

Method Detail
aliasCopied
void aliasCopied(SQLAlias source, SQLAlias target)(Code)
Called when an Alias is copied. Should be overridden by Plugins that work with Alias properties.

aliasRemoved
void aliasRemoved(SQLAlias alias)(Code)
Called when an Alias is removed. Should be overridden by Plugins that work with Alias properties.

getAliasPropertiesPanelControllers
IAliasPropertiesPanelController[] getAliasPropertiesPanelControllers(SQLAlias alias)(Code)
Creates Alias Prefs Controllers for this Plugin.

getAuthor
String getAuthor()(Code)
Returns the authors name. the authors name.

getChangeLogFileName
String getChangeLogFileName()(Code)
Returns the name of the change log for the plugin. This should be a text or HTML file residing in the getPluginAppSettingsFolder directory. the changelog file name or null if plugin doesn't havea change log.

getContributors
String getContributors()(Code)
Returns a comma separated list of other contributors. Contributors names.

getDescriptiveName
String getDescriptiveName()(Code)
Returns the descriptive name for this plugin. the descriptive name for this plugin.

getExternalService
Object getExternalService()(Code)
Allows a plugin to provide services to other plugins.
See Also:    PluginManager.bindExternalPluginService();

getGlobalPreferencePanels
IGlobalPreferencesPanel[] getGlobalPreferencePanels()(Code)
Create panels for the Global Preferences dialog. Array of IGlobalPreferencesPanel objects. Returnempty array of null if this plugin doesn't requireany panels in the Global Preferences Dialog.

getHelpFileName
String getHelpFileName()(Code)
Returns the name of the Help file for the plugin. This should be a text or HTML file residing in the getPluginAppSettingsFolder directory. the Help file name or null if plugin doesn't havea help file.

getInternalName
String getInternalName()(Code)
Returns the name by which this plugin is uniquely identified. the name by which this plugin is uniquely identified.

getLicenceFileName
String getLicenceFileName()(Code)
Returns the name of the licence file for the plugin. This should be a text or HTML file residing in the getPluginAppSettingsFolder directory. the licence file name or null if plugin doesn't havea change log.

getNewSessionPropertiesPanels
INewSessionPropertiesPanel[] getNewSessionPropertiesPanels()(Code)
Create panels for the New Session Properties dialog. Array of INewSessionPropertiesPanel objects. Returnempty array of null if this plugin doesn't requireany panels in the New Session Properties Dialog.

getPluginAppSettingsFolder
File getPluginAppSettingsFolder() throws IOException, IllegalStateException(Code)
Return the folder with the Squirrel application folder that belongs to this plugin. If it doesn't exist then create it. This would normally be
<squirrel_app>/plugins/<plugin_internal_name>
Plugins application folder.
throws:
  IllegalStateException - if plugin doesn't have an internal name.
throws:
  IOException - An error occured retrieving/creating the folder.

getPluginUserSettingsFolder
File getPluginUserSettingsFolder() throws IllegalStateException, IOException(Code)
Return the folder with the users home directory that belongs to this plugin. If it doesn't exist then create it. This would normally be
<user_home>/.squirrel-sql/plugins/<plugin_internal_name>
Plugins user folder.
throws:
  IllegalStateException - if plugin doesn't have an internal name.
throws:
  IOException - An error occured retrieving/creating the folder.

getVersion
String getVersion()(Code)
Returns the current version of this plugin. the current version of this plugin.

getWebSite
String getWebSite()(Code)
Returns the home page for this plugin. the home page for this plugin.

initialize
void initialize() throws PluginException(Code)
Called on application startup after application started.

load
void load(IApplication app) throws PluginException(Code)
Called on application startup before application started up.
Parameters:
  app - Application API.

unload
void unload()(Code)
Called when app shutdown. TODO: Put throws clause back in

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.